Skip to content

CLI Companion Runs

github-actions[bot] edited this page Aug 16, 2026 · 2 revisions

ed companion runs

Lists the background learning runs the scheduler has recorded.

Usage:

ed companion runs [--json] [--endpoint <url>] [--limit <n>]

Options:

Name Type / values Default What it does
--json flag off Emits one JSON document on stdout.
--endpoint URL resolution order Uses this Companion API base URL.
--limit 1 to 200 10 How many to list.

--json shape:

[
  {
    "finishedAt": "2026-08-10T02:03:11Z",
    "id": "b0a3e2c1-9a70-40dd-b1b4-2e0a1f5c7d90",
    "ok": true,
    "startedAt": "2026-08-10T02:00:00Z",
    "steps": [
      { "name": "sync_github", "ok": true },
      { "name": "sync_notion", "ok": true },
      { "name": "index", "ok": true },
      { "name": "baselines", "ok": true },
      { "name": "extract_claims", "ok": true },
      { "name": "corroborate", "ok": true },
      { "name": "reflect", "ok": true }
    ]
  }
]

Examples:

$ ed companion runs --limit 1
1. 2026-08-10T02:00:00Z  ok  sync_github, sync_notion, index, baselines, extract_claims, corroborate, reflect

Behaviour: read-only. The companion runs the pipeline once a night at COMPANION_REFLECT_AT (02:00 by default) in the backend's local time, or continuously every COMPANION_SCHEDULE_EVERY_SECONDS when that testing override is at least 30 seconds. Missing connector tokens and a missing reasoning provider are successful skipped steps. Other failed steps set the run's ok false and gain a ! suffix in human output. The backend stores step details, but this CLI command intentionally emits only each step's name and ok. POST /v1/nightly/run triggers one manually.

Where to go next

CLI reference

Getting Started
Config
App
Extensions
Permissions
Usage
System
Music
Calendar
Clipboard
Color
Download
Apps
Tools
Shelf
Cleaner
Machines
Machines Remote
Machines Docker
Machines Files
Machines Power
Machines Workspace
Companion
Herdr
Lid Awake
Machines Thermal

Guides

Clone this wiki locally