Reference

CLI reference

Reference for Fygment CLI commands: sign-in, setup, install, check, update, readiness, lockfile, sync, doctor, and import.

Audience: Power users and workspace operators using Fygment from a terminal.
Updated: 2026-10-25

The CLI is the local bridge between a governed workspace and writable AI harness targets. Use it for setup, install state, update checks, setup checks, and selected imports.

Get the fygment command

Run npm install -g fygment once. After that, run fygment followed by a command, such as fygment setup.

npx fygment <command> also works if you prefer not to install the package. Running npx fygment by itself does not put fygment on your PATH.

Non-interactive shells

When there is no terminal, fygment install, fygment update, and fygment sync stop before they write files. Add --yes to confirm the write.

fygment setup also needs --workspace=<workspace-slug> when there is no terminal.

Sign-in and setup

fygment auth login --workspace=<workspace-slug>

fygment auth logout

Removes the local config file only. It does not revoke server tokens or remove MCP entries from your tools.

fygment setup

Create or refresh local configuration for a workspace and target tools. Use --target= with codex, claude-code, cursor, gemini-cli, antigravity, or all. Also accepts --workspace, --dry-run, and --yes.

fygment doctor

Prints local setup facts: whether a config file is present, the workspace, install counts, and default install paths. It does not test the connection.

Install and check

fygment install <skill-slug> --target=<target>

Install an approved Skill into a target. Without --target, it installs to Claude Code. Use --path=<dir> to set the install folder. In a non-interactive shell, add --yes.

fygment check --target=<target>

Compare local Skill installs with workspace-approved versions and policy decisions.

fygment update [slug ...] --target=<target>

Apply approved package updates. Add --all to update every tracked install, and --yes in a non-interactive shell.

fygment list --target=<target>

Lists tracked local installs. Add --json for JSON output or --paths to show install paths.

fygment readiness --target=codex

Offline checklist. It checks the saved config file, a local Skill import, the install, and tracked installs. It does not check sign-in or the MCP connection.

Local Skills

fygment discover-local-skills

Looks for Skills already on this machine in known tool folders. Add --path=<dir> to search one folder, or --json for JSON output.

fygment scan --path=<dir>

Runs a local trust scan on one Skill folder. Add --json for JSON output.

fygment import-local-skill --path=<dir>

Imports one local Skill folder into your workspace after the trust check. Add --dry-run to check it without importing.

fygment register-harness --type=<type>

Registers a local tool with your workspace so Fygment can track installs there. Types: claude-code, claude-desktop, codex, opencode, cursor, openclaw, or custom.

GitHub import and lockfile

fygment import github preview <url>

Lists the Skill candidates in a public GitHub repository so you can choose one.

fygment import github <url> --candidate=<path>

Imports the candidate you chose in the preview step.

fygment lock write

Writes fygment.lock, or the file named with --output=. It is a Skills-only lockfile that records each Skill and its pinned version.

fygment sync --lock=fygment.lock

Installs the Skills in a lockfile into local targets. Add --dry-run to preview. In a non-interactive shell, add --yes.

Setup targets

codex, claude-code, cursor, gemini-cli, antigravity, or all.

Install targets

codex, claude-code, claude-desktop, openclaw, opencode, cursor, generic (needs --path), or remote-shell.

Environment variables

FYGMENT_APP_URL sets the Fygment site the CLI uses. The default is https://fygment.dev.

FYGMENT_WORKSPACE sets the default workspace slug.

FYGMENT_API_KEY is a legacy key used only by fygment mcp proxy. Prefer fygment auth login.

Runtime commands

fygment runtime … commands exist for remote-shell runtimes. Run fygment --help to see the full list.

Related docs

Install Skills in Codex
Codex is a writable install target. Use the guided CLI path so Fygment can preview config changes and track install state.
Install Skills in Claude Code
Claude Code follows the same workspace-approved package model as Codex, with local writes kept explicit and previewable.
Set up Fygment MCP
MCP setup gives AI clients access to workspace-scoped Fygment tools. Hosted clients use OAuth; local clients use guided setup and a local authenticated proxy where needed.