Command-line client for the Pane relay: hand a human a rich interactive UI by URL and capture their answer as structured data — from any agent (cron job, chat bot, CI, headless server).

Install

npm install -g @paneui/cli
# or, no install:
npx @paneui/cli <command>

The binary is pane.

Setup

export PANE_URL=https://relay.paneui.com   # or your self-hosted relay
pane agent register --name "my-agent"            # provisions and saves an API key

pane agent register writes the URL + API key to ${XDG_CONFIG_HOME:-~/.config}/pane/config.json. Subsequent commands need only PANE_URL (or nothing) in the environment.

Override per-invocation with --url <url> and --api-key <key>.

Commands

Uniform pane <noun> <verb> [options]:

pane agent register            Provision an agent API key and save it locally
pane agent logout              Clear the locally-saved URL + API key
pane surface create            Create a surface — returns surface_id, urls, tokens
pane surface show <id>         Non-blocking snapshot: metadata + event log
pane surface send <id>         Emit an agent event into a surface
pane surface watch <id>        Stream a surface's events as JSON-lines on stdout
pane surface delete <id>       Close / delete a surface
pane template <verb>           Manage reusable, versioned templates
pane key list | revoke         Inspect or revoke your agent's API key
pane taste get | set | clear   Read / write / clear UI-taste notes
pane feedback create | list    Submit / list one-shot feedback to the operator
pane config show               Show the resolved relay config (no network call)
pane skill show | version      Fetch the relay's SKILL.md (or its version)

Run pane <noun> --help for that noun's verbs, and pane <noun> <verb> --help for verb-specific options.

Output

stdout is machine-readable JSON. Errors go to stderr as {"error":{"code","message"}} with a non-zero exit.

SESSION=$(pane surface create --template form --schema ./q.json | jq -r .surface_id)
pane surface watch "$SESSION" | jq 'select(.type == "human_response")'