-
Notifications
You must be signed in to change notification settings - Fork 4
CLI Companion Hosts
Lists every machine that could run the companion, this Mac first, and says what each one still needs. It answers the question "where would the containers run".
This command talks to your machines, not to the companion API, so it works when the backend is not running anywhere yet.
Usage:
ed companion hosts [--json] [--machine <name>]
Options:
| Name | Type / values | Default | What it does |
|---|---|---|---|
--json |
flag | off | Emits one JSON document on stdout. |
--machine |
machine name | every machine | Probes only this one. |
A * marks the machine that currently hosts the stack.
Examples:
$ ed companion hosts
NAME TARGET STATE DETAIL
Pulkit's MacBook Pro this Mac Apple Container is installed but not running darwin arm64 · 14 cores · 24 GB
* TUF Wired pulkit@10.77.0.2 ready linux x86_64 · 20 cores · 62 GB · Docker 29.7.1
the stack is running on TUF Wired, cpu, reached on port 4820
Each host reports its os, arch, cores, memory, free disk, GPU, which container runtimes are installed and whether their daemon is running, and which of the ports the stack needs are already taken. A machine that already hosts the stack is not blocked by its own ports.
A host is ready only when it is reachable, has at least 12,000 MB free, has a running Docker-compatible runtime with Compose, and ports 4820, 5432, 6379 and 11434 are free. Docker, Podman and Colima are probed; Apple Container is reported but cannot satisfy the Compose requirement. Installed-but-stopped runtimes and missing Compose are blockers. GPU presence only selects the GPU tier after those readiness checks pass.
--machine limits remote probes by case-insensitive full name, name prefix, or
exact host. local and a prefix of this mac select this Mac. The local row is
still included when a remote filter is supplied, so --machine server displays
this Mac plus the matching remote. An unmatched remote filter displays only
this Mac rather than producing a usage error.
--json is {hosts, deployment}. Each host includes id, name, target,
isLocal, reachable, hostsTheStack, canHostTheStack, tier, summary,
blockers and nullable facts. Each blocker has a headline and fix.
Runtime facts include kind, version, daemonRunning, composeVersion and
canRunTheStack. deployment is null until a deployment has been saved.
-
ed companion deploypicks the machine and brings it up. -
ed companion stackstarts, stops and inspects it. -
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