Sign in
system

Start (or return the already-running) install job for a fixed system target

post/api/v1/system/install/{target}

Path parameters

targetstring required

Install target identifier: tmux, gh, claude, codex, opencode, copilot, or cloudflared.

Install target identifier: tmux, gh, claude, codex, opencode, copilot, or cloudflared.

Response

Accepted

commandstring

Human-readable install command, e.g. "brew install tmux", for display even before/without output.

errorstring

Set on failure or when the target is unsupported on this machine: the exec error, the Unsupported reason, or a timeout message.

finishedAtstring date-time nullable

Absent until the job finishes.

outputstring

Combined stdout+stderr from the install command, tail-capped to the last ~4000 bytes.

startedAtstring date-time nullable
status'idle' | 'running' | 'succeeded' | 'failed' | 'unsupported' required

Current lifecycle state of the job.

target'tmux' | 'gh' | 'claude' | 'codex' | 'opencode' | 'copilot' | 'cloudflared' required

Install target this job ran (or is running) for.

Changes

Changed in 2 of the 108 revisions of this API.11