All apps/ICP CLI

ICP CLI

icp-cli

Command-line interface for developing and deploying Internet Computer applications.

Runs as icp|macOS, Linux, Windows|cli.internetcomputer.org

Command form

ai-draft · 3 tasks · 10 fields

Build and deploy canisters of an Internet Computer project. Covers 'icp build' and 'icp deploy'; canister calls, networks, identities and project creation are not covered.

Opens the form; the finished command lands at your prompt, unrun
otty gui icp-cli

icp build

Build canisters

Build the canisters of the project; all of them when none are named.

Build canistersExample values, fixed in this page — nothing here reaches a terminal
Basic
Environment
string
TasksEach one presets the form for one job
Build everything
environment
ParametersOnly these flags are editable in the form
Canisters
Canister names; leave empty to build all.
string · positional 0 · repeatable
Environment
string
--environment-elocal

icp deploy

Deploy to an environment

Create, build and install canisters. Inline arguments (--args) and proxy options are not offered.

Deploy to an environmentExample values, fixed in this page — nothing here reaches a terminal
Basic
Canisters
string
Environment
string
Install mode
4 choicesenum
Identity
string
TasksEach one presets the form for one job
Deploy to an environment
namesenvironmentmodeidentity
Upgrade existing canisters
namesenvironmentidentitymode
ParametersOnly these flags are editable in the form
Canisters
Canister names; leave empty to deploy all.
string · positional 0 · repeatable
Environment
string
--environment-elocal
Install mode
enum
--mode-mautoinstallreinstallupgrade
Identity
string
--identity
Subnet
string
--subnet
Controllers
string · repeatable
--controller
Do not create missing canisters
boolean
--no-create
Skip confirmation prompts
boolean
--yes-y
SourcesEvery flag above is checked against these
ref
Usage: icp build [OPTIONS] [CANISTERS]... <CANISTERS> — Canister names (if empty, build all canisters in environment) -e, --environment <ENVIRONMENT> — Override the environment to connect to. By default, the local environment is used
helpicp-cli 1.3 reference

cli.internetcomputer.org

ref
Usage: icp deploy [OPTIONS] [NAMES]... <NAMES> — Canister names -m, --mode <MODE> — Specifies the mode of canister installation Possible values: auto, install, reinstall, upgrade --subnet <SUBNET> — The subnet to use for the canisters being deployed --controller <CONTROLLER> — One or more controllers for the canisters being deployed. Repeat --controller to s…
helpicp-cli 1.3 reference

cli.internetcomputer.org

Before it fills your prompt, Otty checks the installed icp against its version. A form that does not match your version is not offered.