# `nym-cli` Binary Commands (Autogenerated) These docs are autogenerated by the [`autodocs`](https://github.com/nymtech/nym/tree/max/new-docs-framework/documentation/autodoc) script. ```sh A client for interacting with Nym smart contracts and the Nyx blockchain Usage: nym-cli [OPTIONS] Commands: account Query and manage Nyx blockchain accounts signature Sign and verify messages ecash Ecash related stuff block Query chain blocks cosmwasm Manage and execute WASM smart contracts tx Query for transactions vesting-schedule Create and query for a vesting schedule mixnet Manage your mixnet infrastructure, delegate stake or query the directory generate-fig Generates shell completion help Print this message or the help of the given subcommand(s) Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `account` ```sh Query and manage Nyx blockchain accounts Usage: nym-cli account [OPTIONS] nym-cli account Commands: create Create a new mnemonic - note, this account does not appear on the chain until the account id is used in a transaction balance Gets the balance of an account pub-key Gets the public key of an account send Sends tokens to another account send-multiple Batch multiple token sends help Print this message or the help of the given subcommand(s) Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `account create` ```sh Create a new mnemonic - note, this account does not appear on the chain until the account id is used in a transaction Usage: nym-cli account create [OPTIONS] Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. --word-count -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `account balance` ```sh Gets the balance of an account Usage: nym-cli account balance [OPTIONS] [ADDRESS] Arguments: [ADDRESS] The account address to get the balance for Options: --denom Optional currency to show balance for --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --hide-denom Optionally hide the denom --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --raw Show as a raw value --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `account pub-key` ```sh Gets the public key of an account Usage: nym-cli account pub-key [OPTIONS] [ADDRESS] Arguments: [ADDRESS] Optionally, show the public key for this account address, otherwise generate the account address from the mnemonic Options: --from-mnemonic If set, get the public key from the mnemonic, rather than querying for it --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `account send` ```sh Sends tokens to another account Usage: nym-cli account send [OPTIONS] Arguments: The recipient account address Amount to transfer in micro denomination (e.g. unym or unyx) Options: --denom Override the denomination --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --memo --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `account send-multiple` ```sh Batch multiple token sends Usage: nym-cli account send-multiple [OPTIONS] --input Options: --memo --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --input Input file path (CSV format) with account/amount pairs to send --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --output An output file path (CSV format) to create or append a log of results to --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `signature` ```sh Sign and verify messages Usage: nym-cli signature [OPTIONS] nym-cli signature Commands: sign Sign a message verify Verify a message help Print this message or the help of the given subcommand(s) Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `signature sign` ```sh Sign a message Usage: nym-cli signature sign [OPTIONS] Arguments: The message to sign Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `signature verify` ```sh Verify a message Usage: nym-cli signature verify [OPTIONS] Arguments: The public key of the account, or the account id to query for a public key (NOTE: the account must have signed a message stored on the chain for the public key record to exist) The signature to verify as hex The message to verify as a string Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `ecash` ```sh Ecash related stuff Usage: nym-cli ecash [OPTIONS] nym-cli ecash Commands: issue-ticket-book recover-ticket-book import-ticket-book generate-ticket import-coin-index-signatures import-expiration-date-signatures import-master-verification-key help Print this message or the help of the given subcommand(s) Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `ecash issue-ticket-book` ```sh Usage: nym-cli ecash issue-ticket-book [OPTIONS] <--client-config |--output-file > Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. --ticketbook-type Specify which type of ticketbook should be issued [default: v1-mixnet-entry] -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --client-config Config file of the client that is supposed to use the credential --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --output-file Output file for the ticketbook --bs58-output Specifies whether the output file should use binary or bs58 encoded data --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --include-expiration-date-signatures Specifies whether the file output should contain expiration date signatures --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --include-coin-index-signatures Specifies whether the file output should contain coin index signatures --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file --include-master-verification-key Specifies whether the file output should contain master verification key --bs58-encoded-client-secret Secret value that's used for deriving underlying ecash keypair -h, --help Print help ``` ## `ecash recover-ticket-book` ```sh Usage: nym-cli ecash recover-ticket-book [OPTIONS] --client-config Options: --client-config Config file of the client that is supposed to use the credential --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `ecash import-ticket-book` ```sh Usage: nym-cli ecash import-ticket-book [OPTIONS] --credentials-store <--credential-data |--credential-path > <--standalone|--full> Options: --credentials-store Config file of the client that is supposed to use the credential --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --credential-data Explicitly provide the encoded credential data (as base58) --credential-path Specifies the path to file containing binary credential data --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --standalone Specifies whether we're attempting to import a standalone ticketbook (i.e. serialised `IssuedTicketBook`) --full Specifies whether we're attempting to import full ticketboot (i.e. one that **might** contain required global signatures; that is serialised `ImportableTicketBook`) --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `coconut` ## `coconut generate-freepass` ## `coconut issue-credentials` ## `coconut recover-credentials` ## `coconut import-credential` ## `block` ```sh Query chain blocks Usage: nym-cli block [OPTIONS] nym-cli block Commands: get Gets a block's details and prints as JSON time Gets the block time at a height current-height Gets the current block height help Print this message or the help of the given subcommand(s) Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `block get` ```sh Gets a block's details and prints as JSON Usage: nym-cli block get [OPTIONS] Arguments: The block height Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `block time` ```sh Gets the block time at a height Usage: nym-cli block time [OPTIONS] Arguments: The block height Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `block current-height` ```sh Gets the current block height Usage: nym-cli block current-height [OPTIONS] Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `cosmwasm` ```sh Manage and execute WASM smart contracts Usage: nym-cli cosmwasm [OPTIONS] nym-cli cosmwasm Commands: upload Upload a smart contract WASM blob init Init a WASM smart contract generate-init-message Generate an instantiate message migrate Migrate a WASM smart contract execute Execute a WASM smart contract method raw-contract-state Obtain raw contract state of a cosmwasm smart contract help Print this message or the help of the given subcommand(s) Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `cosmwasm upload` ```sh Upload a smart contract WASM blob Usage: nym-cli cosmwasm upload [OPTIONS] --wasm-path Options: --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. --wasm-path -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --memo --nyxd-url Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file --nym-api-url Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file --mixnet-contract-address Overrides the mixnet contract address provided either as an environment variable or in a config file --vesting-contract-address Overrides the vesting contract address provided either as an environment variable or in a config file -h, --help Print help ``` ## `cosmwasm init` ```sh Init a WASM smart contract Usage: nym-cli cosmwasm init [OPTIONS] --init-message Arguments: Options: --memo --mnemonic Provide the mnemonic for your account. You can also provide this is an env var called MNEMONIC. -c, --config-env-file Overrides configuration as a file of environment variables. Note: individual env vars take precedence over this file. --label