-
Notifications
You must be signed in to change notification settings - Fork 4
CLI Companion Doctor
github-actions[bot] edited this page Aug 9, 2026
·
3 revisions
Asks the backend to check each service it depends on.
Usage:
ed companion doctor [--json] [--endpoint <url>]
Options:
| Name | Type / values | Default | What it does |
|---|---|---|---|
--json |
flag | off | Emits one JSON document on stdout. |
--endpoint |
URL | environment or local default | Uses this Companion API base URL. |
--json shape:
{
"checks": [
{ "detail": "connected", "name": "postgres", "ok": true },
{ "detail": "3 of 3 migrations applied", "name": "migrations", "ok": true },
{ "detail": "installed", "name": "pgvector", "ok": true },
{ "detail": "connected", "name": "redis", "ok": true },
{ "detail": "writable", "name": "vault", "ok": true }
],
"ok": true
}ok is true only when every check passed. Each item in checks has the
dependency name, its own Boolean ok, and a human-readable detail from the
backend.
Examples:
$ ed companion doctor
postgres ok connected
migrations ok 3 of 3 migrations applied
pgvector ok installed
redis ok connected
vault ok writable
$ ed companion doctor --json
{
"checks": [
{ "detail": "connected", "name": "postgres", "ok": true }
],
"ok": true
}
Behaviour: doctor decodes the health report even when the API returns HTTP
503. A reachable but unhealthy backend still exits 0 because health lives in
the payload, where scripts can inspect ok. Failure to reach the API exits 4.
-
ed companion, the rest of this group - All
edcommands
Auto-generated from docs/, edit the docs in the repo, not the wiki.
CLI reference
Companion
- Deploy
- Concepts
- Concepts Memory
- Concepts Ingestion
- Concepts Search
- Concepts Chat
- Concepts Learning
- Concepts Brain
- Concepts Friend
- Hosts
- Stack
- Status
- Doctor
- Search
- Index
- Ingest
- Episodes
- Sync
- Observations
- Reflect
- Beliefs
- Ask
- Extract
- Claims
- Corroborate
- Runs
- Chat
- Conversations
- Forget
- Export
- Import
- Erase
- Wipe
- Episode
- Nightly
- Reason
- Personas
- Council
- Lenses
- Core
- Why
- Hypotheses
- Predictions
- Commitments
- Discrepancies
- Calibration
- Inquire
- Entities
- Eval
- Standup
- Machines
- Baselines
- Connectors
- Facts
- Correct
- Weekly
- Db
Guides