Skip to content

fix(icp-cli, caffeine-app): carve out the one real dfx exception #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
raymondk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(icp-cli, caffeine-app): carve out the one real dfx exception #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions skills/caffeine-app/references/frontend-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,12 @@ Verbatim. The `declarations` alias and `dedupe: ["@icp-sdk/core"]` matter — th
backend client imports from `./declarations` and from `@icp-sdk` packages, and deduping
`@icp-sdk/core` avoids "multiple agent instances" runtime issues.

The `DFX_NETWORK` check, the `DFX_`/`CANISTER_` env prefixes and the `127.0.0.1:4943`
proxy target are dfx-era naming conventions this scaffold inherited. They do **not** mean
`dfx` is required — you never run it (see SKILL.md § Pitfalls). They are just the variable
names the config reads, and `/api` is only proxied if something is actually serving on
4943; a local replica on another port needs that target changed.

```javascript
import { fileURLToPath, URL } from "url";
import react from "@vitejs/plugin-react";
Expand Down
4 changes: 2 additions & 2 deletions skills/icp-cli/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ metadata:

## What This Is

The `icp` command-line tool builds and deploys applications on the Internet Computer. It replaces the legacy `dfx` tool with YAML configuration, a recipe system for reusable build templates, and an environment model that separates deployment targets from network connections. Never use `dfx` — always use `icp`.
The `icp` command-line tool builds and deploys applications on the Internet Computer. It replaces the legacy `dfx` tool with YAML configuration, a recipe system for reusable build templates, and an environment model that separates deployment targets from network connections. Never use `dfx` — always use `icp`. One documented exception: `icp` has no `sns`/`nns` subcommand, so SNS launch steps still go through the `dfx sns` extension — see `sns-launch`.

Before generating any `icp` command not explicitly documented here, run `icp --help` or `icp <subcommand> --help` to verify the command and its flags exist. Do not infer flags from `dfx` equivalents — the CLIs are not flag-compatible.

Expand Down Expand Up @@ -40,7 +40,7 @@ npm install -g @icp-sdk/icp-cli @icp-sdk/ic-wasm

## Common Pitfalls

1. **Using `dfx` instead of `icp`.** The `dfx` tool is legacy. All commands have `icp` equivalents — see `references/dfx-migration.md` for the full command mapping. Never generate `dfx` commands or reference `dfx` documentation. Configuration uses `icp.yaml`, not `dfx.json` — and the structure differs: canisters are an array of objects, not a keyed object.
1. **Using `dfx` instead of `icp`.** The `dfx` tool is legacy. Every build, deploy, canister, identity, and cycles command has an `icp` equivalent — see `references/dfx-migration.md` for the full mapping. Do not generate `dfx` commands or reference `dfx` documentation for those. The exception is SNS governance: there is no `icp sns`/`icp nns`, so the launch steps in `sns-launch` legitimately use `dfx sns`. Configuration uses `icp.yaml`, not `dfx.json` — and the structure differs: canisters are an array of objects, not a keyed object.

2. **Using `--network ic` to deploy to mainnet.** icp-cli uses environments, not direct network targeting. The correct flag is `-e ic` (short for `--environment ic`).
```bash
Expand Down
Loading