Skip to content
Open app

CLI reference

Every intraface command, subcommand and flag, plus the exit codes your scripts and agents can branch on. Generated from the CLI itself.

CLI 0.4.0 · MCP · API v1View as MarkdownEdit on GitHub
GET /docs/reference/cli.mdtext/markdown

The intraface CLI pulls a board into a folder, previews it and publishes your changes. It needs Node.js 22 or newer; npx intraface@latest <command> runs the latest version without installing anything.

Every command prints one JSON document on stdout with --json: { "ok": true, … } or { "ok": false, "error": { "code", "message", "hint" } }.

Flags every command takes

  • --json: Print one machine-readable JSON document on stdout
  • --api <value>: Intraface address (default: INTRAFACE_API, else https://app.intraface.cc)

Commands

intraface login

Sign in from this machine (browser, or --device for headless machines)

FlagDoes
--deviceUse a device code instead of a browser callback
--label <value>Name for this token (default: "intraface CLI on <hostname>")
--agent <value>Which agent uses this token, e.g. claude-code

intraface logout

Revoke and forget the token stored for this Intraface address

FlagDoes
--keep-tokenOnly forget it here; the token keeps working

intraface whoami

Who you are signed in as

intraface new

Turn a folder (or one HTML file) into a new board

FlagDoes
<path>Folder or .html file (default: this folder)
--title <value>Board title (default: the page’s <title>)
--type <value>Board type: travel, compliance, review, launch, dossier, blank, upload (default: upload)
--localizeBring outside, inline and remote media into assets/ first (--no-localize skips it) Default: true.
--keep-remoteLeave remote images, video and audio where they are
--allow-outsideAlso copy data files (json, csv, pdf, …) from outside the folder
--allow-privateAlso download from private and local addresses (intranet images)

intraface pull

Download a board into a folder you (and your agent) can edit

FlagDoes
<board>Board URL (https://app.intraface.cc/b/<slug>) or slug (with --merge: default this working copy)
<dir>Folder (default: the board’s slug)
--forceUpdate a working copy even though it has local changes
--mergeMerge the board’s latest version into your local changes
--ours <value>With --merge: settle these conflicted paths with your side
--theirs <value>With --merge: settle these conflicted paths with the board’s side

intraface export

Download a board version as a zip that opens offline (or one HTML file)

FlagDoes
<board>Board URL (https://app.intraface.cc/b/<slug>) or slug Required.
--at <value>Version number (default: the latest)
--out <value> -oFolder to save in, or a file path (default: this folder)
--htmlOne HTML file with its assets inside (one-page versions up to 5 MB)
--forceOverwrite a file that’s already there

intraface publish

Publish this folder’s changes to the board as a new version

FlagDoes
--message <value> -mWhat you changed (shown in the board’s history)
--resolves <value>Comment ids this closes, comma-separated (ids from `intraface comments`)
--agent <value>Your agent’s name (default: INTRAFACE_AGENT, else intraface-cli)
--rebaseMerge automatically when the board moved on (--no-rebase stops with exit 2) Default: true.
--ours <value>Settle these conflicted paths with this folder’s side (comma-separated)
--theirs <value>Settle these conflicted paths with the board’s side (comma-separated)
--localizeBring outside, inline and remote media into assets/ first (--no-localize skips it) Default: true.
--keep-remoteLeave remote images, video and audio where they are
--allow-outsideAlso copy data files (json, csv, pdf, …) from outside the folder
--allow-privateAlso download from private and local addresses (intranet images)

intraface resolved

Mark conflicted files from the last merge as settled by hand

FlagDoes
<path>Paths (as listed by the merge); several allowed

intraface comments

Comments on the board (open ones by default), with ids for --resolves

FlagDoes
<board>Board URL or slug (default: this working copy)
--openOnly open comments (the default)
--allOpen and resolved comments
--for-agentOnly comments asking an agent to do something

intraface reply

Reply to a comment thread

FlagDoes
<id>Comment id (or its first 8 characters) Required.
--message <value> -mThe reply Required.
--board <value>Board URL or slug (default: this working copy)

intraface resolve

Mark a comment thread resolved (your own, or any as an editor)

FlagDoes
<id>Comment id (or its first 8 characters) Required.
--board <value>Board URL or slug (default: this working copy)

intraface assets

Show what publish would bring into assets/ (outside, inline and remote media); --fix does it now

FlagDoes
--fixCopy, extract and download now, and rewrite the references
--keep-remoteLeave remote images, video and audio where they are
--allow-outsideAlso copy data files (json, csv, pdf, …) from outside the folder
--allow-privateAlso download from private and local addresses (intranet images)

intraface assets add

Add images, video, audio or data files to assets/ and print the path to use

FlagDoes
<source>Files or http(s) URLs Required.
--via-serverHave Intraface fetch URLs (what agents without a disk use)
--allow-outsideAlso copy data files (json, csv, pdf, …) from outside the folder
--allow-privateAlso download from private and local addresses (intranet images)

intraface agent

Connect a coding agent to Intraface (`intraface agent install`)

intraface agent install

Set up Claude Code: the Intraface MCP server and an Intraface skill

FlagDoes
--client <value>Which agent to set up (claude) Default: claude.
--printOnly print what to run; change nothing
--liveAlso add the intraface-live hook plugin: subagents and coarse steps in the watch tray

intraface agent event

Tell Intraface what a Claude Code agent is doing (run by the intraface-live plugin’s hooks)

FlagDoes
--hookRead one Claude Code hook event (JSON) from stdin

intraface revert

Publish an earlier version again as the newest one (editors)

FlagDoes
<n>The version to go back to Required.
--board <value>Board URL or slug (default: this working copy)

intraface approve

Approve a publish waiting on an approval-mode board (editors)

FlagDoes
<id>Publish id Required.

intraface reject

Reject a publish waiting on an approval-mode board (editors)

FlagDoes
<id>Publish id Required.
--message <value> -mWhy (shown to the author)

intraface status

What changed in this working copy since it was pulled

FlagDoes
--remoteAlso check whether the board has moved on since your base version

intraface diff

Line-by-line changes since the base version

FlagDoes
<paths>Only these files

intraface dna

Design DNA of a page: colours, type, anchors, blocks, runtime

FlagDoes
<file>HTML file (default: the board’s entry, or index.html)

intraface preview

Serve this folder locally, exactly as Intraface will (Ctrl-C to stop)

FlagDoes
<dir>Folder (default: this working copy)
--port <value>Port (default 4321, or a free one)
--openOpen it in the browser

intraface log

Versions of the board, newest first

FlagDoes
<board>Board URL or slug (default: this working copy)
--limit <value>How many (default 20, max 100)

intraface open

Open the board in your browser

FlagDoes
<board>Board URL or slug (default: this working copy)

Exit codes

CodeNameMeans
0okDone.
1failedSomething went wrong that retrying may fix (network, server).
2needsHumanA person or agent has to sort something out first: merge conflicts marked in the files, local changes in the way, a folder that isn’t a board.
3authNot signed in, or the token expired: run `intraface login`.
4forbiddenNot allowed, or the board doesn’t exist or isn’t shared with you.
5validationInvalid input: read the error’s hint.