Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sources/VERSIONS
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
chain-fusion-signer v0.4.0 a18c52a
papi v0.1.1 168bc9d
ic-pub-key v1.0.1 f89fa55
icp-cli v0.2.3 caeac37
icp-cli v0.3.1 c4c4618
motoko v1.9.0 e7c78d7
motoko-core v2.4.0 cd37dbf
cdk-rs ic-cdk v0.20.1 / ic-cdk-timers v1.0.0 / ic-cdk-executor v2.0.0 317f55c
Expand Down
2 changes: 1 addition & 1 deletion .sources/icp-cli
Submodule icp-cli updated 187 files
6 changes: 3 additions & 3 deletions docs/developer-tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Key features:
- **Environments**: named deployment targets that combine a network, canister set, and settings (e.g., local, staging, production)
- **Project scaffolding**: `icp new` bootstraps new projects from official templates

For installation, see the [Quickstart](../getting-started/quickstart.md) or the [full CLI documentation](https://cli.internetcomputer.org/0.2/).
For installation, see the [Quickstart](../getting-started/quickstart.md) or the [full CLI documentation](https://cli.internetcomputer.org/0.3/).

Advanced: [creating recipes](https://cli.internetcomputer.org/0.2/guides/creating-recipes) and [creating templates](https://cli.internetcomputer.org/0.2/guides/creating-templates) are documented on the CLI docs site.
Advanced: [creating recipes](https://cli.internetcomputer.org/0.3/guides/creating-recipes) and [creating templates](https://cli.internetcomputer.org/0.3/guides/creating-templates) are documented on the CLI docs site.

icp-cli collects anonymous usage telemetry. Opt out with `icp settings telemetry false` or `DO_NOT_TRACK=1`.

Coming from dfx? See the [migration guide](https://cli.internetcomputer.org/0.2/migration/from-dfx).
Coming from dfx? See the [migration guide](https://cli.internetcomputer.org/0.3/migration/from-dfx).

### ic-wasm

Expand Down
10 changes: 5 additions & 5 deletions docs/getting-started/project-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Beyond canisters, `icp.yaml` can also define **networks** (where to deploy) and
| `local` | `local` (managed, localhost:8000) | Local development |
| `ic` | `ic` (connected, https://icp-api.io) | Mainnet production |

You only need to add custom networks or environments when you have staging environments, testnets, or other deployment targets. See the [icp-cli configuration reference](https://cli.internetcomputer.org/0.2/reference/configuration#networks) for the full schema.
You only need to add custom networks or environments when you have staging environments, testnets, or other deployment targets. See the [icp-cli configuration reference](https://cli.internetcomputer.org/0.3/reference/configuration#networks) for the full schema.

## Canister configuration (canister.yaml)

Expand All @@ -99,7 +99,7 @@ The Rust backend uses the `@dfinity/rust` recipe:
```yaml
name: backend
recipe:
type: "@dfinity/rust@v3.1.0"
type: "@dfinity/rust@v3.2.0"
configuration:
package: backend
shrink: true
Expand All @@ -115,7 +115,7 @@ The frontend uses the `@dfinity/asset-canister` recipe, which builds the fronten
```yaml
name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
build:
- npm install
Expand Down Expand Up @@ -147,7 +147,7 @@ icp project show

This outputs the effective configuration, including all expanded recipe steps and implicit defaults.

Recipes are Handlebars templates hosted at [dfinity/icp-cli-recipes](https://github.com/dfinity/icp-cli-recipes). You can also create local or remote recipes for custom build patterns. See the [icp-cli recipes documentation](https://cli.internetcomputer.org/0.2/guides/creating-recipes) for details.
Recipes are Handlebars templates hosted at [dfinity/icp-cli-recipes](https://github.com/dfinity/icp-cli-recipes). You can also create local or remote recipes for custom build patterns. See the [icp-cli recipes documentation](https://cli.internetcomputer.org/0.3/guides/creating-recipes) for details.

## The .icp/ directory

Expand Down Expand Up @@ -246,6 +246,6 @@ For a deep dive on binding generation, see [Binding generation](../guides/canist
- [Binding generation](../guides/canister-calls/candid.md#binding-generation): deep dive on generating type-safe client code
- [Asset canister](../guides/frontends/asset-canister.md): how the frontend recipe and asset upload work
- [Canister lifecycle](../guides/canister-management/lifecycle.md): build, deploy, upgrade, and manage canisters
- [icp-cli reference](https://cli.internetcomputer.org/0.2/reference/cli): full CLI and configuration documentation
- [icp-cli reference](https://cli.internetcomputer.org/0.3/reference/cli): full CLI and configuration documentation

{/* Upstream: informed by dfinity/icp-cli docs/concepts/project-model.md, docs/concepts/recipes.md, docs/concepts/binding-generation.md, docs/concepts/canister-discovery.md */}
4 changes: 2 additions & 2 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ icp --version
ic-wasm --version
```

> **Alternative methods:** [Homebrew, shell scripts, and other options](https://cli.internetcomputer.org/0.2/guides/installation) are also available.
> **Alternative methods:** [Homebrew, shell scripts, and other options](https://cli.internetcomputer.org/0.3/guides/installation) are also available.

## Create a project

Expand Down Expand Up @@ -127,6 +127,6 @@ Each canister name maps to a directory containing its own `canister.yaml` with b
- [Choose your path](choose-your-path.md): pick a development path based on what you want to build
- [Concepts: Canisters](../concepts/canisters.md): learn what canisters are and how they work
- [AI coding agents](../guides/ai-coding-agents.md): use ICP skills to build on the Internet Computer with AI
- [icp-cli documentation](https://cli.internetcomputer.org/0.2/): full CLI reference and guides
- [icp-cli documentation](https://cli.internetcomputer.org/0.3/): full CLI reference and guides

<!-- Upstream: informed by dfinity/icp-cli docs/quickstart.md, docs/tutorial.md -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Parallel calls are most beneficial when the caller and callee are on **different
<Tabs syncKey="lang">
<TabItem label="Motoko">

- [icp-cli](https://cli.internetcomputer.org/0.2/guides/installation) installed
- [icp-cli](https://cli.internetcomputer.org/0.3/guides/installation) installed
- `mops` package manager with `core = "2.0.0"` in `mops.toml`

</TabItem>
<TabItem label="Rust">

- [icp-cli](https://cli.internetcomputer.org/0.2/guides/installation) installed
- [icp-cli](https://cli.internetcomputer.org/0.3/guides/installation) installed
- `ic-cdk = "0.19"` and `futures = "0.3"` in `Cargo.toml`

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/canister-management/cycles-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ icp deploy -e staging
icp deploy -e production
```

Each environment maintains separate canister IDs. Mainnet IDs are stored in `.icp/data/mappings/<environment>.ids.json` and should be committed to version control. See [Managing environments](https://cli.internetcomputer.org/0.2/guides/managing-environments) for full configuration options.
Each environment maintains separate canister IDs. Mainnet IDs are stored in `.icp/data/mappings/<environment>.ids.json` and should be committed to version control. See [Managing environments](https://cli.internetcomputer.org/0.3/guides/managing-environments) for full configuration options.

## Production deployment checklist

Expand Down Expand Up @@ -375,6 +375,6 @@ icp canister top-up backend --amount 1T -n ic
- [Cycles ledger reference](../../references/system-canisters.md#cycles-ledger): Canister IDs and interface specification
- [Calls with attached cycles](../canister-calls/inter-canister-calls.md#calls-with-attached-cycles): attach cycles to an inter-canister call and accept them in the callee
- [Reproducible builds](reproducible-builds.md): Verify your WASM is trustworthy before deploying
- [icp-cli docs](https://cli.internetcomputer.org/0.2/reference/cli#icp-cycles): Full command reference for `icp cycles` and `icp canister top-up`
- [icp-cli docs](https://cli.internetcomputer.org/0.3/reference/cli#icp-cycles): Full command reference for `icp cycles` and `icp canister top-up`

{/* Upstream: informed by dfinity/portal (docs/building-apps/canister-management/topping-up.mdx, docs/building-apps/getting-started/tokens-and-cycles.mdx; dfinity/icp-cli) docs/guides/deploying-to-mainnet.md, docs/guides/tokens-and-cycles.md, docs/guides/managing-environments.md; dfinity/icskills: skills/cycles-management/SKILL.md */}
4 changes: 2 additions & 2 deletions docs/guides/canister-management/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ async fn main() -> Result<()> {

- [Canister lifecycle](lifecycle.md): configure log visibility and memory limits when creating or deploying a canister
- [Testing strategies](../testing/strategies.md): use canister logs as part of your debugging workflow
- [CLI reference: `icp canister logs`](https://cli.internetcomputer.org/0.2/reference/cli#icp-canister-logs): full command flags and options
- [CLI reference: `icp canister settings update`](https://cli.internetcomputer.org/0.2/reference/cli#icp-canister-settings-update): full command flags and options
- [CLI reference: `icp canister logs`](https://cli.internetcomputer.org/0.3/reference/cli#icp-canister-logs): full command flags and options
- [CLI reference: `icp canister settings update`](https://cli.internetcomputer.org/0.3/reference/cli#icp-canister-settings-update): full command flags and options

<!-- Upstream: informed by dfinity/portal — docs/building-apps/canister-management/logs.mdx, docs/building-apps/canister-management/backtraces.mdx, docs/building-apps/advanced/canister-access-logs.mdx; dfinity/examples — rust/canister_logs, motoko/canister_logs, rust/query_stats, motoko/query_stats; dfinity/cdk-rs — ic-cdk/src/api.rs, ic-cdk/src/management_canister.rs, ic-management-canister-types/src/lib.rs; dfinity/icp-cli — docs/reference/cli.md, docs/reference/canister-settings.md -->
2 changes: 1 addition & 1 deletion docs/guides/canister-management/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ icp canister settings update backend -e ic --freezing-threshold 90d

Additional flags: `--reserved-cycles-limit`, `--wasm-memory-threshold`, `--log-memory-limit`, `--add-environment-variable`. Run `icp canister settings update --help` for the full list.

For the full list of CLI flags, see the [icp-cli reference](https://cli.internetcomputer.org/0.2/reference/cli#icp-canister-settings-update).
For the full list of CLI flags, see the [icp-cli reference](https://cli.internetcomputer.org/0.3/reference/cli#icp-canister-settings-update).

## Updating settings programmatically

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/canister-management/snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,6 @@ icp canister status my-canister -e ic
- [Canister lifecycle](lifecycle.md): Understand how snapshots fit into the upgrade workflow
- [Canister migration](canister-migration.md): Complete guide for moving a canister to a different subnet using the snapshot transfer workflow
- [Canister upgrades security](../security/canister-upgrades.md): Security considerations when using snapshot-based rollbacks
- [icp-cli canister snapshot reference](https://cli.internetcomputer.org/0.2/guides/canister-snapshots): Full command reference for all snapshot subcommands
- [icp-cli canister snapshot reference](https://cli.internetcomputer.org/0.3/guides/canister-snapshots): Full command reference for all snapshot subcommands

<!-- Upstream: informed by dfinity/icp-cli docs/guides/canister-snapshots.md; dfinity/portal docs/building-apps/canister-management/snapshots.mdx -->
6 changes: 3 additions & 3 deletions docs/guides/frontends/asset-canister.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Define an asset canister using the `@dfinity/asset-canister` recipe in your `icp
canisters:
- name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
dir: dist
build:
Expand All @@ -54,7 +54,7 @@ canisters:

The key fields are:

- **`recipe.type`:** specifies the asset canister recipe with a pinned version. Always pin to a specific version (e.g., `@v2.1.0`). See [available versions](https://github.com/dfinity/icp-cli-recipes/releases?q=asset-canister&expanded=true).
- **`recipe.type`:** specifies the asset canister recipe with a pinned version. Always pin to a specific version (e.g., `@v2.2.1`). See [available versions](https://github.com/dfinity/icp-cli-recipes/releases?q=asset-canister&expanded=true).
- **`dir`:** the directory containing your build output. This is `dist` for Vite-based projects, `out` for Next.js static exports, or `build` for Create React App. The contents of this directory (not the directory itself) are uploaded to the canister.
- **`build`:** shell commands that icp-cli runs before uploading. If omitted, icp-cli uploads whatever is already in `dir` without building.

Expand All @@ -64,7 +64,7 @@ For a fullstack project with a backend canister, list both in the same `icp.yaml
canisters:
- name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
dir: dist
build:
Expand Down
14 changes: 7 additions & 7 deletions docs/guides/frontends/frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide shows you how to configure your framework's build pipeline, wire up t

## Prerequisites

- [icp-cli](https://cli.internetcomputer.org/0.2/guides/installation) installed: `npm install -g @icp-sdk/icp-cli @icp-sdk/ic-wasm`
- [icp-cli](https://cli.internetcomputer.org/0.3/guides/installation) installed: `npm install -g @icp-sdk/icp-cli @icp-sdk/ic-wasm`
- A backend canister deployed (or a static-only site with no backend)
- Familiarity with [asset canisters](asset-canister.md)

Expand All @@ -36,7 +36,7 @@ The [hello-world template](../../getting-started/project-structure.md) uses Reac
canisters:
- name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
build:
- npm install
Expand Down Expand Up @@ -214,7 +214,7 @@ export default {
canisters:
- name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
build:
- npm install
Expand Down Expand Up @@ -246,7 +246,7 @@ This outputs static files to the `out/` directory.
canisters:
- name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
build:
- npm install
Expand All @@ -271,7 +271,7 @@ Export your game from Unity Editor: **File → Build Settings → WebGL → Buil
canisters:
- name: unity_webgl_template_assets
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
dir: dist
build:
Expand All @@ -293,7 +293,7 @@ Export your game from Godot Editor: **Project → Export → HTML5 → Export Pr
canisters:
- name: godot_html5_assets
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
dir: dist
build:
Expand Down Expand Up @@ -330,7 +330,7 @@ For sites with no backend canister (portfolios, landing pages, documentation):
canisters:
- name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
build:
- npm install
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/testing/pocket-ic.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ PocketIC runs on macOS and Linux. Windows is not currently supported for standal

## Connecting to a running network for testing

For end-to-end tests that need a full network with all system canisters, use a containerized network instead of PocketIC. See the [icp-cli containerized networks documentation](https://cli.internetcomputer.org/0.2/guides/containerized-networks) for how to configure Docker-based test networks in `icp.yaml`.
For end-to-end tests that need a full network with all system canisters, use a containerized network instead of PocketIC. See the [icp-cli containerized networks documentation](https://cli.internetcomputer.org/0.3/guides/containerized-networks) for how to configure Docker-based test networks in `icp.yaml`.

The containerized network is appropriate when:

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/testing/strategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ icp network status docker-test --json

For the full containerized network configuration reference: including environment variables, volume mounts, and
custom images: see the
[icp-cli containerized networks guide](https://cli.internetcomputer.org/0.2/guides/containerized-networks).
[icp-cli containerized networks guide](https://cli.internetcomputer.org/0.3/guides/containerized-networks).

## Choosing the right approach

Expand Down
2 changes: 1 addition & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Teach your AI coding agent the patterns, APIs, and deployment workflows it needs
## External resources

<CardGrid>
<LinkCard title="ICP CLI" description="Command-line tool for ICP development" href="https://cli.internetcomputer.org/0.2/" />
<LinkCard title="ICP CLI" description="Command-line tool for ICP development" href="https://cli.internetcomputer.org/0.3/" />
<LinkCard title="JS SDK" description="JavaScript/TypeScript libraries for ICP" href="https://js.icp.build" />
<LinkCard title="ICP Skills" description="Skills for agents that write code on ICP" href="https://skills.internetcomputer.org" />
<LinkCard title="Examples" description="Working Motoko and Rust canister examples" href="https://github.com/dfinity/examples" />
Expand Down
2 changes: 1 addition & 1 deletion docs/references/application-canisters.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Asset canisters are deployed per-project. There is no global asset canister ID:
canisters:
- name: frontend
recipe:
type: "@dfinity/asset-canister@v2.1.0"
type: "@dfinity/asset-canister@v2.2.1"
configuration:
dir: dist
build:
Expand Down
Loading