Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Usage:
- tezos-client [global options] command [command options]
- tezos-client --help (for global options)
- tezos-client [global options] command --help (for command options)
- To browse the documentation:
- tezos-client [global options] man (for a list of commands)
- tezos-client [global options] man -v 3 (for the full manual)
- Global options (must come before the command):
- -d --base-dir <path>: client data directory
- -c --config-file <path>: configuration file
- -t --timings: show RPC request times
- -b --block <hash|tag>: block on which to apply contextual commands
- -w --wait <none|<int>>: how many confirmation blocks before to consider an operation as included
- -p --protocol <hash>: use commands of a specific protocol
- -l --log-requests: log all requests to the node
- -A --addr <IP addr|host>: IP address of the node
- -P --port <number>: RPC port of the node
- -S --tls: use TLS to connect to node.
- -R --remote-signer <uri>: URI of the remote signer
- Access the documentation:
- man [<keyword>...] [-v --verbosity <0|1|2|3>]
- [--format <plain|colors|html>]
- Print documentation of commands.
- <keyword>: keyword to search for
- -v --verbosity <0|1|2|3>: level of details
- --format <plain|colors|html>: the manual's output format
- Binary Description:
- describe unsigned block header
- Describe unsigned block header
- describe unsigned operation
- Describe unsigned block header
- Block contextual commands (see option -block):
- get timestamp [-s --seconds]
- Access the timestamp of the block.
- -s --seconds: output time in seconds
- list contracts
- Lists all non empty contracts of the block.
- get balance for <src>
- Get the balance of a contract.
- <src>: source contract
- get script storage for <src>
- Get the storage of a contract.
- <src>: source contract
- get script code for <src>
- Get the storage of a contract.
- <src>: source contract
- get manager for <src>
- Get the manager of a contract.
- <src>: source contract
- get delegate for <src>
- Get the delegate of a contract.
- <src>: source contract
- set delegate for <src> to <mgr> [--fee <amount>] [-D --dry-run]
- Set the delegate of a contract.
- <src>: source contract
- <mgr>: new delegate of the contract
- --fee <amount>: fee in ꜩ to pay to the baker
- -D --dry-run: don't inject the operation, just display it
- withdraw delegate from <src> [--fee <amount>] [-D --dry-run]
- Withdraw the delegate from a contract.
- <src>: source contract
- --fee <amount>: fee in ꜩ to pay to the baker
- -D --dry-run: don't inject the operation, just display it
- originate account <new> for <mgr> transferring <qty> from <src> [--fee <amount>]
- [-D --dry-run] [--delegate <address>] [--delegatable] [-f --force]
- Open a new account.
- <new>: name of the new contract
- <mgr>: manager of the new contract
- <qty>: amount taken from source in ꜩ
- <src>: name of the source contract
- --fee <amount>: fee in ꜩ to pay to the baker
- -D --dry-run: don't inject the operation, just display it
- --delegate <address>: delegate of the contract
- --delegatable: allow future delegate change
- -f --force: overwrite existing keys
- originate contract <new> for <mgr> transferring <qty> from <src> running <prg> [--fee <amount>]
- [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>]
- [--delegate <address>] [-f --force] [--delegatable] [--spendable]
- [--init <data>] [-q --no-print-source]
- Launch a smart contract on the blockchain.
- <new>: name of the new contract
- <mgr>: manager of the new contract
- <qty>: amount taken from source in ꜩ
- <src>: name of the source contract
- <prg>: script of the account
- --fee <amount>: fee in ꜩ to pay to the baker
- -D --dry-run: don't inject the operation, just display it
- -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
- -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
- --delegate <address>: delegate of the contract
- -f --force: overwrite existing keys
- --delegatable: allow future delegate change
- --spendable: allow the manager to spend the contract's tokens
- --init <data>: initial value of the contract's storage
- -q --no-print-source: don't print the source code
- transfer <qty> from <src> to <dst> [--fee <amount>] [-D --dry-run]
- [-G --gas-limit <amount>] [-S --storage-limit <amount>] [--arg <data>]
- [-q --no-print-source]
- Transfer tokens / call a smart contract.
- <qty>: amount taken from source in ꜩ
- <src>: name of the source contract
- <dst>: name/literal of the destination contract
- --fee <amount>: fee in ꜩ to pay to the baker
- -D --dry-run: don't inject the operation, just display it
- -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
- -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
- --arg <data>: argument passed to the contract's script, if needed
- -q --no-print-source: don't print the source code
- reveal key for <src> [--fee <amount>]
- Reveal the public key of the contract manager.
- <src>: name of the source contract
- --fee <amount>: fee in ꜩ to pay to the baker
- register key <mgr> as delegate [--fee <amount>] [-D --dry-run]
- Register the public key hash as a delegate.
- <mgr>: the delegate key
- --fee <amount>: fee in ꜩ to pay to the baker
- -D --dry-run: don't inject the operation, just display it
- activate fundraiser account <name> with <code> [-D --dry-run]
- Activate a fundraiser account.
- <name>: existing public key hash alias
- <code>: Activation code obtained from the Tezos foundation.
- -D --dry-run: don't inject the operation, just display it
- Commands for managing the record of known contracts:
- remember contract <new> <src> [-f --force]
- Add a contract to the wallet.
- <new>: new contract alias
- <src>: source contract
- -f --force: overwrite existing contract
- forget contract <name>
- Remove a contract from the wallet.
- <name>: existing contract alias
- list known contracts
- Lists all known contracts in the wallet.
- forget all contracts [-f --force]
- Forget the entire wallet of known contracts.
- -f --force: overwrite existing contract
- show known contract <name>
- Display a contract from the wallet.
- <name>: existing contract alias
- Commands for managing the library of known scripts:
- list known scripts
- Lists all scripts in the library.
- remember script <new> <src> [-f --force]
- Add a script to the library.
- <new>: new script alias
- <src>: source script
- -f --force: overwrite existing script
- forget script <name>
- Remove a script from the library.
- <name>: existing script alias
- show known script <name>
- Display a script from the library.
- <name>: existing script alias
- run script <src> on storage <storage> and input <storage> [--trace-stack]
- [--amount <amount>] [-q --no-print-source]
- Ask the node to run a script.
- <src>: source script
- <storage>: the storage data
- <storage>: the input data
- --trace-stack: show the stack after each step
- --amount <amount>: amount of the transfer in ꜩ
- -q --no-print-source: don't print the source code
- typecheck script <src> [-v --details] [--emacs] [-q --no-print-source]
- [-G --gas <gas>]
- Ask the node to typecheck a script.
- <src>: source script
- -v --details: show the types of each instruction
- --emacs: output in `michelson-mode.el` compatible format
- -q --no-print-source: don't print the source code
- -G --gas <gas>: Initial quantity of gas for typechecking and execution
- typecheck data <data> against type <type> [-q --no-print-source]
- [-G --gas <gas>]
- Ask the node to typecheck a data expression.
- <data>: the data to typecheck
- <type>: the expected type
- -q --no-print-source: don't print the source code
- -G --gas <gas>: Initial quantity of gas for typechecking and execution
- hash data <data> of type <type> [-G --gas <gas>]
- Ask the node to pack a data expression.
- <data>: the data to hash
- <type>: type of the data
- -G --gas <gas>: Initial quantity of gas for typechecking and execution
- sign bytes <data> for <src>
- Sign a raw sequence of bytes and display it using the format expected by Michelson instruction `CHECK_SIGNATURE`.
- <data>: the raw data to sign
- <src>: source secret_key
- check that <bytes> was signed by <key> to produce <signature> [-q --quiet]
- Check the signature of a byte sequence as per Michelson instruction `CHECK_SIGNATURE`.
- <bytes>: the signed data
- <key>: existing public_key alias
- <signature>: the signature to check
- -q --quiet: Use only exit codes
- Commands related to delegate operations.:
- bake for <baker> [--max-priority <slot>] [--fee-threshold <threshold>]
- [-f --force] [--minimal-timestamp]
- Forge and inject block using the delegate rights.
- <baker>: name of the delegate owning the baking right
- --max-priority <slot>: maximum allowed baking slot
- --fee-threshold <threshold>: exclude operations with fees lower than this threshold (in mutez)
- -f --force: disables the node's injection checks
- --minimal-timestamp: Use the minimal timestamp instead of the current date as timestamp of the baked block.
- reveal nonce for [<block_hash>...]
- Forge and inject a seed-nonce revelation operation.
- <block_hash>: A block identifier
- reveal nonces
- Forge and inject all the possible seed-nonce revelation operations.
- endorse for <baker>
- Forge and inject an endorsement operation.
- <baker>: name of the delegate owning the endorsement right
- Commands for managing the wallet of cryptographic keys:
- list signing schemes
- List supported signing schemes.
- gen keys <new> [-f --force] [-s --sig <ed25519|secp256k1|p256>]
- Generate a pair of keys.
- <new>: new secret_key alias
- -f --force: overwrite existing secret_key
- -s --sig <ed25519|secp256k1|p256>: use custom signature algorithm
- gen vanity keys <new> matching [<words>...] [-P --prefix] [-f --force]
- Generate keys including the given string.
- <new>: new public key hash alias
- <words>: string key must contain one of these words
- -P --prefix: the key must begin with tz1[word]
- -f --force: overwrite existing keys
- import secret key <new> <uri> [-f --force]
- Add a secret key to the wallet.
- <new>: new secret_key alias
- <uri>: secret key
- -f --force: overwrite existing secret_key
- import fundraiser secret key <new> [-f --force]
- Add a fundraiser secret key to the wallet.
- <new>: new secret_key alias
- -f --force: overwrite existing secret_key
- import public key <new> <uri> [-f --force]
- Add a public key to the wallet.
- <new>: new public_key alias
- <uri>: public key
- -f --force: overwrite existing public_key
- add address <new> <src> [-f --force]
- Add an address to the wallet.
- <new>: new public key hash alias
- <src>: source public key hash
- -f --force: overwrite existing public_key
- list known addresses
- List all addresses and associated keys.
- show address <name> [-S --show-secret]
- Show the keys associated with an implicit account.
- <name>: existing public key hash alias
- -S --show-secret: show the private key
- forget address <name> [-f --force]
- Forget one address.
- <name>: existing public key hash alias
- -f --force: delete associated keys when present
- forget all keys [-f --force]
- Forget the entire wallet of keys.
- -f --force: you got to use the force for that
- Commands for managing the connected Ledger Nano S devices:
- list connected ledgers
- List supported Ledger Nano S devices connected.
- show ledger path <uri>
- Show BIP32 derivation at path for Ledger
- <uri>: secret key
- authorize ledger to bake for <name>
- Authorize a Ledger to bake for a key
- <name>: existing public_key alias
- get ledger high watermark for <uri>
- Get high water mark of a Ledger
- <uri>: secret key
- set ledger high watermark for <uri> to <high watermark>
- Set high water mark of a Ledger
- <uri>: secret key
- <high watermark>: High watermark
- Commands for the low level RPC layer:
- rpc list <url>
- List RPCs under a given URL prefix.
- <url>: the URL prefix
- rpc list
- Alias to `rpc list /`.
- rpc schema <HTTP method> <url>
- Get the input and output JSON schemas of an RPC.
- <HTTP method>:
- <url>: the RPC url
- rpc format <HTTP method> <url> [-b --binary]
- Get the humanoid readable input and output formats of an RPC.
- <HTTP method>:
- <url>: the RPC URL
- -b --binary: Binary format
- rpc get <url>
- Call an RPC with the GET method.
- <url>: the RPC URL
- rpc post <url>
- Call an RPC with the POST method.
- <url>: the RPC URL
- rpc post <url> with <input>
- Call an RPC with the POST method, providing input data via the command line.
- <url>: the RPC URL
- <input>: the raw JSON input to the RPC
- Commands for editing and viewing the client's config file:
- config show
- Show the config file.
- config reset
- Reset the config file to the factory defaults.
- config update
- Update the config based on the current cli values.
- config init [-o --output <path>]
- Create a config file based on the current CLI values.
- -o --output <path>: path at which to create the file
- Miscellaneous commands:
- list understood protocols
- List the protocol versions that this client understands.
- complete <prefix> [-u --unique]
- Autocomplete a prefix of Base58Check-encoded hash.
- <prefix>: the prefix of the hash to complete
- -u --unique: Fail when there is more than one possible completion.
- bootstrapped
- Wait for the node to be bootstrapped.
- wait for <operation> to be included [---confirmations <num_blocks>]
- [---check-previous <num_blocks>]
- Wait until an operation is included in a block
- <operation>: Operation to be included
- ---confirmations <num_blocks>: do not end until after 'N' additional blocks after the operation appears
- ---check-previous <num_blocks>: number of previous blocks to check
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement