Skip to content
Icon Forge

Use — Overview

The use side of Icon Forge is about getting published packs into your codebase. The CLI installs icon components as local source files — no icon font, no sprite sheet. Just component files you import like your own code.

Installing Packs

First-run flow, output structure, framework selection, and conflict handling.

Read more →

Using Icons in Code

How the installed components behave in React, Vue, and React Native — imports, styling, props.

Read more →

Config & Lockfile

How iconforge.json and iconforge-lock.json track your installs.

Read more →

Updating & Pinning

Pulling new versions, pinning releases, and previewing changes.

Read more →

The install flow

Section titled “The install flow”

  1. Get the pack identifier from the design team — something like acme/brand/core-icons.

  2. Run npx @icon-forge/cli install acme/brand/core-icons from your project root. The CLI will ask for your framework and any other settings it needs.

  3. The CLI resolves the manifest, downloads the components, and writes them into your project.

  4. Import the icons from the generated barrel file or individual component files.

  5. Commit iconforge.json, iconforge-lock.json, and the installed component directory.

That’s the happy path. The rest of this section covers the details — output layout, config options, updating, and what to do when things go wrong.