# 1. HMY CLI Download {% hint style="warning" %} Make sure **NOT** to run the Node Setup with the`root` user. We recommend creating a new user called `harmony` for the Node Setup and giving it root level access. {% endhint %} {% hint style="info" %} Throughout this guide, we will use the following syntax: * `./hmy`: This is the CLI program * `./hmy.sh --` : This is the command to use the CLI with a shell wrapper (for macOS) * ``: This is a required argument * `[argument]`: This is an optional argument * `/` : This is a line break, used to break up a line while writing a command {% endhint %} ## Download Harmony CLI tool ### 1. For Linux ```bash curl -LO https://harmony.one/hmycli && mv hmycli hmy && chmod +x hmy ``` ### 2. For MacOS ```bash curl -O https://raw.githubusercontent.com/harmony-one/go-sdk/master/scripts/hmy.sh chmod u+x hmy.sh ./hmy.sh -d ``` Now you can use `hmy.sh` as a wrapper over `hmy` and you should assume that all references to `hmy` in these documents refer to `hmy.sh`. For example, the command `./hmy` becomes `./hmy.sh --` . {% hint style="warning" %} Note that since `hmy` is not statically linked, you cannot arbitrarily move `hmy.sh` to anywhere on your filesystem like you could with a single binary. {% endhint %} On Linux, calling the `cookbook` would look like this: ```bash ./hmy --node="https://api.s0.t.hmny.io" cookbook ``` And on MacOS would look like: ```bash ./hmy.sh -- --node="https://api.s0.t.hmny.io" cookbook ``` ## Output ```bash #Cookbook of Usage #Note: #1) Every subcommand recognizes a '--help' flag #2) If a passphrase is used by a subcommand, one can enter their own passphrase interactively # with the --passphrase option. Alternatively, one can pass their own passphrase via a file # using the --passphrase-file option. If no passphrase option is selected, the default # passphrase of '' is used. #3) These examples use Shard 0 of Open Staking Network as argument for --node #Examples: #1. Check account balance on given chain ./hmy --node="https://api.s0.t.hmny.io" balances #2. Check sent transaction ./hmy --node="https://api.s0.t.hmny.io" blockchain transaction-by-hash #3. List local account keys ./hmy keys list #4. Sending a transaction (waits 40 seconds for transaction confirmation) ./hmy --node="https://api.s0.t.hmny.io" transfer \ --from --to \ --from-shard 0 --to-shard 1 --amount 200 --passphrase #5. Sending a batch of transactions as dictated from a file (the `--dry-run` options still apply) ./hmy --node="https://api.s0.t.hmny.io" transfer --file #Check README for details on json file format. #6. Check a completed transaction receipt ./hmy --node="https://api.s0.t.hmny.io" blockchain transaction-receipt #7. Import an account using the mnemonic. Prompts the user to give the mnemonic. ./hmy keys recover-from-mnemonic #8. Import an existing keystore file ./hmy keys import-ks #9. Import a keystore file using a secp256k1 private key ./hmy keys import-private-key #10. Export a keystore file's secp256k1 private key ./hmy keys export-private-key --passphrase #11. Generate a BLS key then encrypt and save the private key to the specified location. ./hmy keys generate-bls-key --bls-file-path #12. Create a new validator with a list of BLS keys ./hmy --node="https://api.s0.t.hmny.io" staking create-validator --amount 10 --validator-addr \ --bls-pubkeys ,, \ --identity foo --details bar --name baz --max-change-rate 0.1 --max-rate 0.1 --max-total-delegation 10 \ --min-self-delegation 10 --rate 0.1 --security-contact Leo --website harmony.one --passphrase #13. Edit an existing validator ./hmy --node="https://api.s0.t.hmny.io" staking edit-validator \ --validator-addr --identity foo --details bar \ --name baz --security-contact EK --website harmony.one \ --min-self-delegation 0 --max-total-delegation 10 --rate 0.1\ --add-bls-key --remove-bls-key --passphrase #14. Delegate an amount to a validator ./hmy --node="https://api.s0.t.hmny.io" staking delegate \ --delegator-addr --validator-addr \ --amount 10 --passphrase #15. Undelegate to a validator ./hmy --node="https://api.s0.t.hmny.io" staking undelegate \ --delegator-addr --validator-addr \ --amount 10 --passphrase #16. Collect block rewards as a delegator ./hmy --node="https://api.s0.t.hmny.io" staking collect-rewards \ --delegator-addr --passphrase #17. Check elected validators ./hmy --node="https://api.s0.t.hmny.io" blockchain validator elected #18. Get current staking utility metrics ./hmy --node="https://api.s0.t.hmny.io" blockchain utility-metrics #19. Check in-memory record of failed staking transactions ./hmy --node="https://api.s0.t.hmny.io" failures staking #20. Check which shard your BLS public key would be assigned to as a validator ./hmy --node="https://api.s0.t.hmny.io" utility shard-for-bls 2d61379e44a772e5757e27ee2b3874254f56073e6bd226eb8b160371cc3c18b8c4977bd3dcb71fd57dc62bf0e143fd08 ``` ## Troubleshooting Frequently encountered errors: ```bash ./hmy cookbook -bash: ./hmy: cannot execute binary file: Exec format error ​#Make sure you downloaded the right version for your OS. ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.harmony.one/home/network/validators/node-setup/hmy-cli-download.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.