# CLI Reference This document contains the help content for the `icp` command-line program. **Command Overview:** * [`icp`↴](#icp) * [`icp build`↴](#icp-build) * [`icp canister`↴](#icp-canister) * [`icp canister call`↴](#icp-canister-call) * [`icp canister create`↴](#icp-canister-create) * [`icp canister delete`↴](#icp-canister-delete) * [`icp canister install`↴](#icp-canister-install) * [`icp canister list`↴](#icp-canister-list) * [`icp canister logs`↴](#icp-canister-logs) * [`icp canister metadata`↴](#icp-canister-metadata) * [`icp canister migrate-id`↴](#icp-canister-migrate-id) * [`icp canister settings`↴](#icp-canister-settings) * [`icp canister settings show`↴](#icp-canister-settings-show) * [`icp canister settings update`↴](#icp-canister-settings-update) * [`icp canister settings sync`↴](#icp-canister-settings-sync) * [`icp canister snapshot`↴](#icp-canister-snapshot) * [`icp canister snapshot create`↴](#icp-canister-snapshot-create) * [`icp canister snapshot delete`↴](#icp-canister-snapshot-delete) * [`icp canister snapshot download`↴](#icp-canister-snapshot-download) * [`icp canister snapshot list`↴](#icp-canister-snapshot-list) * [`icp canister snapshot restore`↴](#icp-canister-snapshot-restore) * [`icp canister snapshot upload`↴](#icp-canister-snapshot-upload) * [`icp canister start`↴](#icp-canister-start) * [`icp canister status`↴](#icp-canister-status) * [`icp canister stop`↴](#icp-canister-stop) * [`icp canister top-up`↴](#icp-canister-top-up) * [`icp cycles`↴](#icp-cycles) * [`icp cycles balance`↴](#icp-cycles-balance) * [`icp cycles mint`↴](#icp-cycles-mint) * [`icp cycles transfer`↴](#icp-cycles-transfer) * [`icp deploy`↴](#icp-deploy) * [`icp environment`↴](#icp-environment) * [`icp environment list`↴](#icp-environment-list) * [`icp identity`↴](#icp-identity) * [`icp identity account-id`↴](#icp-identity-account-id) * [`icp identity default`↴](#icp-identity-default) * [`icp identity delegation`↴](#icp-identity-delegation) * [`icp identity delegation request`↴](#icp-identity-delegation-request) * [`icp identity delegation sign`↴](#icp-identity-delegation-sign) * [`icp identity delegation use`↴](#icp-identity-delegation-use) * [`icp identity delete`↴](#icp-identity-delete) * [`icp identity export`↴](#icp-identity-export) * [`icp identity import`↴](#icp-identity-import) * [`icp identity link`↴](#icp-identity-link) * [`icp identity link hsm`↴](#icp-identity-link-hsm) * [`icp identity link web`↴](#icp-identity-link-web) * [`icp identity list`↴](#icp-identity-list) * [`icp identity new`↴](#icp-identity-new) * [`icp identity principal`↴](#icp-identity-principal) * [`icp identity reauth`↴](#icp-identity-reauth) * [`icp identity rename`↴](#icp-identity-rename) * [`icp network`↴](#icp-network) * [`icp network list`↴](#icp-network-list) * [`icp network ping`↴](#icp-network-ping) * [`icp network start`↴](#icp-network-start) * [`icp network status`↴](#icp-network-status) * [`icp network stop`↴](#icp-network-stop) * [`icp network update`↴](#icp-network-update) * [`icp new`↴](#icp-new) * [`icp project`↴](#icp-project) * [`icp project show`↴](#icp-project-show) * [`icp settings`↴](#icp-settings) * [`icp settings autocontainerize`↴](#icp-settings-autocontainerize) * [`icp settings telemetry`↴](#icp-settings-telemetry) * [`icp settings update-check`↴](#icp-settings-update-check) * [`icp settings session-length`↴](#icp-settings-session-length) * [`icp sync`↴](#icp-sync) * [`icp token`↴](#icp-token) * [`icp token balance`↴](#icp-token-balance) * [`icp token transfer`↴](#icp-token-transfer) ## `icp` **Usage:** `icp [OPTIONS] [COMMAND]` ###### **Subcommands:** * `build` — Build canisters * `canister` — Perform canister operations against a network * `cycles` — Mint and manage cycles * `deploy` — Deploy a project to an environment * `environment` — Show information about the current project environments * `identity` — Manage your identities * `network` — Launch and manage local test networks * `new` — Create a new ICP project from a template * `project` — Manage the current project * `settings` — Configure user settings * `sync` — Synchronize canisters * `token` — Perform token transactions ###### **Options:** * `--project-root-override ` — Directory to use as your project root directory. If not specified the directory structure is traversed up until an icp.yaml file is found * `--debug` — Enable debug logging Default value: `false` * `--identity-password-file ` — Read identity password from a file instead of prompting ## `icp build` Build canisters **Usage:** `icp build [OPTIONS] [CANISTERS]...` ###### **Arguments:** * `` — Canister names (if empty, build all canisters in environment) ###### **Options:** * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used ## `icp canister` Perform canister operations against a network **Usage:** `icp canister ` ###### **Subcommands:** * `call` — Make a canister call * `create` — Create a canister on a network * `delete` — Delete a canister from a network * `install` — Install a built WASM to a canister on a network * `list` — List the canisters in an environment * `logs` — Fetch and display canister logs * `metadata` — Read a metadata section from a canister * `migrate-id` — Migrate a canister ID from one subnet to another * `settings` — Commands to manage canister settings * `snapshot` — Commands to manage canister snapshots * `start` — Start a canister on a network * `status` — Show the status of canister(s) * `stop` — Stop a canister on a network * `top-up` — Top up a canister with cycles ## `icp canister call` Make a canister call **Usage:** `icp canister call [OPTIONS] [METHOD] [ARGS]` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified * `` — Name of canister method to call into. If not provided, an interactive prompt will be launched * `` — Call arguments, interpreted per `--args-format` (Candid by default). If not provided, an interactive prompt will be launched ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--args-file ` — Path to a file containing call arguments * `--args-format ` — Format of the call arguments Default value: `candid` Possible values: - `hex`: Hex-encoded bytes - `candid`: Candid text format - `bin`: Raw binary (only valid for file references) * `--candid ` — Path to a Candid (`.did`) file describing the canister's interface. When set, this interface is used to assist method selection, build arguments, and decode the response, instead of fetching the canister's Candid interface from the network. * `--proxy ` — Principal of a proxy canister to route the call through. When specified, instead of calling the target canister directly, the call will be sent to the proxy canister's `proxy` method, which forwards it to the target canister. * `--cycles ` — Cycles to forward with the proxied call. Only used when --proxy is specified. Defaults to 0. Default value: `0` * `--query` — Sends a query request to a canister instead of an update request. Query calls are faster but return uncertified responses. Cannot be used with --proxy (proxy calls are always update calls). * `-o`, `--output ` — How to interpret and display the response Default value: `auto` Possible values: - `auto`: Try Candid, then UTF-8, then fall back to hex - `candid`: Parse as Candid and pretty-print; error if parsing fails - `text`: Parse as UTF-8 text; error if invalid - `hex`: Print raw response as hex * `--json` — Output command results as JSON ## `icp canister create` Create a canister on a network **Usage:** `icp canister create [OPTIONS] ` This command can be used to create canisters defined in a project or a "detached" canister on a network. Examples: # Create on a network by url icp canister create -n http://localhost:8000 -k $ROOT_KEY --detached # Create on mainnet outside of a project context icp canister create -n ic --detached # Create a detached canister inside the scope of a project icp canister create -n mynetwork --detached ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--controller ` — One or more controllers for the canister. Repeat `--controller` to specify multiple * `--compute-allocation ` — Optional compute allocation (0 to 100). Represents guaranteed compute capacity * `--memory-allocation ` — Optional memory allocation in bytes. If unset, memory is allocated dynamically. Supports suffixes: kb, kib, mb, mib, gb, gib (e.g. "4gib" or "2.5kb") * `--freezing-threshold ` — Optional freezing threshold. Controls how long a canister can be inactive before being frozen. Supports duration suffixes: s (seconds), m (minutes), h (hours), d (days), w (weeks). A bare number is treated as seconds * `--reserved-cycles-limit ` — Optional upper limit on cycles reserved for future resource payments. Memory allocations that would push the reserved balance above this limit will fail. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) * `-q`, `--quiet` — Suppress human-readable output; print only canister IDs, one per line, to stdout * `--cycles ` — Cycles to fund canister creation. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) Default value: `2000000000000` * `--subnet ` — The subnet to create canisters on * `--proxy ` — Principal of a proxy canister to route the create_canister call through. When specified, the canister will be created on the same subnet as the proxy canister by forwarding the management canister call through the proxy's `proxy` method. * `--detached` — Create a canister detached from any project configuration. The canister id will be printed out but not recorded in the project configuration. Not valid if `Canister` is provided * `--json` — Output command results as JSON ## `icp canister delete` Delete a canister from a network **Usage:** `icp canister delete [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister install` Install a built WASM to a canister on a network **Usage:** `icp canister install [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-m`, `--mode ` — Specifies the mode of canister installation Default value: `auto` Possible values: `auto`, `install`, `reinstall`, `upgrade` * `--wasm-memory-persistence ` — For Motoko canisters with enhanced orthogonal persistence (EOP), controls whether the canister's main (Wasm) memory is preserved across an upgrade. Only valid with `--mode upgrade` on an EOP canister. - `keep`: preserve main memory — the normal EOP upgrade (the default if this flag is omitted). - `replace`: discard main memory. DANGEROUS: any state not held in `stable` variables is lost. Requires interactive confirmation (or `--yes`). Possible values: - `keep`: Preserve canister main memory across upgrade (normal EOP upgrade) - `replace`: Discard canister main memory; only `stable` variables survive. Dangerous — heap state is lost * `--wasm ` — Path to the WASM file to install. Uses the build output if not explicitly provided * `--args ` — Inline arguments, interpreted per `--args-format` (Candid by default) * `--args-file ` — Path to a file containing arguments * `--args-format ` — Format of the arguments Default value: `candid` Possible values: - `hex`: Hex-encoded bytes - `candid`: Candid text format - `bin`: Raw binary (only valid for file references) * `-y`, `--yes` — Skip confirmation prompts, including the Candid interface compatibility check and the dangerous-operation prompt for `--wasm-memory-persistence replace` * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister list` List the canisters in an environment. Prints canister names, one per line. Use --json for machine-readable output (returns {"canisters": ["name1", "name2", ...]}) **Usage:** `icp canister list [OPTIONS]` ###### **Options:** * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--json` — Output command results as JSON ## `icp canister logs` Fetch and display canister logs **Usage:** `icp canister logs [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `-f`, `--follow` — Continuously fetch and display new logs until interrupted with Ctrl+C * `--interval ` — Polling interval in seconds when following logs (requires --follow) Default value: `2` * `--since ` — Show logs at or after this timestamp (inclusive). Accepts nanoseconds since Unix epoch or RFC3339 (e.g. '2024-01-01T00:00:00Z'). Cannot be used with --follow * `--until ` — Show logs before this timestamp (exclusive). Accepts nanoseconds since Unix epoch or RFC3339 (e.g. '2024-01-01T00:00:00Z'). Cannot be used with --follow * `--since-index ` — Show logs at or after this log index (inclusive). Cannot be used with --follow * `--until-index ` — Show logs before this log index (exclusive). Cannot be used with --follow * `--json` — Output command results as JSON ## `icp canister metadata` Read a metadata section from a canister **Usage:** `icp canister metadata [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified * `` — The name of the metadata section to read ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--json` — Output command results as JSON ## `icp canister migrate-id` Migrate a canister ID from one subnet to another **Usage:** `icp canister migrate-id [OPTIONS] --replace ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--replace ` — The canister to replace with the source canister's ID * `-y`, `--yes` — Skip confirmation prompts * `--resume-watch` — Resume watching an already-initiated migration (skips validation and initiation) * `--skip-watch` — Exit as soon as the migrated canister is deleted (don't wait for full completion) * `--proxy ` — Principal of a proxy canister to route the management canister calls through ## `icp canister settings` Commands to manage canister settings **Usage:** `icp canister settings ` ###### **Subcommands:** * `show` — Show the settings of a canister * `update` — Change a canister's settings to specified values * `sync` — Synchronize a canister's settings with those defined in the project ## `icp canister settings show` Show the settings of a canister. Queries the canister_status endpoint of the management canister and displays only the settings fields. Requires the caller to be a controller. **Usage:** `icp canister settings show [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--json` — Format output as JSON * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister settings update` Change a canister's settings to specified values **Usage:** `icp canister settings update [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `-f`, `--force` — Force the operation without confirmation prompts * `--add-controller ` — Add one or more principals to the canister's controller list * `--remove-controller ` — Remove one or more principals from the canister's controller list. Warning: Removing yourself will cause you to lose control of the canister. * `--remove-all-controllers` — Remove all controllers. Warning: This will cause you to lose control of the canister, unless you add your user principal back in `--add-controller` in the same command. * `--compute-allocation ` — Compute allocation percentage (0-100). Represents a guaranteed share of a subnet's compute capacity * `--memory-allocation ` — Memory allocation in bytes. Supports suffixes: kb, kib, mb, mib, gb, gib (e.g. "4gib" or "2.5kb") * `--freezing-threshold ` — Freezing threshold. Controls how long a canister can be inactive before being frozen. Supports duration suffixes: s (seconds), m (minutes), h (hours), d (days), w (weeks). A bare number is treated as seconds * `--reserved-cycles-limit ` — Upper limit on cycles reserved for future resource payments. Memory allocations that would push the reserved balance above this limit will fail. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) * `--wasm-memory-limit ` — Wasm memory limit in bytes. Supports suffixes: kb, kib, mb, mib, gb, gib (e.g. "4gib" or "2.5kb") * `--wasm-memory-threshold ` — Wasm memory threshold in bytes. Supports suffixes: kb, kib, mb, mib, gb, gib (e.g. "4gib" or "2.5kb") * `--log-memory-limit ` — Log memory limit in bytes (max 2 MiB). Oldest logs are purged when usage exceeds this value. Supports suffixes: kb, kib, mb, mib (e.g. "2mib" or "256kib"). Canister default is 4096 bytes * `--log-visibility ` — Set log visibility to a fixed policy [possible values: controllers, public]. Conflicts with --add-log-viewer, --remove-log-viewer, and --set-log-viewer. Use --add-log-viewer / --set-log-viewer to grant access to specific principals instead * `--add-log-viewer ` — Add a principal to the allowed log viewers list * `--remove-log-viewer ` — Remove a principal from the allowed log viewers list * `--set-log-viewer ` — Replace the allowed log viewers list with the specified principals * `--add-environment-variable ` — Add a canister environment variable in KEY=VALUE format * `--remove-environment-variable ` — Remove a canister environment variable by key name * `--proxy ` — Principal of a proxy canister to route the management canister calls through ## `icp canister settings sync` Synchronize a canister's settings with those defined in the project **Usage:** `icp canister settings sync [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--proxy ` — Principal of a proxy canister to route the management canister calls through ## `icp canister snapshot` Commands to manage canister snapshots **Usage:** `icp canister snapshot ` ###### **Subcommands:** * `create` — Create a snapshot of a canister's state * `delete` — Delete a canister snapshot * `download` — Download a snapshot to local disk * `list` — List all snapshots for a canister * `restore` — Restore a canister from a snapshot * `upload` — Upload a snapshot from local disk ## `icp canister snapshot create` Create a snapshot of a canister's state **Usage:** `icp canister snapshot create [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--replace ` — Replace an existing snapshot instead of creating a new one. The old snapshot will be deleted once the new one is successfully created * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only snapshot ID * `--proxy ` — Principal of a proxy canister to route the management canister calls through ## `icp canister snapshot delete` Delete a canister snapshot **Usage:** `icp canister snapshot delete [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified * `` — The snapshot ID to delete (hex-encoded) ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister snapshot download` Download a snapshot to local disk **Usage:** `icp canister snapshot download [OPTIONS] --output ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified * `` — The snapshot ID to download (hex-encoded) ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `-o`, `--output ` — Output directory for the snapshot files * `--resume` — Resume a previously interrupted download * `--proxy ` — Principal of a proxy canister to route the management canister calls through ## `icp canister snapshot list` List all snapshots for a canister **Usage:** `icp canister snapshot list [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only snapshot IDs * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister snapshot restore` Restore a canister from a snapshot **Usage:** `icp canister snapshot restore [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified * `` — The snapshot ID to restore (hex-encoded) ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--proxy ` — Principal of a proxy canister to route the management canister calls through ## `icp canister snapshot upload` Upload a snapshot from local disk **Usage:** `icp canister snapshot upload [OPTIONS] --input ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `-i`, `--input ` — Input directory containing the snapshot files * `--replace ` — Replace an existing snapshot instead of creating a new one * `--resume` — Resume a previously interrupted upload * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only snapshot ID * `--proxy ` — Principal of a proxy canister to route the management canister calls through ## `icp canister start` Start a canister on a network **Usage:** `icp canister start [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister status` Show the status of canister(s). By default this queries the status endpoint of the management canister. If the caller is not a controller, falls back on fetching public information from the state tree. **Usage:** `icp canister status [OPTIONS] [CANISTER]` Examples: # Status of all canisters in the local environment icp canister status # Status of one canister by name icp canister status backend -e local # Print only canister IDs (useful for scripting) icp canister status -i # JSON output for all canisters icp canister status --json ###### **Arguments:** * `` — An optional canister name or principal to target. When using a name, an environment must be specified. If omitted, shows status for all canisters in the environment ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `-i`, `--id-only` — Only print the canister ids * `--json` — Format output in json * `-p`, `--public` — Show the only the public information. Skips trying to get the status from the management canister and looks up public information from the state tree * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister stop` Stop a canister on a network **Usage:** `icp canister stop [OPTIONS] ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--proxy ` — Principal of a proxy canister to route the management canister call through ## `icp canister top-up` Top up a canister with cycles **Usage:** `icp canister top-up [OPTIONS] --amount ` ###### **Arguments:** * `` — Name or principal of canister to target. When using a name an environment must be specified ###### **Options:** * `--amount ` — Amount of cycles to top up. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as ## `icp cycles` Mint and manage cycles **Usage:** `icp cycles ` ###### **Subcommands:** * `balance` — Display the cycles balance * `mint` — Convert ICP to cycles * `transfer` — Transfer cycles to another principal ## `icp cycles balance` Display the cycles balance **Usage:** `icp cycles balance [OPTIONS]` ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--subaccount ` — The subaccount to check the balance for * `--of-principal ` — Check the balance of this principal instead of the current identity * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only the balance ## `icp cycles mint` Convert ICP to cycles. Exactly one of --icp or --cycles must be provided. **Usage:** `icp cycles mint [OPTIONS]` ###### **Options:** * `--icp ` — Amount of ICP to mint to cycles. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) * `--cycles ` — Amount of cycles to mint. Automatically determines the amount of ICP needed. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) * `--from-subaccount ` — Subaccount to withdraw the ICP from * `--to-subaccount ` — Subaccount to deposit the cycles to * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--json` — Output command results as JSON ## `icp cycles transfer` Transfer cycles to another principal **Usage:** `icp cycles transfer [OPTIONS] ` ###### **Arguments:** * `` — Cycles amount to transfer. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) * `` — The receiver of the cycles transfer ###### **Options:** * `--to-subaccount ` — The subaccount to transfer to (only if the receiver is a principal) * `--from-subaccount ` — The subaccount to transfer cycles from * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only the block index ## `icp deploy` Deploy a project to an environment **Usage:** `icp deploy [OPTIONS] [NAMES]...` When deploying a single canister, you can pass arguments to the install call using --args or --args-file: # Pass inline Candid arguments icp deploy my_canister --args '(42 : nat)' # Pass arguments from a file icp deploy my_canister --args-file ./args.did # Pass raw bytes icp deploy my_canister --args-file ./args.bin --args-format bin ###### **Arguments:** * `` — Canister names ###### **Options:** * `-m`, `--mode ` — Specifies the mode of canister installation Default value: `auto` Possible values: `auto`, `install`, `reinstall`, `upgrade` * `--subnet ` — The subnet to use for the canisters being deployed * `--proxy ` — Principal of a proxy canister to route management canister calls through * `--controller ` — One or more controllers for the canisters being deployed. Repeat `--controller` to specify multiple * `--cycles ` — Cycles to fund canister creation. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) Default value: `2000000000000` * `-y`, `--yes` — Skip confirmation prompts, including the Candid interface compatibility check * `--identity ` — The user identity to run this command as * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--json` — Output command results as JSON * `--args ` — Inline arguments, interpreted per `--args-format` (Candid by default) * `--args-file ` — Path to a file containing arguments * `--args-format ` — Format of the arguments Default value: `candid` Possible values: - `hex`: Hex-encoded bytes - `candid`: Candid text format - `bin`: Raw binary (only valid for file references) ## `icp environment` Show information about the current project environments **Usage:** `icp environment ` ###### **Subcommands:** * `list` — List the environments defined in this project, one per line ## `icp environment list` List the environments defined in this project, one per line. Use `icp project show` to see the fully expanded configuration including implicit environments (local, ic) and their network and canister assignments. **Usage:** `icp environment list` ## `icp identity` Manage your identities **Usage:** `icp identity ` ###### **Subcommands:** * `account-id` — Display the ICP ledger or ICRC-1 account identifier for the current identity * `default` — Display or set the currently selected identity * `delegation` — Manage delegations for identities * `delete` — Delete an identity * `export` — Print the PEM file for the identity * `import` — Import a new identity * `link` — Link an external key to a new identity * `list` — List the identities * `new` — Create a new identity * `principal` — Display the principal for the current identity * `reauth` — Re-authenticate an Internet Identity delegation or create a PEM session delegation * `rename` — Rename an identity ## `icp identity account-id` Display the ICP ledger or ICRC-1 account identifier for the current identity **Usage:** `icp identity account-id [OPTIONS]` ###### **Options:** * `--identity ` — The user identity to run this command as * `--of-principal ` — Convert this Principal instead of the current identity's Principal * `--of-subaccount ` — Specify a subaccount * `--format ` — Account identifier format to display Default value: `ledger` Possible values: - `ledger`: ICP ledger account identifier - `icrc1`: ICRC-1 account identifier ## `icp identity default` Display or set the currently selected identity **Usage:** `icp identity default [NAME]` ###### **Arguments:** * `` — Identity to set as default. If omitted, prints the current default ## `icp identity delegation` Manage delegations for identities **Usage:** `icp identity delegation ` ###### **Subcommands:** * `request` — Create a pending delegation identity with a new P256 session key * `sign` — Sign a delegation from the selected identity to a target key * `use` — Complete a pending delegation identity by providing a signed delegation chain ## `icp identity delegation request` Create a pending delegation identity with a new P256 session key Prints the session public key as a PEM-encoded SPKI to stdout. Pass this to `icp identity delegation sign --key-pem` on another machine to obtain a delegation chain, then complete the identity with `icp identity delegation use`. **Usage:** `icp identity delegation request [OPTIONS] ` ###### **Arguments:** * `` — Name for the new identity ###### **Options:** * `--storage ` — Where to store the session private key Default value: `keyring` Possible values: `plaintext`, `keyring`, `password` * `--storage-password-file ` — Read the storage password from a file instead of prompting (for --storage password) ## `icp identity delegation sign` Sign a delegation from the selected identity to a target key **Usage:** `icp identity delegation sign [OPTIONS] --key-pem --duration ` ###### **Options:** * `--key-pem ` — Public key PEM file of the key to delegate to * `--duration ` — Delegation validity duration (e.g. "30d", "24h", "3600s", or plain seconds) * `--canisters ` — Canister principals to restrict the delegation to (comma-separated) * `--identity ` — The user identity to run this command as ## `icp identity delegation use` Complete a pending delegation identity by providing a signed delegation chain Reads the JSON output of `icp identity delegation sign` from a file and attaches it to the named identity, making it usable for signing. **Usage:** `icp identity delegation use --from-json ` ###### **Arguments:** * `` — Name of the pending delegation identity to complete ###### **Options:** * `--from-json ` — Path to the delegation chain JSON file (output of `icp identity delegation sign`) ## `icp identity delete` Delete an identity **Usage:** `icp identity delete ` ###### **Arguments:** * `` — Name of the identity to delete ## `icp identity export` Print the PEM file for the identity **Usage:** `icp identity export [OPTIONS] ` ###### **Arguments:** * `` — Name of the identity to export ###### **Options:** * `--password-file ` — Read the password from a file instead of prompting (only required for identities created or imported with --storage password) * `--encrypt` — Encrypt the exported PEM with a password * `--encryption-password-file ` — Read the encryption password from a file instead of prompting ## `icp identity import` Import a new identity **Usage:** `icp identity import [OPTIONS] <--from-pem |--read-seed-phrase|--from-seed-file > ` ###### **Arguments:** * `` — Name for the imported identity ###### **Options:** * `--storage ` — Where to store the private key Default value: `keyring` Possible values: `plaintext`, `keyring`, `password` * `--from-pem ` — Import from a PEM file * `--read-seed-phrase` — Read seed phrase interactively from the terminal * `--from-seed-file ` — Read seed phrase from a file * `--decryption-password-from-file ` — Read the PEM decryption password from a file instead of prompting * `--storage-password-file ` — Read the storage password from a file instead of prompting (for --storage password) * `--assert-key-type ` — Specify the key type when it cannot be detected from the PEM file (danger!) Possible values: `secp256k1`, `prime256v1`, `ed25519` * `--seed-curve ` — Curve for SLIP-0010 key derivation from a seed phrase Default value: `secp256k1` Possible values: `secp256k1`, `prime256v1`, `ed25519` * `--delegation ` — Attach a signed delegation chain JSON (same format as `icp identity delegation sign`). For security, in most cases it is better to use `icp identity delegation` instead. ## `icp identity link` Link an external key to a new identity **Usage:** `icp identity link ` ###### **Subcommands:** * `hsm` — Link an HSM key to a new identity * `web` — Link a web-based identity (such as Internet Identity) to a new icp-cli identity ## `icp identity link hsm` Link an HSM key to a new identity **Usage:** `icp identity link hsm [OPTIONS] --pkcs11-module --key-id ` ###### **Arguments:** * `` — Name for the linked identity ###### **Options:** * `--pkcs11-module ` — Path to the PKCS#11 module (shared library) for the HSM * `--slot ` — Slot index on the HSM device Default value: `0` * `--key-id ` — Key ID on the HSM (e.g., "01" for PIV authentication key) * `--pin-file ` — Read HSM PIN from a file instead of prompting ## `icp identity link web` Link a web-based identity (such as Internet Identity) to a new icp-cli identity **Usage:** `icp identity link web [OPTIONS] ` ###### **Arguments:** * `` — Name for the linked identity ###### **Options:** * `--auth ` — Auth domain to sign in at (e.g. id.ai or identity.ce1.com). Its `/.well-known/cli-auth-config` decides the login path Default value: `https://id.ai` * `--app ` — Delegation domain to get an identity for (e.g. oisy.com). When omitted, the auth domain picks its default (id.ai uses cli.id.ai) * `--storage ` — Where to store the session private key Default value: `keyring` Possible values: `plaintext`, `keyring`, `password` * `--storage-password-file ` — Read the storage password from a file instead of prompting (for --storage password) ## `icp identity list` List the identities **Usage:** `icp identity list [OPTIONS]` ###### **Options:** * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only identity names ## `icp identity new` Create a new identity **Usage:** `icp identity new [OPTIONS] ` ###### **Arguments:** * `` — Name for the new identity ###### **Options:** * `--storage ` — Where to store the private key Default value: `keyring` Possible values: `plaintext`, `keyring`, `password` * `--storage-password-file ` — Read the storage password from a file instead of prompting (for --storage password) * `--output-seed ` — Write the seed phrase to a file instead of printing to stdout * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only the seed phrase ## `icp identity principal` Display the principal for the current identity **Usage:** `icp identity principal [OPTIONS]` ###### **Options:** * `--identity ` — The user identity to run this command as ## `icp identity reauth` Re-authenticate an Internet Identity delegation or create a PEM session delegation **Usage:** `icp identity reauth [OPTIONS] ` ###### **Arguments:** * `` — Name of the identity to re-authenticate ###### **Options:** * `--duration ` — Session delegation duration (e.g. "30m", "8h", "1d"). Note that 2m extra is added when creating the delegation to account for clock drift. Required for PEM identities when session caching is disabled in settings. Not applicable for web-auth identities ## `icp identity rename` Rename an identity **Usage:** `icp identity rename ` ###### **Arguments:** * `` — Current name of the identity * `` — New name for the identity ## `icp network` Launch and manage local test networks **Usage:** `icp network ` ###### **Subcommands:** * `list` — List all networks configured in the project * `ping` — Try to connect to a network, and print out its status * `start` — Run a given network * `status` — Get status information about a running network * `stop` — Stop a background network * `update` — Update icp-cli-network-launcher to the latest version ## `icp network list` List all networks configured in the project **Usage:** `icp network list` ## `icp network ping` Try to connect to a network, and print out its status **Usage:** `icp network ping [OPTIONS] [NAME]` Examples: # Ping default 'local' network icp network ping # Ping explicit network icp network ping mynetwork # Ping by URL (no project required) icp network ping http://localhost:4943 # Ping using environment flag icp network ping -e staging # Ping using ICP_ENVIRONMENT variable ICP_ENVIRONMENT=staging icp network ping # Name overrides ICP_ENVIRONMENT ICP_ENVIRONMENT=staging icp network ping local # Wait until healthy icp network ping --wait-healthy ###### **Arguments:** * `` — Name of the network to use. Takes precedence over -e/--environment and the ICP_ENVIRONMENT environment variable when specified explicitly. ###### **Options:** * `-e`, `--environment ` — Use the network configured in the specified environment. Cannot be used together with an explicit network name argument. The ICP_ENVIRONMENT environment variable is also checked when neither network name nor -e flag is specified. * `--wait-healthy` — Repeatedly ping until the replica is healthy or 1 minute has passed ## `icp network start` Run a given network. The gateway binds to port 8000 by default. To use a different port, set `gateway.port` in `icp.yaml`. If port 8000 is already in use by another icp-cli project, stop that network first: icp network stop --project-root-override **Usage:** `icp network start [OPTIONS] [NAME]` Examples: # Use default 'local' network icp network start # Use explicit network name icp network start mynetwork # Use environment flag icp network start -e staging # Use ICP_ENVIRONMENT variable ICP_ENVIRONMENT=staging icp network start # Name overrides ICP_ENVIRONMENT ICP_ENVIRONMENT=staging icp network start local # Background mode with environment icp network start -e staging -d ###### **Arguments:** * `` — Name of the network to use. Takes precedence over -e/--environment and the ICP_ENVIRONMENT environment variable when specified explicitly. ###### **Options:** * `-e`, `--environment ` — Use the network configured in the specified environment. Cannot be used together with an explicit network name argument. The ICP_ENVIRONMENT environment variable is also checked when neither network name nor -e flag is specified. * `-d`, `--background` — Starts the network in a background process. This command will exit once the network is running. To stop the network, use 'icp network stop' ## `icp network status` Get status information about a running network **Usage:** `icp network status [OPTIONS] [NAME]` Examples: # Get status of default 'local' network icp network status # Get status of explicit network icp network status mynetwork # Get status using environment flag icp network status -e staging # Get status using ICP_ENVIRONMENT variable ICP_ENVIRONMENT=staging icp network status # Name overrides ICP_ENVIRONMENT ICP_ENVIRONMENT=staging icp network status local # JSON output icp network status --json ###### **Arguments:** * `` — Name of the network to use. Takes precedence over -e/--environment and the ICP_ENVIRONMENT environment variable when specified explicitly. ###### **Options:** * `-e`, `--environment ` — Use the network configured in the specified environment. Cannot be used together with an explicit network name argument. The ICP_ENVIRONMENT environment variable is also checked when neither network name nor -e flag is specified. * `--json` — Format output as JSON ## `icp network stop` Stop a background network **Usage:** `icp network stop [OPTIONS] [NAME]` Examples: # Stop default 'local' network icp network stop # Stop explicit network icp network stop mynetwork # Stop using environment flag icp network stop -e staging # Stop using ICP_ENVIRONMENT variable ICP_ENVIRONMENT=staging icp network stop # Name overrides ICP_ENVIRONMENT ICP_ENVIRONMENT=staging icp network stop local ###### **Arguments:** * `` — Name of the network to use. Takes precedence over -e/--environment and the ICP_ENVIRONMENT environment variable when specified explicitly. ###### **Options:** * `-e`, `--environment ` — Use the network configured in the specified environment. Cannot be used together with an explicit network name argument. The ICP_ENVIRONMENT environment variable is also checked when neither network name nor -e flag is specified. ## `icp network update` Update icp-cli-network-launcher to the latest version **Usage:** `icp network update` ## `icp new` Create a new ICP project from a template Under the hood templates are generated with `cargo-generate`. See the cargo-generate docs for a guide on how to write your own templates: https://docs.rs/cargo-generate/0.23.7/cargo_generate/ **Usage:** `icp new [OPTIONS] [NAME]` ###### **Arguments:** * `` — Directory to create / project name; if the name isn't in kebab-case, it will be converted to kebab-case unless `--force` is given. Optional when `--init` is used: defaults to the name of the current directory ###### **Options:** * `--subfolder ` — Specifies the subfolder within the template repository to be used as the actual template * `-g`, `--git ` — Git repository to clone template from. Can be a URL (like `https://github.com/dfinity/icp-cli-project-template`), a path (relative or absolute) Default value: `https://github.com/dfinity/icp-cli-templates` * `-b`, `--branch ` — Branch to use when installing from git * `-t`, `--tag ` — Tag to use when installing from git * `-r`, `--revision ` — Git revision to use when installing from git (e.g. a commit hash) * `-p`, `--path ` — Local path to copy the template from. Can not be specified together with --git * `-f`, `--force` — Don't convert the project name to kebab-case before creating the directory. Note that `icp-cli` won't overwrite an existing directory, even if `--force` is given * `-q`, `--quiet` — Opposite of verbose, suppresses errors & warning in output Conflicts with --debug, and requires the use of --continue-on-error * `--continue-on-error` — Continue if errors in templates are encountered * `-s`, `--silent` — Non-interactive mode: suppresses all prompts. Unset variables fall back to their template-defined defaults; generation fails if a required variable has no default. Combine with --define to supply values for variables that have no default in the template. Use for CI or automated/agent contexts * `--vcs ` — Specify the VCS used to initialize the generated template * `-i`, `--identity ` — Use a different ssh identity * `--gitconfig ` — Use a different gitconfig file, if omitted the usual $HOME/.gitconfig will be used * `-d`, `--define ` — Set a template variable in KEY=VALUE format (e.g. --define project_name=my-app). Variable names are template-specific. Suppresses the interactive prompt for that variable. Required in --silent mode for any template variable that has no default value * `--init` — Generate the template directly into the current dir. No subfolder will be created and no vcs is initialized * `--destination ` — Generate the template directly at the given path * `--force-git-init` — Will enforce a fresh git init on the generated project * `-o`, `--overwrite` — Allow the template to overwrite existing files in the destination * `--skip-submodules` — Skip downloading git submodules (if there are any) ## `icp project` Manage the current project **Usage:** `icp project ` ###### **Subcommands:** * `show` — Outputs the project's effective yaml configuration ## `icp project show` Outputs the project's effective yaml configuration. The effective yaml configuration includes: - implicit networks - implicit environments - processed recipes **Usage:** `icp project show` ## `icp settings` Configure user settings **Usage:** `icp settings [OPTIONS] [VALUE]` ###### **Subcommands:** * `autocontainerize` — Use Docker for the network launcher even when native mode is requested * `telemetry` — Enable or disable anonymous usage telemetry * `update-check` — Enable or disable the CLI update check * `session-length` — Set the session length for password-protected PEM identities ## `icp settings autocontainerize` Use Docker for the network launcher even when native mode is requested **Usage:** `icp settings autocontainerize [VALUE]` ###### **Arguments:** * `` — Set to true or false. If omitted, prints the current value Possible values: `true`, `false` ## `icp settings telemetry` Enable or disable anonymous usage telemetry **Usage:** `icp settings telemetry [VALUE]` ###### **Arguments:** * `` — Set to true or false. If omitted, prints the current value Possible values: `true`, `false` ## `icp settings update-check` Enable or disable the CLI update check **Usage:** `icp settings update-check [VALUE]` ###### **Arguments:** * `` — Set to releases, betas, or disabled. If omitted, prints the current value Possible values: `releases`, `betas`, `disabled` ## `icp settings session-length` Set the session length for password-protected PEM identities **Usage:** `icp settings session-length [VALUE]` ###### **Arguments:** * `` — Duration (e.g. `5m`, `1h`, `2d`) or `disabled`. If omitted, prints the current value. Note that due to clock drift, 2 minutes are added to the given value, so `5m` produces a 7-minute-expiry delegation. `disabled` turns off session caching entirely. ## `icp sync` Synchronize canisters **Usage:** `icp sync [OPTIONS] [CANISTERS]...` ###### **Arguments:** * `` — Canister names (if empty, sync all canisters in environment) ###### **Options:** * `--proxy ` — Principal of a proxy canister to route sync plugin calls to the target canister through * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as ## `icp token` Perform token transactions **Usage:** `icp token [TOKEN|LEDGER_ID] ` ###### **Subcommands:** * `balance` — Display the token balance on the ledger (default token: icp) * `transfer` — Transfer ICP or ICRC1 tokens through their ledger (default token: icp) ###### **Arguments:** * `` — The token or ledger canister id to execute the operation on, defaults to `icp` Default value: `icp` ## `icp token balance` Display the token balance on the ledger (default token: icp) **Usage:** `icp token [TOKEN|LEDGER_ID] balance [OPTIONS]` ###### **Options:** * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--subaccount ` — The subaccount to check the balance for * `--of-principal ` — Check the balance of this principal instead of the current identity * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only the balance ## `icp token transfer` Transfer ICP or ICRC1 tokens through their ledger (default token: icp) **Usage:** `icp token [TOKEN|LEDGER_ID] transfer [OPTIONS] ` ###### **Arguments:** * `` — Token amount to transfer. Supports suffixes: k (thousand), m (million), b (billion), t (trillion) * `` — The receiver of the token transfer. Can be a principal, an ICRC1 account ID, or an ICP ledger account ID (hex) ###### **Options:** * `--to-subaccount ` — The subaccount to transfer to (only if the receiver is a principal) * `--from-subaccount ` — The subaccount to transfer from * `-n`, `--network ` — Name or URL of the network to target, conflicts with environment argument * `-k`, `--root-key ` — The root key to use if connecting to a network by URL. Required when using `--network ` * `-e`, `--environment ` — Override the environment to connect to. By default, the local environment is used * `--identity ` — The user identity to run this command as * `--json` — Output command results as JSON * `-q`, `--quiet` — Suppress human-readable output; print only the block index
This document was generated automatically by clap-markdown.