Documentation

CLI reference

Installation, project setup, sessions and maintenance commands.

install

Install one reusable Foundry skill and MCP connection for Codex, Cursor, and Claude Code.

install
npx foundry-design install

Options --agent codex,cursor,claude · --yes

launch

Install or update Foundry, repair the detected shared agent connection, validate the integration, and start or resume the visual session.

launch
npx foundry-design

Options --project PATH · --url URL · --new · --no-open · --no-dev · --no-start · --yes

reset

Migrate legacy project agent files and refresh the shared connection to one exact release while preserving customized files.

reset
npx foundry-design reset

Options --project PATH · --agent codex,cursor,claude · --url URL · --yes

companion

Show locally installed agents and recently opened projects without using an account or telemetry.

companion
npx foundry-design companion

Options --json

setup

Connect the project through the shared machine bridge and configure only its supported development integration.

setup
npx foundry-design setup --yes

Options --project PATH · --agent codex,cursor,claude · --agent none · --project-agent · --url URL · --yes

start

Start the loopback runtime, reuse or launch the project preview, and open an authenticated Foundry session.

start
npx foundry-design start

Options --project PATH · --url URL · --platform PLATFORM · --new · --no-open · --no-dev

doctor

Check project detection, instrumentation, agent connection, preview availability, and runtime health.

doctor
npx foundry-design doctor

Options --project PATH · --repair · --json

status

Report project integration, the installed MCP version, runtime health, and the live listener as separate readiness checks.

status
npx foundry-design status

Options --project PATH · --json

index

Inspect the project and output its local design graph for components, variants, tokens, and source mappings.

index
npx foundry-design index

Options --project PATH · --output FILE

export

Export a session as structured JSON, one agent prompt, or the complete local record.

export
npx foundry-design export <SESSION_ID>

Options --format json|prompt|full · --output FILE

install-agent

Add one reusable user-level skill and MCP connection for a coding agent.

install-agent
npx foundry-design install-agent <cursor|claude|codex>

Options --project-agent · --project PATH

disconnect

Remove the current project from Foundry's recent-project list without deleting its development adapter.

disconnect
npx foundry-design disconnect

Options --project PATH · --yes

uninstall

Remove Foundry-managed project integration while preserving files that contain user changes.

uninstall
npx foundry-design uninstall

Options --project PATH · --global · --agent codex,cursor,claude · --yes