@icon-forge/cli

Install published Icon Forge icon packs into your project.

Usage

npx @icon-forge/cli install <org>/<project>/<pack> --framework react
npx @icon-forge/cli install <org>/<project>/<pack> --framework vue

Options

| Option | Description | |--------|-------------| | --framework <react\|vue> | Target framework (required on first install) | | --output-dir <path> | Base output directory (default: src/components/icons) | | --dir-name <name> | Override the pack leaf directory name. | | --api-url <url> | Backend URL (default: build-time value, https://iconforge.ai by default) | | -h, --help | Show help | | -v, --version | Show version |

How It Works

1. Resolves the latest published release for the specified icon pack
2. Downloads the install manifest and component source files
3. Writes components to {outputDir}/{pack-slug}/ by default, or {outputDir}/{custom-name}/ when --dir-name is used
4. Generates a barrel/index file for convenient imports
5. Records install state in iconforge.json and iconforge-lock.json

API URL Resolution

The CLI resolves its backend URL in this order:

1. --api-url <url>
2. ICONFORGE_API_URL
3. The build-time default baked into the package (https://iconforge.ai by default)

To build the CLI with a different baked-in default, set:

ICONFORGE_DEFAULT_API_URL=https://staging.iconforge.ai pnpm --dir cli build

Local State

The CLI writes two files at your project root:

• iconforge.json — User config: framework, output directory, installed packs. Commit this.
• iconforge-lock.json — Resolved state: version hashes, file list. Commit this for reproducible installs.

Development

cd cli
npm install
npm run build     # Build with tsup
npm test          # Run tests
npm run typecheck # Type check