-
Notifications
You must be signed in to change notification settings - Fork 4
CLI Companion Stack
Starts, stops and inspects the companion stack on whichever machine
ed companion deploy put it on.
Usage:
ed companion stack <subcommand>
| Command | What it does |
|---|---|
ed companion stack status |
Which host runs it, and which services are up. |
ed companion stack up |
Starts it. |
ed companion stack down |
Stops it. |
ed companion stack restart |
Restarts it. |
ed companion stack logs |
Reads its logs. |
ed companion stack env |
Prints the environment it would be given. |
status is the default subcommand.
Every stack command uses the saved deployment record. It runs locally with
/bin/sh or over the registered machine's SSH transport, changes into the
saved directory, selects the saved tier's Compose files, and always uses
Compose project name edith-companion.
$ ed companion stack status
running on Studio Mac, cpu, reached on port 4820
SERVICE STATUS PORTS
api Up 28 minutes 127.0.0.1:4820->4820/tcp
postgres Up About an hour (healthy) 127.0.0.1:5432->5432/tcp
redis Up About an hour (healthy) 127.0.0.1:6379->6379/tcp
Takes --json. The JSON shape is
{deployed:true,deployment,services:[{service,status,ports,running}]}. With no
saved deployment, JSON succeeds with {deployed:false,services:[]}; human mode
exits 1 and points to ed companion hosts.
Takes --build to run up -d --build; without it this is up -d. Also takes
--json. It does not rewrite source, Compose files or .env; rerun deploy for
that installation work.
Takes --wipe to run down -v, deleting the project's named volumes, and
--json. Without it the data survives.
--wipe is irreversible. It removes Postgres memory, the vault, Ollama models,
the speech model and the GPU reranker cache where present. Export with
ed companion export <dir> --include-media first. The deployment record and
local companion configuration survive, but the deleted volume contents do not.
Takes --json. This uses Compose restart; it does not rebuild images or
recreate containers with changed environment.
ed companion stack logs [<service>] [--tail <n>] [--json]
Reads the whole stack's logs, or one service's. --tail defaults to 100 and
must be positive. Output is non-following and has no color. --json is
{service,lines}, where service is null for the whole stack.
Prints the environment file the stack is given, rendered from your
configuration. Secrets are blank unless --reveal is passed, because they live
in the Keychain and never in the config file. Takes --json, which returns an
object mapping each environment key to its rendered string value.
--reveal prints connector tokens, provider keys and passwords to stdout,
including in JSON. Do not use it in shared terminals, captured logs or CI
artifacts.
-
ed companion hostslists where it could run. -
ed companion doctorchecks it once it is up. -
ed companion, the rest of this group
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