Command Line Interface#
This document is a prettier output of the documentation produced by
the command man
of the different Octez binaries. You can obtain similar pages
using shell commands such as (indicating the appropriate protocol):
octez-client -protocol <protocol_hash> man -verbosity 3
Note
The rest of this page documents the protocol-dependent tools, that is, those whose behavior or features may be specific to each protocol. The protocol-independent tools are documented here.
Client manual#
This is the manual page of the command line tool octez-client
. See Client for a general description of this tool.
Usage
-
octez-client [global options] command [command options]
-
octez-client --help (for global options)
-
octez-client [global options] command --help (for command options)
-
octez-client --version (for version information)
To browse the documentation
-
octez-client [global options] man (for a list of commands)
-
octez-client [global options] man -v 3 (for the full manual)
Global options (must come before the command)
Access the documentation
-
octez-client man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]Print documen Add se keyword: keyword If seve -v --verbosity <0|1|2|3>: level 0. O --format <plain|colors|html>: the manu Defaults
Commands for editing and viewing the client's config file
-
octez-client config showShow
-
octez-client config resetReset
-
octez-client config updateUpdate Loads
-
octez-client config init [-o --output <path>] [--bootstrap-accounts <path>] [--protocol-constants <path>]Create If -o --output <path>: path Defaults `$HOME/.tezos-cli --bootstrap-accounts <path>: path Defaults `$HOME/.tezos-client/bootstrap-acc --protocol-constants <path>: path Defaults `$HOME/.tezos-client/protocol-cons
Commands for the low level RPC layer
-
octez-client rpc list urlList Some url: the
-
octez-client rpc listAlias
-
octez-client rpc schema HTTP method urlGet HTTP method: url: the
-
octez-client rpc format HTTP method url [-b --binary]Get HTTP method: url: the -b --binary: Binary
-
octez-client rpc get urlCall url: the
-
octez-client rpc post urlCall It invo url: the
-
octez-client rpc post url with inputCall url: the input: the For insta
-
octez-client rpc patch urlCall It invo url: the
-
octez-client rpc patch url with inputCall url: the input: the For insta
-
octez-client rpc put urlCall It invo url: the
-
octez-client rpc put url with inputCall url: the input: the For insta
-
octez-client rpc delete urlCall url: the
Commands for managing the connected Ledger Nano devices
-
octez-client list connected ledgersList supp
-
octez-client show ledger account-alias-or-ledger-uri [--test-sign]Display version/public-key account-alias-or-ledger-uri: An impor --test-sign: Test si
-
octez-client get ledger authorized path for account-alias-or-ledger-uriQuery account-alias-or-ledger-uri: An impor
-
octez-client authorize ledger to bake for account-alias-or-ledger-uriAuthorize account-alias-or-ledger-uri: An impor
-
octez-client setup ledger to bake for account-alias-or-ledger-uri [--main-chain-id <ID>] [--main-hwm <HWM>] [--test-hwm <HWM>]Setup account-alias-or-ledger-uri: An impor --main-chain-id <ID>: Use Defaults --main-hwm <HWM>: Use < Defaults ` --test-hwm <HWM>: Use < Defaults `
-
octez-client deauthorize ledger baking for account-alias-or-ledger-uriDeauthorize account-alias-or-ledger-uri: An impor
-
octez-client get ledger high water mark for account-alias-or-ledger-uri [--no-legacy-instructions]Get account-alias-or-ledger-uri: An impor --no-legacy-instructions: Prevent
-
octez-client set ledger high water mark for account-alias-or-ledger-uri to high watermarkSet account-alias-or-ledger-uri: An impor high watermark: High wate
-
octez-client get ledger high watermark for account-alias-or-ledger-uri [--no-legacy-instructions]Get account-alias-or-ledger-uri: An impor --no-legacy-instructions: Prevent
-
octez-client set ledger high watermark for account-alias-or-ledger-uri to high watermarkSet account-alias-or-ledger-uri: An impor high watermark: High wate
Commands for managing the wallet of cryptographic keys
-
octez-client stresstest gen keys keys_count [--alias-prefix <PREFIX>] [-s --sig <ed25519|secp256k1|p256|bls>]Generate keys_count: How --alias-prefix <PREFIX>: use -s --sig <ed25519|secp256k1|p256|bls>: use cu Defaults
-
octez-client list signing schemesList supp Signing
-
octez-client gen keys new [-f --force] [-s --sig <ed25519|secp256k1|p256|bls>] [--encrypted]Generate new: new secret -f --force: overwrite -s --sig <ed25519|secp256k1|p256|bls>: use cu Defaults --encrypted: Encrypt
-
octez-client gen vanity keys new matching [words...] [-P --prefix] [-I --ignore-case] [-f --force] [--encrypted]Generate new: new pu words: string -P --prefix: the -I --ignore-case: make -f --force: overwrite --encrypted: Encrypt
-
octez-client encrypt secret keyEncrypt
-
octez-client import secret key new uri [-f --force]Add new: new secret uri: secret Varies -f --force: overwrite
-
octez-client import public key new uri [-f --force]Add new: new public uri: public Varies -f --force: overwrite
-
octez-client add address new src [-f --force]Add new: new pu src: source Can -f --force: overwrite
-
octez-client list known addressesList
-
octez-client list known remote keys uriList uri: remote Varies
-
octez-client show address name [-S --show-secret]Show name: existing -S --show-secret: show
-
octez-client forget address name [-f --force]Forget name: existing -f --force: delete ass
-
octez-client forget all keys [-f --force]Forget -f --force: you
-
octez-client generate nonce for name from dataCompute deter name: existing data: string
-
octez-client generate nonce hash for name from dataCompute deter name: existing data: string
-
octez-client import keys from mnemonic new [-f --force] [--encrypt]Import new: new secret -f --force: overwrite --encrypt: encrypt
Commands for creating mockup environments
-
octez-client list mockup protocolsList avai
-
octez-client migrate mockup to hashMigrates hash: Protocol
-
octez-client create mockup [--protocol-constants <path>] [--bootstrap-accounts <path>] [--asynchronous]Create --protocol-constants <path>: a JS --bootstrap-accounts <path>: a JS --asynchronous: put operat
Commands querying proxy and light mode support
-
octez-client list proxy protocolsList prot
-
octez-client list light protocolsList prot
Commands for managing the record of known smart rollup
-
octez-client remember smart rollup new src [-f --force]Add new: new s src: source Can -f --force: overwrite
-
octez-client forget smart rollup nameRemove name: existing
-
octez-client list known smart rollupsLists
-
octez-client forget all smart rollups [-f --force]Forget -f --force: overwrite
-
octez-client show known smart rollup nameDisplay name: existing
Tenderbake client commands
-
octez-client bench nb_draw baking PoW challenges [--threshold <int>] [--seed <int>]Benchmark nb_draw: number --threshold <int>: Proof Defaults `28147 --seed <int>: Random
-
octez-client bake for [baker...] [--minimal-fees <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-timestamp] [--force-apply-from-round <round>] [-f --force] [--operations-pool <file|uri>] [--context <path>] [--adaptive-issuance-vote <vote>] [--ignore-node-mempool] [--dal-node <uri>] [-n --count <block count>] [--record-state]Forge baker: name Can --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-timestamp: Use --force-apply-from-round <round>: Force -f --force: disables Force --operations-pool <file|uri>: When speci --context <path>: When speci --adaptive-issuance-vote <vote>: Vote --ignore-node-mempool: Ignore --dal-node <uri>: endpoint -n --count <block count>: number Defaults --record-state: If record-st
-
octez-client attest for [baker...] [-f --force]Forge baker: name Can -f --force: Disable cons
-
octez-client preattest for [baker...] [-f --force]Forge baker: name Can -f --force: Disable cons
-
octez-client propose for [baker...] [--minimal-fees <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-timestamp] [--force-apply-from-round <round>] [-f --force] [--operations-pool <file|uri>] [--context <path>] [--record-state]Send Ten baker: name Can --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-timestamp: Use --force-apply-from-round <round>: Force -f --force: disables Force --operations-pool <file|uri>: When speci --context <path>: When speci --record-state: If record-st
-
octez-client repropose for [baker...] [-f --force] [--force-round <round>] [--minimal-timestamp] [--force-reproposal]Send baker: name Can -f --force: disables Force --force-round <round>: Bake ex --minimal-timestamp: Use --force-reproposal: Force
Commands for managing the library of known scripts
-
octez-client list known scriptsLists
-
octez-client remember script new src [-f --force]Add new: new sc src: source Can -f --force: overwrite
-
octez-client forget script nameRemove name: existing
-
octez-client show known script nameDisplay name: existing
-
octez-client run script src on storage storage and input input [--trace-stack] [--amount <amount>] [--balance <amount>] [--source <source>] [--payer <src>] [--self-address <self-address>] [-q --no-print-source] [-G --gas <gas>] [--entrypoint <name>] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>] [--other-contracts <contracts>] [--extra-big-maps <big maps>]Ask src: source Can storage: the sto input: the i --trace-stack: show --amount <amount>: amount Defaults --balance <amount>: balance --source <source>: name Can --payer <src>: name Can --self-address <self-address>: address Can -q --no-print-source: don't If -G --gas <gas>: Initial --entrypoint <name>: entrypoint --unparsing-mode <mode>: Unparsing One "Rea --now <timestamp>: Set t --level <level>: Set --other-contracts <contracts>: types --extra-big-maps <big maps>: identifier
-
octez-client run michelson code src on stack stack [--amount <amount>] [--balance <amount>] [--source <source>] [--payer <src>] [--self-address <self-address>] [-G --gas <gas>] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>] [--other-contracts <contracts>] [--extra-big-maps <big maps>] [--legacy]Ask src: source Can stack: a Michels --amount <amount>: amount Defaults --balance <amount>: balance --source <source>: name Can --payer <src>: name Can --self-address <self-address>: address Can -G --gas <gas>: Initial --unparsing-mode <mode>: Unparsing One "Rea --now <timestamp>: Set t --level <level>: Set --other-contracts <contracts>: types --extra-big-maps <big maps>: identifier --legacy: typecheck
-
octez-client compute size for script src on storage storage [--emacs] [-q --no-print-source] [-G --gas <gas>] [--legacy]Ask src: source Can storage: the sto --emacs: output `michelso -q --no-print-source: don't If -G --gas <gas>: Initial --legacy: typecheck
-
octez-client run unit tests from [source...]Ask source: literal
-
octez-client typecheck script [source...] [-v --details] [--emacs] [-q --no-print-source] [-G --gas <gas>] [--legacy] [--display-names]Ask source: literal -v --details: show --emacs: output `michelso -q --no-print-source: don't If -G --gas <gas>: Initial --legacy: typecheck --display-names: Print
-
octez-client typecheck data data against type type [-q --no-print-source] [-G --gas <gas>] [--legacy]Ask data: the type: the expe -q --no-print-source: don't If -G --gas <gas>: Initial --legacy: typecheck
-
octez-client hash data data of type type [-G --gas <gas>] [--for-script <FORMAT>]Ask The retu data: the type: type -G --gas <gas>: Initial --for-script <FORMAT>: Make
-
octez-client hash script [source...] [--enforce-indentation] [--display-names] [--for-script <FORMAT>]Ask source: literal --enforce-indentation: Check --display-names: Print --for-script <FORMAT>: Make
-
octez-client unpack michelson data bytesParse bytes: the pa
-
octez-client normalize script src [--unparsing-mode <mode>]Ask src: source Can --unparsing-mode <mode>: Unparsing One "Rea
-
octez-client normalize data data of type type [--unparsing-mode <mode>] [--legacy] [--other-contracts <contracts>] [--extra-big-maps <big maps>]Ask data: the e type: type --unparsing-mode <mode>: Unparsing One "Rea --legacy: typecheck --other-contracts <contracts>: types --extra-big-maps <big maps>: identifier
-
octez-client normalize stack stack [--unparsing-mode <mode>] [--legacy] [--other-contracts <contracts>] [--extra-big-maps <big maps>]Ask stack: a Michels --unparsing-mode <mode>: Unparsing One "Rea --legacy: typecheck --other-contracts <contracts>: types --extra-big-maps <big maps>: identifier
-
octez-client normalize type typAsk typ: the Miche
-
octez-client sign bytes data for srcSign data: the src: source sec Can s
-
octez-client check that bytes bytes were signed by key to produce signature [-q --quiet]Check bytes: the si key: existing p signature: the signa -q --quiet: Use
-
octez-client get script entrypoint type of entrypoint for src [--emacs] [-q --no-print-source]Ask entrypoint: the entryp src: source Can --emacs: output `michelso -q --no-print-source: don't If
-
octez-client get script entrypoints for src [--emacs] [-q --no-print-source]Ask src: source Can --emacs: output `michelso -q --no-print-source: don't If
-
octez-client get script unreachable paths for src [--emacs] [-q --no-print-source]Ask src: source Can --emacs: output `michelso -q --no-print-source: don't If
-
octez-client expand macros in srcAsk src: source Can
-
octez-client run tzip4 view entrypoint on contract contract with input input [--source <source>] [--payer <src>] [-G --gas <gas>] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>] [--other-contracts <contracts>] [--extra-big-maps <big maps>]Ask entrypoint: the contract: viewed c Can input: the i --source <source>: name Can --payer <src>: name Can -G --gas <gas>: Initial --unparsing-mode <mode>: Unparsing One "Rea --now <timestamp>: Set t --level <level>: Set --other-contracts <contracts>: types --extra-big-maps <big maps>: identifier
-
octez-client run view view on contract contract [--source <source>] [--payer <src>] [-G --gas <gas>] [--unlimited-gas] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>] [--other-contracts <contracts>] [--extra-big-maps <big maps>]Ask view: the contract: the cont Can --source <source>: name Can --payer <src>: name Can -G --gas <gas>: Initial --unlimited-gas: Allows interpr --unparsing-mode <mode>: Unparsing One "Rea --now <timestamp>: Set t --level <level>: Set --other-contracts <contracts>: types --extra-big-maps <big maps>: identifier
-
octez-client run view view on contract contract with input input [--source <source>] [--payer <src>] [-G --gas <gas>] [--unlimited-gas] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>] [--other-contracts <contracts>] [--extra-big-maps <big maps>]Ask view: the contract: the cont Can input: the argu --source <source>: name Can --payer <src>: name Can -G --gas <gas>: Initial --unlimited-gas: Allows interpr --unparsing-mode <mode>: Unparsing One "Rea --now <timestamp>: Set t --level <level>: Set --other-contracts <contracts>: types --extra-big-maps <big maps>: identifier
Commands for managing the record of known contracts
-
octez-client remember contract new src [-f --force]Add co new: new cont src: source c Can -f --force: overwrite
-
octez-client forget contract nameRemove name: existing
-
octez-client list known contractsLists
-
octez-client forget all contracts [-f --force]Forget -f --force: overwrite
-
octez-client show known contract nameDisplay name: existing
Block contextual commands (see option -block)
-
octez-client set delegate for src to dlgt [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--initial-stake <amount>]Set src: source c Can dlgt: new dele Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --initial-stake <amount>: Amount
-
octez-client withdraw delegate from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Withdraw src: source c Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client originate contract new transferring qty from src running prg [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [--delegate <address>] [-f --force] [--init <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Launch new: name qty: amount Text fo `DDD src: name Can prg: script Combine --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set --delegate <address>: delegate Must -f --force: overwrite --init <data>: initial Defaults -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client multiple transfers from src using transfers.json [--default-fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --default-gas-limit <amount>] [--safety-guard <extra_gas>] [-S --default-storage-limit <amount>] [-C --counter <counter>] [--default-arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--default-entrypoint <name>] [--replace]Execute If src: name Can transfers.json: List op --default-fee <amount>: default -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --default-gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --default-storage-limit <amount>: Set -C --counter <counter>: Set --default-arg <data>: default -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --default-entrypoint <name>: default en --replace: Replace
-
octez-client originate epoxy epoxy from src public_parameters public_parameters init_state init_state circuits_info circuits_info nb_ops nb_ops [--force] [--default-fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-G --default-gas-limit <amount>] [--safety-guard <extra_gas>] [-S --default-storage-limit <amount>] [-C --counter <counter>] [--default-arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--default-entrypoint <name>] [--replace]Execute epoxy: Fresh src: name Can public_parameters: public_parameters init_state: init_state circuits_info: circuits_info nb_ops: nb_ops --force: Inject --default-fee <amount>: default -D --dry-run: don't --verbose-signing: display --simulation: Simulate -G --default-gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --default-storage-limit <amount>: Set -C --counter <counter>: Set --default-arg <data>: default -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --default-entrypoint <name>: default en --replace: Replace
-
octez-client epoxy publish from src rollup rollup ops ops [--default-fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-G --default-gas-limit <amount>] [--safety-guard <extra_gas>] [-S --default-storage-limit <amount>] [-C --counter <counter>] [--default-arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--default-entrypoint <name>] [--replace]Execute src: name Can rollup: rollup ops: ops --default-fee <amount>: default -D --dry-run: don't --verbose-signing: display --simulation: Simulate -G --default-gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --default-storage-limit <amount>: Set -C --counter <counter>: Set --default-arg <data>: default -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --default-entrypoint <name>: default en --replace: Replace
-
octez-client epoxy update from src rollup rollup update update [--default-fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-G --default-gas-limit <amount>] [--safety-guard <extra_gas>] [-S --default-storage-limit <amount>] [-C --counter <counter>] [--default-arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--default-entrypoint <name>] [--replace]Execute src: name Can rollup: rollup update: update --default-fee <amount>: default -D --dry-run: don't --verbose-signing: display --simulation: Simulate -G --default-gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --default-storage-limit <amount>: Set -C --counter <counter>: Set --default-arg <data>: default -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --default-entrypoint <name>: default en --replace: Replace
-
octez-client transfer qty from src to dst [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>] [--replace] [--simulate-successor-level]Transfer qty: amount Text fo `DDD src: name Can dst: name/literal Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set --arg <data>: argument -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --entrypoint <name>: entrypoint --replace: Replace --simulate-successor-level: Make
-
octez-client register global constant expression from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]Register expression: Michelson src: name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults -S --storage-limit <amount>: Set -C --counter <counter>: Set
-
octez-client call dst from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>] [--replace] [--simulate-successor-level]Call dst: name/literal Can src: name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set --arg <data>: argument -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --entrypoint <name>: entrypoint --replace: Replace --simulate-successor-level: Make
-
octez-client stake qty for src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--replace] [--simulate-successor-level]Stake qty: amount Text fo `DDD src: name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --replace: Replace --simulate-successor-level: Make
-
octez-client unstake qty for src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--replace] [--simulate-successor-level]Unstake qty: amount Text fo `DDD src: name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --replace: Replace --simulate-successor-level: Make
-
octez-client finalize unstake for src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--replace] [--simulate-successor-level]Transfer src: name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --replace: Replace --simulate-successor-level: Make
-
octez-client set delegate parameters for src [--limit-of-staking-over-baking <limit>] [--edge-of-baking-over-staking <edge>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--replace] [--simulate-successor-level]Set dele src: name Can --limit-of-staking-over-baking <limit>: Limits --edge-of-baking-over-staking <edge>: Sets --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --replace: Replace --simulate-successor-level: Make
-
octez-client update delegate parameters for src [--limit-of-staking-over-baking <limit>] [--edge-of-baking-over-staking <edge>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--replace] [--simulate-successor-level]Update d src: name Can --limit-of-staking-over-baking <limit>: Limits --edge-of-baking-over-staking <edge>: Sets --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --force: Inject -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --replace: Replace --simulate-successor-level: Make
-
octez-client reveal key for src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Reveal src: name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client register key mgr as delegate [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--consensus-key <consensus_key>] [--companion-key <companion_key>] [--consensus-key-pop <proof-of-possession>] [--companion-key-pop <proof-of-possession>] [--initial-stake <amount>]Register mgr: the dele Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --consensus-key <consensus_key>: Register Can p --companion-key <companion_key>: Register Can p --consensus-key-pop <proof-of-possession>: Proof p --companion-key-pop <proof-of-possession>: Proof p --initial-stake <amount>: Amount
-
octez-client register key mgr as delegate with consensus key key [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--consensus-key-pop <proof-of-possession>]Register mgr: the dele Can key: the conse Can p --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --consensus-key-pop <proof-of-possession>: Proof p
-
octez-client set consensus key for mgr to key [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--consensus-key-pop <proof-of-possession>]Update mgr: the dele Can key: the conse Can p --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --consensus-key-pop <proof-of-possession>: Proof p
-
octez-client set companion key for mgr to key [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--companion-key-pop <proof-of-possession>]Update mgr: the dele Can key: the compa Can p --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --companion-key-pop <proof-of-possession>: Proof p
-
octez-client drain delegate mgr to dest [-D --dry-run] [--verbose-signing]Drain mgr: the dele Can dest: the conse Can -D --dry-run: don't --verbose-signing: display
-
octez-client drain delegate mgr to dest with consensus_key [-D --dry-run] [--verbose-signing]Drain mgr: the dele Can dest: the destina Can consensus_key: the conse Can -D --dry-run: don't --verbose-signing: display
-
octez-client submit proposals for delegate [proposal...] [-D --dry-run] [--verbose-signing] [--force]Submit p delegate: the dele Can proposal: the prot -D --dry-run: don't --verbose-signing: display --force: Do
-
octez-client submit ballot for delegate proposal ballot [--verbose-signing] [-D --dry-run] [--force]Submit delegate: the dele Can proposal: the prot ballot: the ba --verbose-signing: display -D --dry-run: don't --force: Do
-
octez-client set deposits limit for src to deposits limit [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Set src: source c Can deposits limit: the max Text fo `DDD --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client unset deposits limit for src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Remove src: source c Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client increase the paid storage of contract by amount bytes from payer [--force] [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Increase contract: name Can amount: amount payer: payer Can --force: Inject --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client transfer qty tickets from tickets owner to recipient contract with entrypoint entrypoint and contents tickets content and type tickets type and ticketer tickets ticketer [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]Transfer qty: Amount tickets owner: Implicit Can recipient contract: Contract Can entrypoint: Entrypoint tickets content: Content tickets type: Type tickets ticketer: Ticketer Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults -S --storage-limit <amount>: Set -C --counter <counter>: Set
-
octez-client originate smart rollup alias from src of kind smart_rollup_kind of type parameters_type with kernel kernel [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-f --force] [-W --whitelist <whitelist>]Originate alias: name src: Name Can smart_rollup_kind: Kind parameters_type: The inter kernel: The ke --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults -S --storage-limit <amount>: Set -C --counter <counter>: Set -f --force: overwrite -W --whitelist <whitelist>: Whitelist
-
octez-client send smart rollup message messages from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>]Send messages: The messag src: Name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set
-
octez-client publish commitment from src for smart rollup smart rollup address with compressed state compressed_state at inbox level inbox_level and predecessor predecessor and number of ticks number_of_ticks [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-S --storage-limit <amount>] [-C --counter <counter>] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Publish src: Name Can smart rollup address: The add Can compressed_state: The compre inbox_level: The i predecessor: The number_of_ticks: The nu --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate -S --storage-limit <amount>: Set -C --counter <counter>: Set --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client cement commitment from src for smart rollup smart rollup address [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-S --storage-limit <amount>] [-C --counter <counter>] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Cement c src: Name Can smart rollup address: The add Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate -S --storage-limit <amount>: Set -C --counter <counter>: Set --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client timeout dispute on smart rollup smart rollup address with staker1 against staker2 from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-S --storage-limit <amount>] [-C --counter <counter>] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Timeout smart rollup address: The add Can staker1: The st Can staker2: The oppo Can src: Name Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate -S --storage-limit <amount>: Set -C --counter <counter>: Set --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client list smart rollupsList origi
-
octez-client execute outbox message of smart rollup smart rollup address from source for commitment hash cemented commitment and output proof output proof [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]Execute smart rollup address: The add Can source: The acc Can cemented commitment: The output proof: The ou --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults -S --storage-limit <amount>: Set -C --counter <counter>: Set
-
octez-client recover bond of staker for smart rollup smart rollup address from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]Recover co staker: The impl Can smart rollup address: The add Can src: The impl Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults -S --storage-limit <amount>: Set -C --counter <counter>: Set
-
octez-client timelock precompute for time in file [--timelock-locked-valuec <timelock-locked>]Precompute time: timelock d file: updates --timelock-locked-valuec <timelock-locked>: Timelock
-
octez-client timelock create for time with payload in fileGenerate time: timelock d payload: timelock file: updates
-
octez-client timelock open for time chest chest in fileOpen tim time: timelock d chest: timelock file: updates
-
octez-client timelock verify for time chest chest chest_key chest_keyVerify t time: timelock d chest: timelock chest_key: timelock
-
octez-client publish dal commitment commitment from src for slot DAL slot index with proof commitment proof [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-S --storage-limit <amount>] [-C --counter <counter>] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Publish commitment: The co src: Name Can DAL slot index: The i commitment proof: The p --fee <amount>: fee -D --dry-run: don't --verbose-signing: display --simulation: Simulate -S --storage-limit <amount>: Set -C --counter <counter>: Set --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client activate account new with activation_key [-f --force] [--encrypted]Register new: new secret activation_key: Activate Alph -f --force: overwrite --encrypted: encrypt
-
octez-client get timestamp [-s --seconds]Access -s --seconds: output
-
octez-client list contractsLists
-
octez-client list cached contractsLists
-
octez-client get cached contract rank for srcGet src: contract Can
-
octez-client get cache contract sizeGet c
-
octez-client get cache contract size limitGet c
-
octez-client get balance for srcGet src: source c Can
-
octez-client get staked balance for srcGet src: source c Can
-
octez-client get full balance for srcGet src: source c Can
-
octez-client get contract storage for src [--unparsing-mode <mode>]Get src: source c Can --unparsing-mode <mode>: Unparsing One "Rea
-
octez-client get contract used storage space for srcGet src: source c Can
-
octez-client get contract paid storage space for srcGet src: source c Can
-
octez-client get big map value for key of type type in srcGet key: the type: type src: source c Can
-
octez-client get element key of big map big_map [--unparsing-mode <mode>]Get key: the big_map: identifier --unparsing-mode <mode>: Unparsing One "Rea
-
octez-client get contract code for src [--unparsing-mode <mode>] [--normalize-types]Get src: source c Can --unparsing-mode <mode>: Unparsing One "Rea --normalize-types: Whether
-
octez-client get contract script hash for srcGet ` src: source c Can
-
octez-client get contract entrypoint type of entrypoint for src [--normalize-types]Get entrypoint: the entryp src: source c Can --normalize-types: Whether
-
octez-client get contract entrypoints for src [--normalize-types]Get en src: source c Can --normalize-types: Whether
-
octez-client get contract unreachable paths for srcGet src: source c Can
-
octez-client get delegate for srcGet src: source c Can
-
octez-client get ticket balance for src with ticketer ticketer and type ticket content type and content ticket contentGet contra src: Source a Can ticketer: Ticketer Can ticket content type: Type ticket content: Content
-
octez-client get all ticket balances for srcGet src: Source co Can
-
octez-client show voting periodSummarize
-
octez-client get deposits limit for srcGet src: source d Can
-
octez-client sapling shield qty from src-tz to dst-sap using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--message <>]Shield qty: Amount Text fo `DDD src-tz: Transparent Can dst-sap: Sapling sapling contract: Smart co Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --message <>: Message
-
octez-client sapling unshield qty from src-sap to dst-tz using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Unshield qty: Amount Text fo `DDD src-sap: Sapling dst-tz: Transparent Can sapling contract: Smart co Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client sapling forge transaction qty from src-sap to dst-sap using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--message <>] [--file <sapling_transaction>] [--json]Forge qty: Amount Text fo `DDD src-sap: Sapling dst-sap: Sapling sapling contract: Smart co Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --message <>: Message --file <sapling_transaction>: file --json: Use
-
octez-client sapling submit file from alias-tz using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--json]Submit file: Filename alias-tz: Transparent Can sapling contract: Smart co Can --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --json: Use
-
octez-client stresstest originate smart contracts from srcOriginate src: name Can
Binary Description
-
octez-client describe unsigned block headerDescribe
-
octez-client describe unsigned operationDescribe
Commands for managing a multisig smart contract
-
octez-client show supported multisig hashesShow
-
octez-client show multisig scriptShow
-
octez-client deploy multisig new_multisig transferring qty from src with threshold threshold on public keys [key...] [--fee <amount>] [-D --dry-run] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [--delegate <address>] [-f --force] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--verbose-signing]Originate new_multisig: name qty: amount Text fo `DDD src: name Can threshold: Number key: Each s Can p --fee <amount>: fee -D --dry-run: don't -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set --delegate <address>: delegate Must -f --force: overwrite -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --verbose-signing: display
-
octez-client sign multisig transaction on multisig transferring qty to dst using secret key key [--arg <data>] [--entrypoint <name>]Sign tran multisig: name Can qty: amount Text fo `DDD dst: name/literal Can key: Secret co Can s --arg <data>: argument --entrypoint <name>: entrypoint
-
octez-client sign multisig transaction on multisig running lambda lambda using secret key keySign multisig: name Can lambda: the la key: Secret co Can s
-
octez-client sign multisig transaction on multisig setting delegate to dlgt using secret key keySign d multisig: name Can dlgt: new dele Can key: Secret co Can s
-
octez-client sign multisig transaction on multisig withdrawing delegate using secret key keySign d multisig: name Can key: Secret co Can s
-
octez-client sign multisig transaction on multisig using secret key key setting threshold to threshold and public keys to [key...]Sign multisig: name Can key: Secret co Can s threshold: Number key: Each s Can p
-
octez-client from multisig contract multisig transfer qty to dst on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>]Transfer multisig: name/literal Can qty: amount Text fo `DDD dst: name/literal Can src: source Can signature: Each s --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set --arg <data>: argument -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults --entrypoint <name>: entrypoint
-
octez-client from multisig contract multisig run lambda lambda on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Run multisig: name/literal Can lambda: the la src: source Can signature: Each s --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client set delegate of multisig contract multisig to dlgt on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Change multisig: name Can dlgt: new dele Can src: source Can signature: Each s --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client withdraw delegate of multisig contract multisig on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Withdraw multisig: name Can src: source Can signature: Each s --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client set threshold of multisig contract multisig to threshold and public keys to [key...] on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Change multisig: name Can threshold: Number key: Each s Can p src: source Can signature: Each s --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client run transaction bytes on multisig contract multisig on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Run trans bytes: the sequ multisig: name Can src: source Can signature: Each s --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client prepare multisig transaction on multisig transferring qty to dst [--bytes-only] [--arg <data>] [--entrypoint <name>]Display multisig: name Can qty: amount Text fo `DDD dst: name/literal Can --bytes-only: return --arg <data>: argument --entrypoint <name>: entrypoint
-
octez-client prepare multisig transaction on multisig running lambda lambda [--bytes-only]Display multisig: name Can lambda: the la --bytes-only: return
-
octez-client prepare multisig transaction on multisig setting delegate to dlgt [--bytes-only]Display multisig: name Can dlgt: new dele Can --bytes-only: return
-
octez-client prepare multisig transaction on multisig withdrawing delegate [--bytes-only]Display multisig: name Can --bytes-only: return
-
octez-client prepare multisig transaction on multisig setting threshold to threshold and public keys to [key...] [--bytes-only]Display multisig: name Can threshold: Number key: Each s Can p --bytes-only: return
Commands for working with Sapling transactions
-
octez-client sapling gen key new [-f --force] [--unencrypted]Generate new: new sapling -f --force: overwrite --unencrypted: Do
-
octez-client sapling use key sapling-key for contract contract [--memo-size <memo-size>]Use s sapling-key: Sapling contract: Contract Can --memo-size <memo-size>: Expected
-
octez-client sapling import key new [-f --force] [--unencrypted] [--mnemonic <mnemonic>]Restore new: new sapling -f --force: overwrite --unencrypted: Do --mnemonic <mnemonic>: Mnemonic
-
octez-client sapling derive key new from name at index child-index [-f --force] [--for-contract <for-contract>] [--unencrypted] [--memo-size <memo-size>]Derive new: new sapling name: existing sa child-index: Index -f --force: overwrite --for-contract <for-contract>: name Can --unencrypted: Do --memo-size <memo-size>: Expected
-
octez-client sapling gen address name [--address-index <idx>]Generate name: existing sa --address-index <idx>: index
-
octez-client sapling export key name in fileSave name: existing sa file: Filename.
-
octez-client sapling get balance for sapling-key in contract contract [-v --verbose]Get bal sapling-key: Sapling contract: Contract Can -v --verbose: Print
-
octez-client sapling list keysList sa
Utility Commands
-
octez-client sign message message for src [-b --branch <hash|tag>]Sign message: message src: name Can s -b --branch <hash|tag>: Block Defaults
-
octez-client check that message message was signed by signer to produce signature [-b --branch <hash|tag>] [-q --quiet]Check message: signed signer: name Can p signature: the signa -b --branch <hash|tag>: Block Defaults -q --quiet: Use
-
octez-client sign block unsigned block header for delegateSign a unsigned block header: A h delegate: signing Can
Commands for stress-testing the network
-
octez-client stresstest transfer using sources.json [--seed <int>] [--tps <float>] [--fresh-probability <float in [0;1]>] [--smart-contract-parameters <JSON file with smart contract parameters>] [--strategy <fixed:mutez | evaporation:[0;1]>] [--fee <amount>] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [--transfers <integer>] [--level-limit <integer | +integer>] [-v --verbose] [-V --debug]Generate sources.json: List --seed <int>: random --tps <float>: transactions --fresh-probability <float in [0;1]>: Probability --smart-contract-parameters <JSON file with smart contract parameters>: A JS --strategy <fixed:mutez | evaporation:[0;1]>: wealth redistr --fee <amount>: fee -G --gas-limit <amount>: Set -S --storage-limit <amount>: Set --transfers <integer>: total --level-limit <integer | +integer>: Level -v --verbose: Display -V --debug: Display
-
octez-client stresstest estimate gasOutput
-
octez-client stresstest fund accounts from source_key_arg [--batch-size <integer>] [--batches-per-block <integer>] [--initial-amount <integer>] [--default-fee <amount>] [-G --default-gas-limit <amount>] [-S --default-storage-limit <amount>] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Funds source_key_arg: Source --batch-size <integer>: Maximum Defaults --batches-per-block <integer>: Maximum Defaults --initial-amount <integer>: Number Defaults --default-fee <amount>: default -G --default-gas-limit <amount>: Set -S --default-storage-limit <amount>: Set --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
Commands for managing FA1.2-compatible smart contracts
-
octez-client check contract contract implements fa1.2Check contract: name Can
-
octez-client from fa1.2 contract contract get balance for from [-G --gas <gas>] [--payer <src>] [--unparsing-mode <mode>]Ask contract: name Can from: name Can -G --gas <gas>: Initial --payer <src>: name Can --unparsing-mode <mode>: Unparsing One "Rea
-
octez-client from fa1.2 contract contract get allowance on owner as operator [-G --gas <gas>] [--payer <src>] [--unparsing-mode <mode>]Ask contract: name Can owner: name Can operator: name Can -G --gas <gas>: Initial --payer <src>: name Can --unparsing-mode <mode>: Unparsing One "Rea
-
octez-client from fa1.2 contract contract get total supply [-G --gas <gas>] [--payer <src>] [--unparsing-mode <mode>]Ask contract: name Can -G --gas <gas>: Initial --payer <src>: name Can --unparsing-mode <mode>: Unparsing One "Rea
-
octez-client from fa1.2 contract contract get balance for from callback on callback [--callback-entrypoint <name>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Ask contract: name Can from: name Can callback: name Can --callback-entrypoint <name>: Entrypoint --tez-amount <amount>: amount Defaults --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client from fa1.2 contract contract get allowance on from as to callback on callback [--callback-entrypoint <name>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Ask contract: name Can from: name Can to: name Can callback: name Can --callback-entrypoint <name>: Entrypoint --tez-amount <amount>: amount Defaults --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client from fa1.2 contract contract get total supply as from callback on callback [--callback-entrypoint <name>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Ask contract: name Can from: name Can callback: name Can --callback-entrypoint <name>: Entrypoint --tez-amount <amount>: amount Defaults --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client from fa1.2 contract contract transfer amount from from to to [--as <src>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Transfer contract: name Can amount: number from: name Can to: name Can --as <src>: name Can --tez-amount <amount>: amount Defaults --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client from fa1.2 contract contract as as approve amount from from [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [--safety-guard <extra_gas>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Allow a contract: name Can as: name Can amount: number from: name Can --tez-amount <amount>: amount Defaults --fee <amount>: fee -D --dry-run: don't --verbose-signing: display -G --gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
-
octez-client multiple fa1.2 transfers from src using transfers [--default-fee <amount>] [--as <src>] [-D --dry-run] [--verbose-signing] [-G --default-gas-limit <amount>] [--safety-guard <extra_gas>] [-S --default-storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]Execute src: name Can transfers: List --default-fee <amount>: default --as <src>: name Can -D --dry-run: don't --verbose-signing: display -G --default-gas-limit <amount>: Set --safety-guard <extra_gas>: Amount -S --default-storage-limit <amount>: Set -C --counter <counter>: Set -q --no-print-source: don't If --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --force-low-fee: Don't --fee-cap <amount>: Set Defaults --burn-cap <amount>: Set Defaults
BLS utility commands
-
octez-client aggregate bls signatures inputConstruct input: a publ
-
octez-client create bls proof for src [--override-public-key <OVERRIDE_PUBLIC_KEY>]Create src: source sec Can s --override-public-key <OVERRIDE_PUBLIC_KEY>: Change
-
octez-client check bls proof BLS proof for BLS public key [--override-public-key <PUBLIC_KEY>]Check BLS proof: BLS p BLS public key: B58 enc --override-public-key <PUBLIC_KEY>: Change
-
octez-client aggregate bls public keys list of BLS public keys with proofsAggregate list of BLS public keys with proofs: list
-
octez-client aggregate bls proofs inputAggregate input: a publ
-
octez-client share bls secret key BLS secret key between shares shares with threshold thresholdShamir's BLS secret key: B58 enc shares: Number threshold: Number
-
octez-client threshold bls signatures inputConstruct input: a publ
Miscellaneous commands
-
octez-client get receipt for operation [--check-previous <num_blocks>]Get rec operation: Operation --check-previous <num_blocks>: number Defaults
-
octez-client wait for operation to be included [--confirmations <num_blocks>] [--check-previous <num_blocks>] [--branch <block_hash>]Wait operation: Operation --confirmations <num_blocks>: wait Defaults --check-previous <num_blocks>: number Defaults --branch <block_hash>: hash
-
octez-client convert data source from input_format to output_format [-z --zero-loc] [-t --type <unit>]Conversion source: literal input_format: format output_format: format -z --zero-loc: replace -t --type <unit>: the g
-
octez-client convert script source from input_format to output_format [-z --zero-loc] [--legacy] [--enforce-indentation]Conversion source: literal input_format: format output_format: format -z --zero-loc: replace --legacy: typecheck --enforce-indentation: Check
-
octez-client compute chain id from seed stringComputes string: the
-
octez-client compute chain id from block hash hashComputes hash: the b
-
octez-client bootstrappedWait
-
octez-client complete prefix [-u --unique]Autocomplete This act prefix: the pr -u --unique: Fail
-
octez-client list understood protocolsList
Baker manual#
This is the manual page of the baker command line tool. See Baker for a general description of this tool.
Usage
-
octez-baker-PtSeouLo [global options] command [command options]
-
octez-baker-PtSeouLo --help (for global options)
-
octez-baker-PtSeouLo [global options] command --help (for command options)
-
octez-baker-PtSeouLo --version (for version information)
To browse the documentation
-
octez-baker-PtSeouLo [global options] man (for a list of commands)
-
octez-baker-PtSeouLo [global options] man -v 3 (for the full manual)
Global options (must come before the command)
Access the documentation
-
octez-baker-PtSeouLo man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]Print documen Add se keyword: keyword If seve -v --verbosity <0|1|2|3>: level 0. O --format <plain|colors|html>: the manu Defaults
Commands for editing and viewing the client's config file
-
octez-baker-PtSeouLo config showShow
-
octez-baker-PtSeouLo config resetReset
-
octez-baker-PtSeouLo config updateUpdate Loads
-
octez-baker-PtSeouLo config init [-o --output <path>] [--bootstrap-accounts <path>] [--protocol-constants <path>]Create If -o --output <path>: path Defaults `$HOME/.tezos-cli --bootstrap-accounts <path>: path Defaults `$HOME/.tezos-client/bootstrap-acc --protocol-constants <path>: path Defaults `$HOME/.tezos-client/protocol-cons
Commands related to the baker daemon.
-
octez-baker-PtSeouLo run with local node node_data_path [baker...] [-P --pidfile <filename>] [--node-version-check-bypass] [--node-version-allowed <<product>-[v]<major>.<minor>[.0]<info>[:<commit>]>] [--minimal-fees <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--minimal-nanotez-per-byte <amount>] [--force-apply-from-round <round>] [-K --keep-alive] [--liquidity-baking-toggle-vote <vote>] [--adaptive-issuance-vote <vote>] [-V --votefile <filename>] [--operations-pool <file|uri>] [--dal-node <uri>] [--without-dal] [--record-state] [--pre-emptive-forge-time <seconds>] [--remote-calls-timeout <seconds>] [--allow-signing-delay]Launch node_data_path: Path baker: name Can -P --pidfile <filename>: write p --node-version-check-bypass: If node-version-check-byp --node-version-allowed <<product>-[v]<major>.<minor>[.0]<info>[:<commit>]>: When spec --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --force-apply-from-round <round>: Force -K --keep-alive: Keep --liquidity-baking-toggle-vote <vote>: Vote --adaptive-issuance-vote <vote>: Vote -V --votefile <filename>: read --operations-pool <file|uri>: When speci --dal-node <uri>: endpoint --without-dal: If without- --record-state: If record-st --pre-emptive-forge-time <seconds>: Sets pr --remote-calls-timeout <seconds>: Sets --allow-signing-delay: Allow
-
octez-baker-PtSeouLo run remotely [baker...] [-P --pidfile <filename>] [--node-version-check-bypass] [--node-version-allowed <<product>-[v]<major>.<minor>[.0]<info>[:<commit>]>] [--minimal-fees <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--minimal-nanotez-per-byte <amount>] [--force-apply-from-round <round>] [-K --keep-alive] [--liquidity-baking-toggle-vote <vote>] [--adaptive-issuance-vote <vote>] [-V --votefile <filename>] [--operations-pool <file|uri>] [--dal-node <uri>] [--without-dal] [--record-state] [--pre-emptive-forge-time <seconds>] [--remote-calls-timeout <seconds>] [--allow-signing-delay]Launch baker: name Can -P --pidfile <filename>: write p --node-version-check-bypass: If node-version-check-byp --node-version-allowed <<product>-[v]<major>.<minor>[.0]<info>[:<commit>]>: When spec --minimal-fees <amount>: exclude op Defaults --minimal-nanotez-per-gas-unit <amount>: exclude op Defaults --minimal-nanotez-per-byte <amount>: exclude op Defaults --force-apply-from-round <round>: Force -K --keep-alive: Keep --liquidity-baking-toggle-vote <vote>: Vote --adaptive-issuance-vote <vote>: Vote -V --votefile <filename>: read --operations-pool <file|uri>: When speci --dal-node <uri>: endpoint --without-dal: If without- --record-state: If record-st --pre-emptive-forge-time <seconds>: Sets pr --remote-calls-timeout <seconds>: Sets --allow-signing-delay: Allow
-
octez-baker-PtSeouLo run vdf [-P --pidfile <filename>] [-K --keep-alive]Launch -P --pidfile <filename>: write p -K --keep-alive: Keep
Miscellaneous commands
-
octez-baker-PtSeouLo list understood protocolsList
Accuser manual#
This is the manual page of the accuser command line tool. See Accuser for a general description of this tool.
Usage
-
octez-accuser-PtSeouLo [global options] command [command options]
-
octez-accuser-PtSeouLo --help (for global options)
-
octez-accuser-PtSeouLo [global options] command --help (for command options)
-
octez-accuser-PtSeouLo --version (for version information)
To browse the documentation
-
octez-accuser-PtSeouLo [global options] man (for a list of commands)
-
octez-accuser-PtSeouLo [global options] man -v 3 (for the full manual)
Global options (must come before the command)
Access the documentation
-
octez-accuser-PtSeouLo man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]Print documen Add se keyword: keyword If seve -v --verbosity <0|1|2|3>: level 0. O --format <plain|colors|html>: the manu Defaults
Commands for editing and viewing the client's config file
-
octez-accuser-PtSeouLo config showShow
-
octez-accuser-PtSeouLo config resetReset
-
octez-accuser-PtSeouLo config updateUpdate Loads
-
octez-accuser-PtSeouLo config init [-o --output <path>] [--bootstrap-accounts <path>] [--protocol-constants <path>]Create If -o --output <path>: path Defaults `$HOME/.tezos-cli --bootstrap-accounts <path>: path Defaults `$HOME/.tezos-client/bootstrap-acc --protocol-constants <path>: path Defaults `$HOME/.tezos-client/protocol-cons
Commands related to the accuser daemon.
-
octez-accuser-PtSeouLo run [-P --pidfile <filename>] [--preserved-levels <threshold>] [-K --keep-alive]Launch -P --pidfile <filename>: write p --preserved-levels <threshold>: Number Defaults -K --keep-alive: Keep
Miscellaneous commands
-
octez-accuser-PtSeouLo list understood protocolsList
Protocol-independent tools#
For manuals of the tools that do not vary with each protocol, see here.