The forkshop CLI manages the scaffold layer Forkshop drops into your project. Four commands.

init

Adds Forkshop to a Next.js App Router project. Run once.

npx forkshop init

| Flag | Description | |--------------------------|--------------------------------------------------------------| | --force | Overwrite existing files. | | --registry <url> | Use an alternate registry URL. | | --install-claude-pack | Drop the Claude Code activity hook. See Live AI agents. | | --no-install | Skip the automatic package-manager install. |

Init merges @forkshop/engine into package.json and runs your detected package manager's install (pnpm install, npm install, or yarn). Pass --no-install if you'd rather run install yourself — useful in CI or scripted setups.

Once install finishes, open Claude Code in the project and say "set up Forkshop" to scaffold your first Board.

Aborts if forkshop.json already exists. Use update to refresh.

update

Refreshes the scaffold against the latest manifest.

npx forkshop update

| Flag | Description | |---------------------|----------------------------------------------| | --check | Dry-run. Exits non-zero if any file drifted. | | --force | Overwrite locally edited files. | | --registry <url> | Use an alternate registry URL. |

Prompts before overwriting locally edited files. Offers a soft @forkshop/engine version bump if a newer engine is available.

diff <path>

Shows a unified diff between your local copy of a scaffolded file and the upstream version.

npx forkshop diff app/forkshop/CLAUDE.md

| Flag | Description | |---------------------|------------------------------| | --registry <url> | Use an alternate registry URL. |

add <bundle>

Not available yet. Reserved for future community bundles.

forkshop.json

The lockfile init writes at your project root. Records the pinned @forkshop/engine version and a checksum of every scaffolded file. update reads it to detect drift. Commit it.

Uninstall

There's no forkshop uninstall command. To remove Forkshop manually:

# 1. Delete the scaffold layer
rm -rf app/forkshop app/api/forkshop forkshop.json
rm -rf .claude/skills/forkshop-*.md
rm -rf .claude/hooks/forkshop-post-tool-use.sh   # if you installed it
rm -rf public/fonts/forkshop

# 2. Remove the dep
pnpm remove @forkshop/engine
# or: npm uninstall / yarn remove

Then by hand:

• Delete the @import "@forkshop/engine/forkshop.css"; line from your globals.css.
• If you wired the locator: remove @locator/webpack-loader from package.json and its loader rule from next.config.*, and delete any <EditorLink /> mount in your root layout.
• If you installed the Claude Code hook: remove its entry from .claude/settings.json.

Restart your dev server.