-
Notifications
You must be signed in to change notification settings - Fork 4
CLI Companion Export
Saves everything the companion remembers into a directory you choose: one
bundle.json holding episodes, observations, conversations, beliefs, claims,
facts, core memory and the non-secret reasoner settings, plus, with
--include-media, a media/ directory of the original voice notes, PDFs,
images and videos.
Usage:
ed companion export <directory> [--include-media] [--json] [--endpoint <url>]
| Name | Type / values | Default | What it does |
|---|---|---|---|
<directory> |
path | required | Where the bundle is written. Created if missing; ~ expands. |
--include-media |
flag | off | Also download every media file behind the episodes. |
--json |
flag | off | Emit JSON on stdout. |
--endpoint |
URL | resolution order | Companion API base URL. |
Examples:
ed companion export ~/backups/companion
ed companion export ~/backups/companion --include-media
ed companion export /tmp/before-wipe --json
--json shape:
{
"counts": {
"beliefs": 17,
"episodes": 42,
"observations": 64
},
"directory": "/Users/me/backups/companion",
"mediaFailed": [],
"mediaSaved": 39
}Tokens and API keys never leave the companion: the bundle carries the reasoner
provider, URL and model, but not its key and not the connector tokens. Without
--include-media the bundle still lists every media file it left behind, and
the command says how many stayed, so a later --include-media run completes
the backup. The bundle restores with
ed companion import, and importing is idempotent, so exporting
before a risky operation is cheap insurance. Media files land as
media/<sha256>-<name>, which is exactly the layout import expects.
The destination directory may already exist. bundle.json and media files
with matching names are overwritten; unrelated or stale files are not removed.
Export validates that the API response decodes as a companion manifest before
writing it. A media download failure does not discard the bundle or fail the
whole command: failed basenames appear in mediaFailed and in a stderr note.
For a complete backup, require that mediaFailed is empty and compare
mediaSaved with the length of the media manifest in bundle.json.
-
ed companion import, the other half -
ed companion wipe, what to export before -
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