-
Notifications
You must be signed in to change notification settings - Fork 4
CLI Companion Search
github-actions[bot] edited this page Aug 9, 2026
·
2 revisions
Searches embedded memory chunks with hybrid vector and full-text retrieval.
Usage:
ed companion search <query> [--limit <n>] [--json] [--endpoint <url>]
Arguments:
| Name | Type / values | Default | What it does |
|---|---|---|---|
<query> |
text | required | Supplies the memory search text. |
Options:
| Name | Type / values | Default | What it does |
|---|---|---|---|
--limit |
integer from 1 to 50
|
8 |
Asks for this many ranked hits. |
--json |
flag | off | Emits one JSON array on stdout. |
--endpoint |
URL | environment or local default | Uses this Companion API base URL. |
--json shape:
[
{
"chunkId": "ad5085e1-6c90-471f-a58d-16e028423d10",
"episodeId": "5d4c0ebf-1086-46fb-ab93-dd325ed197f3",
"kind": "md",
"occurredAt": "2026-08-09T06:30:00Z",
"ord": 0,
"score": 0.032787,
"snippet": "The launch plan calls for a staged rollout after the warden review.",
"title": "Planning notes"
}
]Each hit identifies its chunk and parent episode with chunkId and
episodeId. ord is the chunk position in the episode. title, occurredAt
and kind describe the source episode, snippet contains matching text, and
score is the fused retrieval score.
Examples:
$ ed companion search "launch plan" --limit 3
# SCORE TITLE OCCURRED
1 0.032787 Planning notes 2026-08-09T06:30:00Z
1 The launch plan calls for a staged rollout after the warden review.
$ ed companion search "nothing like this" --json
[]
Behaviour: this is a read-only GET /v1/search. The query is URL encoded and
--limit must be from 1 through 50. No hits print no matches in human output
or [] with --json. If the embedding service returns HTTP 502, the command
names the Ollama embedding service, leaves stdout empty, and 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