@ic-reactor/cli

Command-line code generation for IC Reactor. It uses the shared @ic-reactor/codegen pipeline to generate declarations and typed reactor entry files from your .did files, with optional React hook exports.

Install

pnpm add -D @ic-reactor/cli

After installation, the local executable is ic-reactor.

Quick Start

pnpm exec ic-reactor init
pnpm exec ic-reactor generate

If you prefer one-off usage without installing first:

pnpm dlx @ic-reactor/cli init
pnpm dlx @ic-reactor/cli generate

What init Creates

• an ic-reactor.json config file
• an optional src/clients.ts helper with a shared ClientManager

Example Config

{
  "$schema": "./node_modules/@ic-reactor/cli/schema.json",
  "outDir": "src/declarations",
  "clientManagerPath": "../../clients",
  "target": "react",
  "canisters": {
    "backend": {
      "name": "backend",
      "didFile": "./backend/backend.did"
    }
  }
}

Commands

init

pnpm exec ic-reactor init [options]

Options:
  -y, --yes              Skip prompts and use defaults
  -o, --out-dir <path>   Output directory for generated files

generate / g

pnpm exec ic-reactor generate [options]

Options:
  -c, --canister <name>  Generate only one configured canister
  --clean                Clean the output directory before generation
  --bindgen-only         Generate only .did, .did.d.ts, and .js declarations

Generated Output

For each canister, the CLI generates:

• <canister>.did copy
• <canister>.did.d.ts TypeScript service types
• <canister>.js IDL factory module
• index.generated.ts managed reactor implementation, with optional typed hook exports
• index.ts user-facing entrypoint

The CLI regenerates index.generated.ts on every run. It creates index.ts once, then preserves it unless the file is still the default wrapper or an older generated scaffold that can be migrated automatically.

Set target to choose the generated runtime:

• react (default): generates the reactor plus bound React hooks
• core: generates only the typed reactor exports with no React dependency Use --bindgen-only when you only want the generated declaration files. In that mode, the CLI skips index.generated.ts and index.ts entirely and leaves any existing reactor files untouched.

You can define target globally or per canister in ic-reactor.json.

When To Use The CLI

• non-Vite apps
• CI or explicit build pipelines
• projects that want manual control over when generation runs

Use @ic-reactor/vite-plugin instead when you want watch-mode regeneration inside a Vite app.

Requirements

• Node.js 18+
• TypeScript 5+
• @ic-reactor/react in the consuming app if you use target: "react"
• @ic-reactor/core in the consuming app if you use target: "core" with Reactor or DisplayReactor
• @ic-reactor/candid in the consuming app if you use target: "core" with a candid reactor class

See Also

• Docs: https://ic-reactor.b3pay.net/v3/packages/cli
• @ic-reactor/codegen: ../codegen/README.md
• @ic-reactor/vite-plugin: ../vite-plugin/README.md