system

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

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

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/system/install/{target}
  • Auth
    none declared

Path parameters

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

Install target identifier: tmux, gh, claude, codex, opencode, opencode-v2, 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.

expectedDestinationstring

Expected or adapter-resolved executable destination.

finishedAtstring date-time nullable

Absent until the job finishes.

methodstring

Server-owned installation method selected for this harness job.

noticestring

Fixed user-visible consequence to acknowledge before running this install.

outputstring

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

startedAtstring date-time nullable
status'idle' | 'running' | 'waiting_for_idle' | 'installing' | 'verifying' | 'succeeded' | 'failed' | 'unsupported' | 'interrupted' required

Current lifecycle state of the job. waiting_for_idle: the update runs once every session using the harness is idle (Windows).

target'tmux' | 'gh' | 'claude' | 'claude-code' | 'codex' | 'cursor' | 'opencode' | 'opencode-v2' | 'aider' | 'copilot' | 'grok' | 'kimi' | 'pi' | 'amp' | 'auggie' | 'droid' | 'crush' | 'cline' | 'goose' | 'qwen' | 'gemini' | 'continue' | 'devin' | 'kiro' | 'kilocode' | 'vibe' | 'muse' | 'agy' | 'autohand' | 'kimchi' | 'prime-agent' | 'omp' | 'fx' | 'unreal-agent' | 'codewhale' | 'mimo-code' | 'deepseek-harness' | 'openhands' | 'command-code' | 'memcode' | 'hermes' | 'cloudflared' required

Fixed install target this job ran (or is running) for.

updatedAtstring date-time nullable

Changes

  • 8dd454f77e02Revision changes
    • warning

      added the new hermes enum value to the response property for the response status

  • 8f160e6183cdRevision changes
    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status