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:

octez-admin-client man -verbosity 3

Note

The rest of this page documents the protocol-independent tools, whose features do not vary with each protocol. The protocol-dependent tools are documented here.

Admin-client manual#

This is the manual page of the command line tool octez-admin-client. See Admin Client for a general description of this tool.

Usage

octez-admin-client [global options] command [command options]
octez-admin-client --help (for global options)
octez-admin-client [global options] command --help (for command options)
octez-admin-client --version (for version information)

To browse the documentation

octez-admin-client [global options] man (for a list of commands)
octez-admin-client [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: client T dir -n --no-base-dir-warnings: silence -c --config-file <path>: configuration -t --timings: show --chain <hash|tag>: chain Defaults -b --block <hash|level|tag>: block Defaults -w --wait <none|<int>>: how con -p --protocol <hash>: use comm -l --log-requests: log --better-errors: Error rep -A --addr <IP addr|host>: [DEPRECATED: -P --port <number>: [DEPRECATED: -S --tls: [DEPRECATED: -m --media-type <json, binary, any or default>: Sets "me -E --endpoint <uri>: HTTP(S) -s --sources <path>: path -R --remote-signer <uri>: URI -f --password-filename <filename>: path -M --mode <client|light|mockup|proxy>: how i Defaults --log-coloring <true|false>: Enable --allow-fixed-random-seed: Allow

Access the documentation

octez-admin-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-admin-client
config show

Show
octez-admin-client
config reset

Reset
octez-admin-client
config update

Update Loads
octez-admin-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 to report the node's status

octez-admin-client
list heads [-o --output <path>]

The -o --output <path>: write Defaults
octez-admin-client
list rejected blocks [-o --output <path>]

The bl -o --output <path>: write Defaults

Commands to perform privileged operations on the node

octez-admin-client
unmark invalid [block...]

Make block: blocks
octez-admin-client
unmark all invalid blocks

Make
octez-admin-client
show current checkpoint

Retrieve
octez-admin-client
ban operation operation

Remove operation: hash o
octez-admin-client
unban operation operation

Remove operation: hash o
octez-admin-client
unban all operations

Clear

Commands for monitoring and controlling p2p-layer state

octez-admin-client
p2p stat [--no-color]

show g --no-color: Don't co
octez-admin-client
connect address address

Connect address: <IPv4>:PORT
octez-admin-client
kick peer peer

Kick peer: peer ne
octez-admin-client
ban address address

Add address: <IPv4>:PORT
octez-admin-client
unban address address

Remove address: <IPv4>:PORT
octez-admin-client
trust address address

Add address: <IPv4>:PORT
octez-admin-client
untrust address address

Removes address: <IPv4>:PORT
octez-admin-client
is address banned address

Check address: <IPv4>:PORT
octez-admin-client
is peer banned peer

Check peer: peer ne
octez-admin-client
ban peer peer

Add peer: peer ne
octez-admin-client
unban peer peer

Removes peer: peer ne
octez-admin-client
trust peer peer

Add peer: peer ne
octez-admin-client
untrust peer peer

Remove peer: peer ne
octez-admin-client
clear acls

Clear

Commands for managing protocols

octez-admin-client
list protocols

List prot
octez-admin-client
inject protocol dir

Inject dir: directory
octez-admin-client
dump protocol protocol hash

Dump p protocol hash:
octez-admin-client
protocol environment protocol hash

Show en protocol hash:
octez-admin-client
fetch protocol protocol hash

Fetch protocol hash:

Commands for the low level RPC layer

octez-admin-client
rpc list url

List Some url: the
octez-admin-client
rpc list

Alias
octez-admin-client
rpc schema HTTP method url

Get HTTP method: url: the
octez-admin-client
rpc format HTTP method url [-b --binary]

Get HTTP method: url: the -b --binary: Binary
octez-admin-client
rpc get url

Call url: the
octez-admin-client
rpc post url

Call It invo url: the
octez-admin-client
rpc post url with input

Call url: the input: the For insta
octez-admin-client
rpc patch url

Call It invo url: the
octez-admin-client
rpc patch url with input

Call url: the input: the For insta
octez-admin-client
rpc put url

Call It invo url: the
octez-admin-client
rpc put url with input

Call url: the input: the For insta
octez-admin-client
rpc delete url

Call url: the

Commands to inspect the event-logging framework

octez-admin-client
query events from Sink-Name [--names <LIST>] [--sections <LIST>] [--since <DATE>] [--until <DATE>] [--as-json] [--dump-unknown] [--for-script <FORMAT>]

Query Sink-Name: The --names <LIST>: Filter --sections <LIST>: Filter --since <DATE>: Filter --until <DATE>: Filter --as-json: Display --dump-unknown: Try --for-script <FORMAT>: Make
octez-admin-client
show event-logging

Display configurati
octez-admin-client
output schema of Event-Name to File-path

Output Event-Name: Name File-path: Path

Miscellaneous commands

octez-admin-client
list understood protocols

List

Signer manual#

This is the manual page of the command line tool octez-signer. See Signer for a general description of this tool.

Usage

octez-signer [global options] command [command options]
octez-signer --help (for global options)
octez-signer [global options] command --help (for command options)
octez-signer --version (for version information)

To browse the documentation

octez-signer [global options] man (for a list of commands)
octez-signer [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: signer The direc -A --require-authentication: Require -f --password-filename <filename>: path

Access the documentation

octez-signer
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 managing the connected Ledger Nano devices

octez-signer
list connected ledgers

List supp
octez-signer
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-signer
get ledger authorized path for account-alias-or-ledger-uri

Query account-alias-or-ledger-uri: An impor
octez-signer
authorize ledger to bake for account-alias-or-ledger-uri

Authorize account-alias-or-ledger-uri: An impor
octez-signer
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-signer
deauthorize ledger baking for account-alias-or-ledger-uri

Deauthorize account-alias-or-ledger-uri: An impor
octez-signer
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-signer
set ledger high water mark for account-alias-or-ledger-uri to high watermark

Set account-alias-or-ledger-uri: An impor high watermark: High wate
octez-signer
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-signer
set ledger high watermark for account-alias-or-ledger-uri to high watermark

Set account-alias-or-ledger-uri: An impor high watermark: High wate

Commands for managing the wallet of cryptographic keys

octez-signer
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-signer
list signing schemes

List supp Signing
octez-signer
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-signer
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-signer
encrypt secret key

Encrypt
octez-signer
import secret key new uri [-f --force]

Add new: new secret uri: secret Varies -f --force: overwrite
octez-signer
import public key new uri [-f --force]

Add new: new public uri: public Varies -f --force: overwrite
octez-signer
add address new src [-f --force]

Add new: new pu src: source Can -f --force: overwrite
octez-signer
list known addresses

List
octez-signer
list known remote keys uri

List uri: remote Varies
octez-signer
show address name [-S --show-secret]

Show name: existing -S --show-secret: show
octez-signer
forget address name [-f --force]

Forget name: existing -f --force: delete ass
octez-signer
forget all keys [-f --force]

Forget -f --force: you
octez-signer
generate nonce for name from data

Compute deter name: existing data: string
octez-signer
generate nonce hash for name from data

Compute deter name: existing data: string
octez-signer
import keys from mnemonic new [-f --force] [--encrypt]

Import new: new secret -f --force: overwrite --encrypt: encrypt

Commands specific to the signing daemon

octez-signer
launch socket signer [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [--allow-list-known-keys] [--allow-to-prove-possession] [-a --address <host|address>] [-p --port <port number>] [-t --timeout <timeout>]

Launch -P --pidfile <filename>: write p -M --magic-bytes <0xHH,0xHH,...>: values -W --check-high-watermark: high wate Stores --allow-list-known-keys: allow --allow-to-prove-possession: allow -a --address <host|address>: listening Defaults -p --port <port number>: listening Defaults -t --timeout <timeout>: timeout Defaults
octez-signer
launch local signer [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [--allow-list-known-keys] [--allow-to-prove-possession] [-s --socket <path>]

Launch -P --pidfile <filename>: write p -M --magic-bytes <0xHH,0xHH,...>: values -W --check-high-watermark: high wate Stores --allow-list-known-keys: allow --allow-to-prove-possession: allow -s --socket <path>: path Defaults `$HOME/.tezos-sig
octez-signer
launch http signer [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [--allow-list-known-keys] [--allow-to-prove-possession] [-a --address <host|address>] [-p --port <port number>]

Launch -P --pidfile <filename>: write p -M --magic-bytes <0xHH,0xHH,...>: values -W --check-high-watermark: high wate Stores --allow-list-known-keys: allow --allow-to-prove-possession: allow -a --address <host|address>: listening Defaults -p --port <port number>: listening Defaults
octez-signer
launch https signer cert key [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [--allow-list-known-keys] [--allow-to-prove-possession] [-a --address <host|address>] [-p --port <port number>]

Launch cert: path key: path -P --pidfile <filename>: write p -M --magic-bytes <0xHH,0xHH,...>: values -W --check-high-watermark: high wate Stores --allow-list-known-keys: allow --allow-to-prove-possession: allow -a --address <host|address>: listening Defaults -p --port <port number>: listening Defaults
octez-signer
add authorized key pk [-N --name <name>]

Authorize pk: full p -N --name <name>: an optio

Node manual#

The command line of the Octez node is documented in Unix man format, as shown below. You can also obtain this manual by running octez-node --help.

The manual briefly shows the available node commands. Each command accepts its own set of options and arguments, that you can discover by running octez-node <command> --help. For more details on the node invocation and configuration, see Node Configuration.

NAME

octez-node - The Octez node

SYNOPSIS

octez-node [COMMAND] …

DESCRIPTION

Entry point for initializing, configuring and running a Tezos node.

The identity command is meant to create and manage node identities. An identity uniquely identifies a peer on the network and consists of a cryptographic key pair as well as a proof-of-work stamp that certifies that enough CPU time has been dedicated to produce the identity, to avoid sybil attacks. An identity with enough proof-of-work is required to participate in the Tezos network, therefore this command is necessary to launch Tezos the first time.

The run command is meant to run the Tezos node. Most of its command line arguments corresponds to config file entries, and will have priority over the latter if used.

The replay command is meant to replay a previously validated block for debugging purposes.

The config command is meant to inspect and amend the configuration of the Tezos node. This command is complementary to manually editing the tezos node configuration file. Its arguments are a subset of the run command ones.

The upgrade command is meant to manage upgrades of the node.

The snapshot command is meant to export and import snapshots files.

The reconstruct command is meant to reconstruct the partial storage of a node running in full mode in order to recover a complete archive mode storage.

The storage command provides tools for introspecting and debugging the storage layer.

COMMANDS

config COMMAND …: Manage node configuration
dump-metrics [OPTION]…: Show all the openmetrics collected by the Tezos node
identity COMMAND …: Manage node identities
map-port [OPTION]…: Experimental
reconstruct [OPTION]…: Manage storage reconstruction
replay [--repeat=VAL] [--strict] [OPTION]… [<level>|<block_hash>|<alias>]…: Replay a set of previously validated blocks
run [OPTION]…: Run the Tezos node
snapshot COMMAND …: Manage snapshots
storage COMMAND …: Query the storage layer (EXPERIMENTAL)
upgrade [--status] [OPTION]… UPGRADE: Manage node upgrades

COMMON OPTIONS

--help[=FMT] (default=auto): Show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined.
--version: Show version information.

EXIT STATUS

octez-node exits with:

0 on success.

123 on indiscriminate errors reported on standard error.

124 on command line parsing errors.

125 on unexpected internal errors (bugs).

EXAMPLES

Run in sandbox mode listening to RPC commands at localhost port 8732: octez-node run --sandbox=src/proto_alpha/parameters/sandbox-parameters.json --data-dir /custom/data/dir --rpc-addr localhost:8732
Run a node that accepts network connections: octez-node run

DAL node manual#

The command line of the Octez DAL node is documented in Unix man format, as shown below. You can also obtain this manual by running octez-dal-node --help.

The manual briefly shows the available DAL node commands. Each command accepts its own set of options and arguments, that you can discover by running octez-dal-node <command> --help.

NAME

octez-dal-node - The Octez DAL node

SYNOPSIS

octez-dal-node [COMMAND] …

COMMANDS

config [COMMAND] …: Manage the Octez DAL node configuration
debug [COMMAND] …: Debug commands
run [OPTION]…: Run the Octez DAL node

COMMON OPTIONS

--help[=FMT] (default=auto): Show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined.
--version: Show version information.

EXIT STATUS

octez-dal-node exits with:

0 on success.

123 on indiscriminate errors reported on standard error.

124 on command line parsing errors.

125 on unexpected internal errors (bugs).

Smart rollup node manual#

This is the manual page of the Smart rollup node.

Usage

octez-smart-rollup-node [global options] command [command options]
octez-smart-rollup-node --help (for global options)
octez-smart-rollup-node [global options] command --help (for command options)
octez-smart-rollup-node --version (for version information)

To browse the documentation

octez-smart-rollup-node [global options] man (for a list of commands)
octez-smart-rollup-node [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: client T dir -n --no-base-dir-warnings: silence -t --timings: show -l --log-requests: log --better-errors: Error rep -A --addr <IP addr|host>: [DEPRECATED: -P --port <number>: [DEPRECATED: -S --tls: [DEPRECATED: -E --endpoint <uri>: HTTP(S) -R --remote-signer <uri>: URI -f --password-filename <filename>: path

Access the documentation

octez-smart-rollup-node
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 related to the smart rollup node.

octez-smart-rollup-node
init mode config for smart-rollup-address with operators [operator...] [--force] [--data-dir <data-dir>] [--config-file <config.json>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--acl-override <kind>] [--metrics-addr <ADDR:PORT|:PORT>] [--enable-performance-metrics] [--disable-performance-metrics] [--loser-mode <mode>] [--reconnection-delay <delay>] [--dal-node <dal-node-endpoint>] [--pre-images-endpoint <url>] [--injector-retention-period <blocks>] [--injector-attempts <number>] [--injection-ttl <number>] [--index-buffer-size <<nb_entries>>] [--index-buffer-size <<nb_entries>>] [--log-kernel-debug] [--log-kernel-debug-file <file>] [--boot-sector-file <file>] [--no-degraded] [--gc-frequency <blocks>] [--history-mode <history_mode>] [--cors-origins <ALLOWED_ORIGINS>] [--cors-headers <ALLOWED_HEADERS>] [--bail-on-disagree] [--unsafe-disable-wasm-kernel-checks] [--profiling <BOOL>] [--etherlink]

Configure mode: The - observe smart-rollup-address: The s Can operator: Public operating, --force: Overwrites --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --config-file <config.json>: Location --rpc-addr <rpc-address|ip>: The add --rpc-port <rpc-port>: The --acl-override <kind>: Specify --metrics-addr <ADDR:PORT|:PORT>: Start --enable-performance-metrics: Enable perf --disable-performance-metrics: Disable per --loser-mode <mode>: Set --reconnection-delay <delay>: The f re The ac --dal-node <dal-node-endpoint>: The add --pre-images-endpoint <url>: The add --injector-retention-period <blocks>: The nu --injector-attempts <number>: The nu --injection-ttl <number>: The nu --index-buffer-size <<nb_entries>>: The max --index-buffer-size <<nb_entries>>: The max --log-kernel-debug: Log --log-kernel-debug-file <file>: --boot-sector-file <file>: Path --no-degraded: Prevent --gc-frequency <blocks>: The nu --history-mode <history_mode>: The his --cors-origins <ALLOWED_ORIGINS>: List --cors-headers <ALLOWED_HEADERS>: List --bail-on-disagree: Make --unsafe-disable-wasm-kernel-checks: Allow --profiling <BOOL>: Enable --etherlink: Force
octez-smart-rollup-node
run mode for smart-rollup-address with operators [operator...] [--data-dir <data-dir>] [--config-file <config.json>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--acl-override <kind>] [--etherlink] [--metrics-addr <ADDR:PORT|:PORT>] [--enable-performance-metrics] [--disable-performance-metrics] [--loser-mode <mode>] [--reconnection-delay <delay>] [--dal-node <dal-node-endpoint>] [--pre-images-endpoint <url>] [--injector-retention-period <blocks>] [--injector-attempts <number>] [--injection-ttl <number>] [--index-buffer-size <<nb_entries>>] [--irmin-cache-size <<nb_entries>>] [--log-kernel-debug] [--log-kernel-debug-file <file>] [--boot-sector-file <file>] [--no-degraded] [--gc-frequency <blocks>] [--history-mode <history_mode>] [--cors-origins <ALLOWED_ORIGINS>] [--cors-headers <ALLOWED_HEADERS>] [--apply-unsafe-patches] [--bail-on-disagree] [--unsafe-disable-wasm-kernel-checks] [--profiling <BOOL>]

Run mode: The - observe smart-rollup-address: The s Can operator: Public operating, --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --config-file <config.json>: Location --rpc-addr <rpc-address|ip>: The add --rpc-port <rpc-port>: The --acl-override <kind>: Specify --etherlink: Force --metrics-addr <ADDR:PORT|:PORT>: Start --enable-performance-metrics: Enable perf --disable-performance-metrics: Disable per --loser-mode <mode>: Set --reconnection-delay <delay>: The f re The ac --dal-node <dal-node-endpoint>: The add --pre-images-endpoint <url>: The add --injector-retention-period <blocks>: The nu --injector-attempts <number>: The nu --injection-ttl <number>: The nu --index-buffer-size <<nb_entries>>: The max --irmin-cache-size <<nb_entries>>: Size --log-kernel-debug: Log --log-kernel-debug-file <file>: --boot-sector-file <file>: Path --no-degraded: Prevent --gc-frequency <blocks>: The nu --history-mode <history_mode>: The his --cors-origins <ALLOWED_ORIGINS>: List --cors-headers <ALLOWED_HEADERS>: List --apply-unsafe-patches: Apply --bail-on-disagree: Make --unsafe-disable-wasm-kernel-checks: Allow --profiling <BOOL>: Enable
octez-smart-rollup-node
run [--data-dir <data-dir>] [--config-file <config.json>] [--mode <mode>] [--rollup <smart-rollup-address>] [--etherlink] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--acl-override <kind>] [--metrics-addr <ADDR:PORT|:PORT>] [--enable-performance-metrics] [--disable-performance-metrics] [--loser-mode <mode>] [--reconnection-delay <delay>] [--dal-node <dal-node-endpoint>] [--pre-images-endpoint <url>] [--injector-retention-period <blocks>] [--injector-attempts <number>] [--injection-ttl <number>] [--index-buffer-size <<nb_entries>>] [--index-buffer-size <<nb_entries>>] [--log-kernel-debug] [--log-kernel-debug-file <file>] [--boot-sector-file <file>] [--no-degraded] [--gc-frequency <blocks>] [--history-mode <history_mode>] [--cors-origins <ALLOWED_ORIGINS>] [--cors-headers <ALLOWED_HEADERS>] [--apply-unsafe-patches] [--bail-on-disagree] [--unsafe-disable-wasm-kernel-checks] [--profiling <BOOL>]

Run --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --config-file <config.json>: Location --mode <mode>: The - observe --rollup <smart-rollup-address>: The s --etherlink: Force --rpc-addr <rpc-address|ip>: The add --rpc-port <rpc-port>: The --acl-override <kind>: Specify --metrics-addr <ADDR:PORT|:PORT>: Start --enable-performance-metrics: Enable perf --disable-performance-metrics: Disable per --loser-mode <mode>: Set --reconnection-delay <delay>: The f re The ac --dal-node <dal-node-endpoint>: The add --pre-images-endpoint <url>: The add --injector-retention-period <blocks>: The nu --injector-attempts <number>: The nu --injection-ttl <number>: The nu --index-buffer-size <<nb_entries>>: The max --index-buffer-size <<nb_entries>>: The max --log-kernel-debug: Log --log-kernel-debug-file <file>: --boot-sector-file <file>: Path --no-degraded: Prevent --gc-frequency <blocks>: The nu --history-mode <history_mode>: The his --cors-origins <ALLOWED_ORIGINS>: List --cors-headers <ALLOWED_HEADERS>: List --apply-unsafe-patches: Apply --bail-on-disagree: Make --unsafe-disable-wasm-kernel-checks: Allow --profiling <BOOL>: Enable
octez-smart-rollup-node
show supported protocols

Shows
octez-smart-rollup-node
dump-metrics

dump
octez-smart-rollup-node
dump durable storage into dump.<json|yaml> [--data-dir <data-dir>] [-b --block <hash|level|tag>]

dump durable dump.<json|yaml>: YAML --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r -b --block <hash|level|tag>: block Defaults
octez-smart-rollup-node
patch durable storage at path with value [--data-dir <data-dir>] [-f --force]

Patches path: Durable value: Patched --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r -f --force: Force pa
octez-smart-rollup-node
snapshot export [--data-dir <data-dir>] [--dest <path>] [--no-check] [--compress-on-the-fly] [--uncompressed] [--compact] [--rollup-node-endpoint <uri>]

Export --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --dest <path>: Directory --no-check: Don't --compress-on-the-fly: Produce --uncompressed: Produce u --compact: Produce --rollup-node-endpoint <uri>: The add
octez-smart-rollup-node
snapshot export snapshot_file [--data-dir <data-dir>] [--no-check] [--compress-on-the-fly] [--uncompressed] [--compact] [--rollup-node-endpoint <uri>]

Export snapshot_file: Snapshot --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --no-check: Don't --compress-on-the-fly: Produce --uncompressed: Produce u --compact: Produce --rollup-node-endpoint <uri>: The add
octez-smart-rollup-node
snapshot import snapshot_file_or_url [--data-dir <data-dir>] [--no-check] [--force] [--apply-unsafe-patches]

Import snapshot_file_or_url: Snapshot --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --no-check: Don't --force: Import --apply-unsafe-patches: Apply
octez-smart-rollup-node
snapshot info snapshot_file_or_url

Display inf snapshot_file_or_url: Snapshot
octez-smart-rollup-node
generate openapi [-P --protocol <Proto>]

Generate -P --protocol <Proto>: Protocol
octez-smart-rollup-node
list metrics [--disable-performance-metrics]

List --disable-performance-metrics: Disable per
octez-smart-rollup-node
replay block block_or_level [--data-dir <data-dir>] [--profiling <BOOL>]

Replay block_or_level: An --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --profiling <BOOL>: Enable
octez-smart-rollup-node
replay blocks from level to level [--data-dir <data-dir>] [--profiling <BOOL>]

Replay level: Level level: Level --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r --profiling <BOOL>: Enable

Commands to repair the smart rollup node.

octez-smart-rollup-node
repair commitments for protocol [--data-dir <data-dir>]

Repair comm protocol: Protocol --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r
octez-smart-rollup-node
recompute outbox messages from level [--data-dir <data-dir>]

Recompute level: Level --data-dir <data-dir>: The Defaults `$HOME/.tezos-smart-r

Baker manual#

This is the manual page of the baker command line tool. See Baker for a general description of this tool.

Note

This unique baker executable is meant to replace the protocol-specific bakers for all the protocols it supports, such as octez-baker-PsRiotum and octez-baker-alpha.

Usage

octez-baker [global options] command [command options]
octez-baker --help (for global options)
octez-baker [global options] command --help (for command options)
octez-baker --version (for version information)

To browse the documentation

octez-baker [global options] man (for a list of commands)
octez-baker [global options] man -v 3 (for the full manual)

Global options (must come before the command)

Access the documentation

octez-baker
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
config show

Show
octez-baker
config reset

Reset
octez-baker
config update

Update Loads
octez-baker
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 agnostic baker daemon.

octez-baker
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
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
run vdf [-P --pidfile <filename>] [-K --keep-alive]

Launch -P --pidfile <filename>: write p -K --keep-alive: Keep
octez-baker
run accuser [-P --pidfile <filename>] [--preserved-levels <threshold>] [-K --keep-alive]

Launch -P --pidfile <filename>: write p --preserved-levels <threshold>: Number Defaults -K --keep-alive: Keep

Commands related to the DAL daemon.

octez-baker
run dal [-d --data-dir <DIR>] [--config-file <FILE>] [--rpc-addr <ADDR[:PORT]>] [--expected-pow <FLOAT>] [--net-addr <ADDR[:PORT]>] [--public-addr <ADDR[:PORT]>] [-E --endpoint <URI>] [--slots-backup-uri <URI>] [--trust-slots-backup-uris] [--metrics-addr <ADDR[:PORT]>] [--attester-profiles <PKH1,PKH2,...>] [--operator-profiles <INDEX1,INDEX2,...>] [--observer-profiles <INDEX1,INDEX2,...>] [--bootstrap-profile] [--peers <ADDR:PORT,...>] [--history-mode <VAL>] [--service-name <VAL>] [--service-namespace <VAL>] [--fetch-trusted-setup <true | false>] [--disable-shard-validation] [--verbose] [--ignore-l1-config-peers] [--disable-amplification] [--ignore-topics <PKH1,PKH2,...>]

Run -d --data-dir <DIR>: The direc --config-file <FILE>: The configura --rpc-addr <ADDR[:PORT]>: The --expected-pow <FLOAT>: The expe --net-addr <ADDR[:PORT]>: The --public-addr <ADDR[:PORT]>: The -E --endpoint <URI>: The endp --slots-backup-uri <URI>: List --trust-slots-backup-uris: If s --metrics-addr <ADDR[:PORT]>: The --attester-profiles <PKH1,PKH2,...>: The O --operator-profiles <INDEX1,INDEX2,...>: The O --observer-profiles <INDEX1,INDEX2,...>: The O --bootstrap-profile: The O --peers <ADDR:PORT,...>: An additio --history-mode <VAL>: The dura --service-name <VAL>: A na If s --service-namespace <VAL>: A namespa If s --fetch-trusted-setup <true | false>: Should --disable-shard-validation: Disable --verbose: Controls --ignore-l1-config-peers: Ignore --disable-amplification: Disables --ignore-topics <PKH1,PKH2,...>: The prod
octez-baker
config dal init [-d --data-dir <DIR>] [--config-file <FILE>] [--rpc-addr <ADDR[:PORT]>] [--expected-pow <FLOAT>] [--net-addr <ADDR[:PORT]>] [--public-addr <ADDR[:PORT]>] [-E --endpoint <URI>] [--slots-backup-uri <URI>] [--trust-slots-backup-uris] [--metrics-addr <ADDR[:PORT]>] [--attester-profiles <PKH1,PKH2,...>] [--operator-profiles <INDEX1,INDEX2,...>] [--observer-profiles <INDEX1,INDEX2,...>] [--bootstrap-profile] [--peers <ADDR:PORT,...>] [--history-mode <VAL>] [--service-name <VAL>] [--service-namespace <VAL>] [--fetch-trusted-setup <true | false>] [--disable-shard-validation] [--verbose] [--ignore-l1-config-peers] [--disable-amplification] [--ignore-topics <PKH1,PKH2,...>]

This co -d --data-dir <DIR>: The direc --config-file <FILE>: The configura --rpc-addr <ADDR[:PORT]>: The --expected-pow <FLOAT>: The expe --net-addr <ADDR[:PORT]>: The --public-addr <ADDR[:PORT]>: The -E --endpoint <URI>: The endp --slots-backup-uri <URI>: List --trust-slots-backup-uris: If s --metrics-addr <ADDR[:PORT]>: The --attester-profiles <PKH1,PKH2,...>: The O --operator-profiles <INDEX1,INDEX2,...>: The O --observer-profiles <INDEX1,INDEX2,...>: The O --bootstrap-profile: The O --peers <ADDR:PORT,...>: An additio --history-mode <VAL>: The dura --service-name <VAL>: A na If s --service-namespace <VAL>: A namespa If s --fetch-trusted-setup <true | false>: Should --disable-shard-validation: Disable --verbose: Controls --ignore-l1-config-peers: Ignore --disable-amplification: Disables --ignore-topics <PKH1,PKH2,...>: The prod
octez-baker
config dal update [-d --data-dir <DIR>] [--config-file <FILE>] [--rpc-addr <ADDR[:PORT]>] [--expected-pow <FLOAT>] [--net-addr <ADDR[:PORT]>] [--public-addr <ADDR[:PORT]>] [-E --endpoint <URI>] [--slots-backup-uri <URI>] [--trust-slots-backup-uris] [--metrics-addr <ADDR[:PORT]>] [--attester-profiles <PKH1,PKH2,...>] [--operator-profiles <INDEX1,INDEX2,...>] [--observer-profiles <INDEX1,INDEX2,...>] [--bootstrap-profile] [--peers <ADDR:PORT,...>] [--history-mode <VAL>] [--service-name <VAL>] [--service-namespace <VAL>] [--fetch-trusted-setup <true | false>] [--disable-shard-validation] [--verbose] [--ignore-l1-config-peers] [--disable-amplification] [--ignore-topics <PKH1,PKH2,...>]

This co -d --data-dir <DIR>: The direc --config-file <FILE>: The configura --rpc-addr <ADDR[:PORT]>: The --expected-pow <FLOAT>: The expe --net-addr <ADDR[:PORT]>: The --public-addr <ADDR[:PORT]>: The -E --endpoint <URI>: The endp --slots-backup-uri <URI>: List --trust-slots-backup-uris: If s --metrics-addr <ADDR[:PORT]>: The --attester-profiles <PKH1,PKH2,...>: The O --operator-profiles <INDEX1,INDEX2,...>: The O --observer-profiles <INDEX1,INDEX2,...>: The O --bootstrap-profile: The O --peers <ADDR:PORT,...>: An additio --history-mode <VAL>: The dura --service-name <VAL>: A na If s --service-namespace <VAL>: A namespa If s --fetch-trusted-setup <true | false>: Should --disable-shard-validation: Disable --verbose: Controls --ignore-l1-config-peers: Ignore --disable-amplification: Disables --ignore-topics <PKH1,PKH2,...>: The prod
octez-baker
debug dal print store schemas [-d --data-dir <DIR>] [--config-file <FILE>] [--rpc-addr <ADDR[:PORT]>] [--expected-pow <FLOAT>] [--net-addr <ADDR[:PORT]>] [--public-addr <ADDR[:PORT]>] [-E --endpoint <URI>] [--slots-backup-uri <URI>] [--trust-slots-backup-uris] [--metrics-addr <ADDR[:PORT]>] [--attester-profiles <PKH1,PKH2,...>] [--operator-profiles <INDEX1,INDEX2,...>] [--observer-profiles <INDEX1,INDEX2,...>] [--bootstrap-profile] [--peers <ADDR:PORT,...>] [--history-mode <VAL>] [--service-name <VAL>] [--service-namespace <VAL>] [--fetch-trusted-setup <true | false>] [--disable-shard-validation] [--verbose] [--ignore-l1-config-peers] [--disable-amplification] [--ignore-topics <PKH1,PKH2,...>]

Print -d --data-dir <DIR>: The direc --config-file <FILE>: The configura --rpc-addr <ADDR[:PORT]>: The --expected-pow <FLOAT>: The expe --net-addr <ADDR[:PORT]>: The --public-addr <ADDR[:PORT]>: The -E --endpoint <URI>: The endp --slots-backup-uri <URI>: List --trust-slots-backup-uris: If s --metrics-addr <ADDR[:PORT]>: The --attester-profiles <PKH1,PKH2,...>: The O --operator-profiles <INDEX1,INDEX2,...>: The O --observer-profiles <INDEX1,INDEX2,...>: The O --bootstrap-profile: The O --peers <ADDR:PORT,...>: An additio --history-mode <VAL>: The dura --service-name <VAL>: A na If s --service-namespace <VAL>: A namespa If s --fetch-trusted-setup <true | false>: Should --disable-shard-validation: Disable --verbose: Controls --ignore-l1-config-peers: Ignore --disable-amplification: Disables --ignore-topics <PKH1,PKH2,...>: The prod

Miscellaneous commands

octez-baker
list understood protocols

List

Accuser manual#

This is the manual page of the accuser command line tool. See Accuser for a general description of this tool.

Note

This unique accuser executable is meant to replace the protocol-specific accusers for all the protocols it supports, such as octez-accuser-PsRiotum and octez-accuser-alpha.

Usage

octez-accuser [global options] command [command options]
octez-accuser --help (for global options)
octez-accuser [global options] command --help (for command options)
octez-accuser --version (for version information)

To browse the documentation

octez-accuser [global options] man (for a list of commands)
octez-accuser [global options] man -v 3 (for the full manual)

Global options (must come before the command)

Access the documentation

octez-accuser
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
config show

Show
octez-accuser
config reset

Reset
octez-accuser
config update

Update Loads
octez-accuser
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 agnostic accuser daemon.

octez-accuser
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
list understood protocols

List

Benchmark tool manual#

This is the manual page of the command line tool octez-snoop. See Benchmarking with Snoop for a general description of this tool.

Codec manual#

This is the manual page of the command line tool octez-codec. See Codec for a general description of this tool.

Usage

octez-codec [global options] command [command options]
octez-codec --help (for global options)
octez-codec [global options] command --help (for command options)
octez-codec --version (for version information)

To browse the documentation

octez-codec [global options] man (for a list of commands)
octez-codec [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: data dire The direc

Access the documentation

octez-codec
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 to handle encodings

octez-codec
list encodings

List r
octez-codec
dump encodings [--compact]

Dump --compact: Output
octez-codec
dump encoding id [--compact]

Dump id: Encoding i --compact: Output
octez-codec
encode id from data

Encode id: Encoding i data: JSON
octez-codec
decode id from data

Decode id: Encoding i data: Hex-encoded bi
octez-codec
display id from binary data

Display id: Encoding i data: Hex-encoded bi
octez-codec
display id from json data

Display id: Encoding i data: JSON
octez-codec
describe id binary schema

Describe id: Encoding i
octez-codec
describe id json schema

Describe id: Encoding i
octez-codec
slice data

Attempts data: Hex-encoded bi
octez-codec
slice data with encoding id [--format <FORMAT>]

Slice he data: Hex-encoded bi id: Encoding i --format <FORMAT>: The fo Defaults

Protocol-dependent tools#

For manuals of the tools that may vary with each protocol, see here.

Command Line Interface

Contents

Command Line Interface#

Admin-client manual#

Usage

To browse the documentation

Global options (must come before the command)

Access the documentation

Commands for editing and viewing the client's config file

Commands to report the node's status

Commands to perform privileged operations on the node

Commands for monitoring and controlling p2p-layer state

Commands for managing protocols

Commands for the low level RPC layer

Commands to inspect the event-logging framework

Miscellaneous commands

Signer manual#

Usage

To browse the documentation

Global options (must come before the command)

Access the documentation

Commands for managing the connected Ledger Nano devices

Commands for managing the wallet of cryptographic keys

Commands specific to the signing daemon

Node manual#

DAL node manual#

Smart rollup node manual#

Usage

To browse the documentation

Global options (must come before the command)

Access the documentation

Commands related to the smart rollup node.

Commands to repair the smart rollup node.

Baker manual#

Usage

To browse the documentation

Global options (must come before the command)

Access the documentation

Commands for editing and viewing the client's config file

Commands related to the agnostic baker daemon.

Commands related to the DAL daemon.

Miscellaneous commands

Accuser manual#

Usage

To browse the documentation

Global options (must come before the command)

Access the documentation

Commands for editing and viewing the client's config file

Commands related to the agnostic accuser daemon.

Miscellaneous commands

Benchmark tool manual#

Codec manual#

Usage

To browse the documentation

Global options (must come before the command)

Access the documentation

Commands to handle encodings

Protocol-dependent tools#