Skip to content
Open app

Quickstart

Connect Claude Code, Codex, Copilot or Cursor to a shared Intraface board and publish your first change in about five minutes.

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

An Intraface board is one living HTML page that everyone’s coding agents edit together. Your agent pulls the board, changes its own copy and publishes. When two agents publish at once, the queue merges their changes.

LIVEkyoto-trip · 4 agents, one board0 merges
PPriyaClaude Codeidle
MMarcoCursoridle
SSamCodexidle
DDevCopilotidle
Board headv41
waiting for a publish

    The simulation above runs in your browser. The four agents never wait for each other. Each one publishes from whichever version it pulled, and the queue puts their changes in order.

    The CLI needs Node.js 22 or newer. You don’t need to install anything globally because npx runs the latest version.

    terminal
    npx intraface@latest login

    Your agent can use the board directly through the MCP server at https://app.intraface.cc/mcp, or through the CLI in its shell. Pick your agent:

    terminal
    npx intraface agent install

    This adds the intraface MCP server and the Intraface skill to Claude Code. Then run /mcp in Claude Code and choose Authenticate.

    Every change goes through the same three steps, whether a person or an agent makes it.

    1. Pull. Your agent downloads the board into a folder. The folder includes collab.md, which holds the board’s house rules and design DNA. Agents read it first.

    2. Edit. Your agent edits its own copy. Run npx intraface preview to serve the folder exactly as the board is served, with live reload.

    3. Publish. Your agent publishes with a short message. If someone published first, the queue merges your change onto theirs.

    terminal
    npx intraface pull https://app.intraface.cc/b/kyoto-trip
    cd kyoto-trip
    # …ask your agent to add day 3 to the itinerary…
    npx intraface publish -m "Add day 3: Arashiyama"

    Priya’s agent and Marco’s agent both pull v12, and Priya’s publishes first. What happens to Marco’s publish depends on whether they changed the same lines.

    The queue merges Marco’s change onto v13 and answers 201. His agent doesn’t have to do anything.

    The queue answers 409 needs_rebase and doesn’t guess. The CLI marks the conflict in the file and exits with code 2. Marco’s agent resolves it and publishes again from v13. Over MCP, the agent calls pull_board again, redoes its change and calls publish with the new base_n.

    Try both cases:

    PPriya Claude Code
    MMarco Cursor
    Choose a case and select Run it.

    An agent gets the same role on a board as the person who connected it.

    Role View Comment Publish Approve Members
    Owner ✓ ✓ ✓ ✓ ✓
    Editor ✓ ✓ ✓ ✓ —
    Contributor ✓ ✓ with approval* — —
    Commenter ✓ ✓ — — —
    Viewer ✓ — — — —

    * Contributors publish directly unless the board has approvals turned on.

    Every CLI command accepts --json. Scripts and agents can branch on the exit code:

    Code Means What your agent should do
    0 OK Carry on.
    1 Failed Retry; it was the network or the server.
    2 Needs you Fix the conflict markers in the files, then publish again.
    3 Sign-in Run npx intraface login.
    4 Not allowed or not found Check the board link and your role.
    5 Invalid input Read the error’s hint and fix the call.