-
Notifications
You must be signed in to change notification settings - Fork 4
CLI Companion Deploy
Chooses the machine that runs the companion, brings the stack up there, and remembers the choice so everything else knows where it lives.
Usage:
ed companion deploy [<machine>] [--directory <path>] [--port <n>] [--adopt] [--json]
Options:
| Name | Type / values | Default | What it does |
|---|---|---|---|
--json |
flag | off | Emits one JSON document on stdout. |
--directory |
path | ~/edith-companion |
Where the stack runs on that machine. |
--port |
number | 4820 | Local port the API is reached on. |
--adopt |
flag | off | Records a stack that is already running without starting anything. |
With no machine argument it uses the one that already hosts the stack, or the best candidate that can run it.
Examples:
$ ed companion deploy "TUF Wired"
the companion running on TUF Wired, cpu, reached on port 4820
$ ed companion deploy "TUF Wired" --adopt
the companion running on TUF Wired, cpu, reached on port 4820
A machine that cannot run it yet is refused with the reason and the fix, so nothing half-starts. The tier is derived from what the host actually has: a GPU box gets the GPU overlay, a Mac gets the Apple one, everything else gets CPU.
Deploying installs everything it needs on the way: the directory is created,
the compose files and Dockerfile the CLI carries are written into it, the
companion source is copied over when the directory does not have it yet (from
EDITH_COMPANION_SOURCE or a local checkout), and a .env is written from
the saved configuration and the Keychain secrets. The stack then starts with
--build, so a changed source or compose file is rebuilt and an unchanged one
starts instantly. For a remote machine the port forward is saved and opened
too, so ed companion status works the moment deploy returns.
-
ed companion hostsshows the candidates first. -
ed companion stackdrives it once it is deployed. -
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