590 lines
14 KiB
Plaintext
590 lines
14 KiB
Plaintext
{/*
|
|
GENERATED by honcho-cli/scripts/generate_cli_docs.py — do not edit.
|
|
Re-generate with: uv run --package honcho-cli python honcho-cli/scripts/generate_cli_docs.py
|
|
Source of truth: honcho-cli/src/honcho_cli/commands/
|
|
*/}
|
|
|
|
## honcho conclusion
|
|
|
|
List, search, create, and delete peer conclusions (Honcho's memory atoms).
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="create">
|
|
Create a conclusion.
|
|
|
|
```bash
|
|
honcho conclusion create <content>
|
|
```
|
|
|
|
<ParamField path="content" type="string" required />
|
|
<ParamField path="--observer" type="string">
|
|
Observer peer ID.
|
|
</ParamField>
|
|
<ParamField path="--observed" type="string">
|
|
Observed peer ID.
|
|
</ParamField>
|
|
<ParamField path="--session" type="string">
|
|
Session context. Short alias: `-s`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="delete">
|
|
Delete a conclusion.
|
|
|
|
```bash
|
|
honcho conclusion delete <conclusion_id>
|
|
```
|
|
|
|
<ParamField path="conclusion_id" type="string" required />
|
|
<ParamField path="--observer" type="string">
|
|
Observer peer ID.
|
|
</ParamField>
|
|
<ParamField path="--observed" type="string">
|
|
Observed peer ID.
|
|
</ParamField>
|
|
<ParamField path="--yes" type="boolean">
|
|
Skip confirmation. Short alias: `-y`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="list">
|
|
List conclusions.
|
|
|
|
```bash
|
|
honcho conclusion list
|
|
```
|
|
|
|
<ParamField path="--observer" type="string">
|
|
Observer peer ID.
|
|
</ParamField>
|
|
<ParamField path="--observed" type="string">
|
|
Observed peer ID.
|
|
</ParamField>
|
|
<ParamField path="--limit" type="number" default="10">
|
|
Max results.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="search">
|
|
Semantic search over conclusions.
|
|
|
|
```bash
|
|
honcho conclusion search <query>
|
|
```
|
|
|
|
<ParamField path="query" type="string" required />
|
|
<ParamField path="--observer" type="string">
|
|
Observer peer ID.
|
|
</ParamField>
|
|
<ParamField path="--observed" type="string">
|
|
Observed peer ID.
|
|
</ParamField>
|
|
<ParamField path="--top-k" type="number" default="10">
|
|
Max results.
|
|
</ParamField>
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## honcho config
|
|
|
|
Inspect CLI configuration.
|
|
|
|
```bash
|
|
honcho config
|
|
```
|
|
|
|
|
|
## honcho doctor
|
|
|
|
Verify config and connectivity. Scope with -w / -p to check workspace, peer, and queue health.
|
|
|
|
```bash
|
|
honcho doctor
|
|
```
|
|
|
|
|
|
## honcho help
|
|
|
|
Show help message.
|
|
|
|
```bash
|
|
honcho help
|
|
```
|
|
|
|
|
|
## honcho init
|
|
|
|
Set API key and server URL in ~/.honcho/config.json.
|
|
|
|
Press Enter to keep the current value or type a replacement.
|
|
Workspace / peer / session scoping is per-command via -w / -p / -s
|
|
or HONCHO_* env vars — never persisted.
|
|
|
|
```bash
|
|
honcho init
|
|
```
|
|
|
|
<ParamField path="--api-key" type="string">
|
|
API key (admin JWT).
|
|
</ParamField>
|
|
<ParamField path="--base-url" type="string">
|
|
Honcho API URL (e.g. https://api.honcho.dev, http://localhost:8000).
|
|
</ParamField>
|
|
|
|
## honcho message
|
|
|
|
List, create, and get messages within a session.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="create">
|
|
Create a message in a session.
|
|
|
|
```bash
|
|
honcho message create <content>
|
|
```
|
|
|
|
<ParamField path="content" type="string" required />
|
|
<ParamField path="--peer" type="string" required>
|
|
Peer ID of the message sender. Short alias: `-p`.
|
|
</ParamField>
|
|
<ParamField path="--metadata" type="string">
|
|
JSON metadata to associate with the message.
|
|
</ParamField>
|
|
<ParamField path="--session" type="string">
|
|
Session ID. Short alias: `-s`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="get">
|
|
Get a single message by ID.
|
|
|
|
```bash
|
|
honcho message get <message_id>
|
|
```
|
|
|
|
<ParamField path="message_id" type="string" required />
|
|
<ParamField path="--session" type="string">
|
|
Session ID. Short alias: `-s`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="list">
|
|
List messages in a session. Scoped to a peer with -p.
|
|
|
|
```bash
|
|
honcho message list [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
<ParamField path="--last" type="number" default="20">
|
|
Number of recent messages.
|
|
</ParamField>
|
|
<ParamField path="--reverse" type="boolean">
|
|
Show oldest first (default is newest first).
|
|
</ParamField>
|
|
<ParamField path="--brief" type="boolean">
|
|
Show only IDs, peer, token count, and created_at (no content).
|
|
</ParamField>
|
|
<ParamField path="--peer" type="string">
|
|
Filter by peer ID. Short alias: `-p`.
|
|
</ParamField>
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## honcho peer
|
|
|
|
List, create, chat with, search, and manage peers and their representations.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="card">
|
|
Get raw peer card content.
|
|
|
|
```bash
|
|
honcho peer card [<peer_id>]
|
|
```
|
|
|
|
<ParamField path="peer_id" type="string" />
|
|
<ParamField path="--target" type="string">
|
|
Target peer for relationship card.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="chat">
|
|
Query the dialectic about a peer.
|
|
|
|
```bash
|
|
honcho peer chat <query>
|
|
```
|
|
|
|
<ParamField path="query" type="string" required />
|
|
<ParamField path="--target" type="string">
|
|
Target peer for perspective.
|
|
</ParamField>
|
|
<ParamField path="--reasoning" type="string">
|
|
Reasoning level: minimal, low, medium, high, max. Short alias: `-r`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="create">
|
|
Create or get a peer.
|
|
|
|
```bash
|
|
honcho peer create <peer_id>
|
|
```
|
|
|
|
<ParamField path="peer_id" type="string" required />
|
|
<ParamField path="--observe-me" type="boolean">
|
|
Whether Honcho will form a representation of this peer. Negate with `--no-observe-me`.
|
|
</ParamField>
|
|
<ParamField path="--metadata" type="string">
|
|
JSON metadata to associate with the peer.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="get-metadata">
|
|
Get metadata for a peer.
|
|
|
|
```bash
|
|
honcho peer get-metadata [<peer_id>]
|
|
```
|
|
|
|
<ParamField path="peer_id" type="string" />
|
|
</Accordion>
|
|
<Accordion title="inspect">
|
|
Inspect a peer: card, session count, recent conclusions.
|
|
|
|
```bash
|
|
honcho peer inspect [<peer_id>]
|
|
```
|
|
|
|
<ParamField path="peer_id" type="string" />
|
|
</Accordion>
|
|
<Accordion title="list">
|
|
List all peers in the workspace.
|
|
|
|
```bash
|
|
honcho peer list
|
|
```
|
|
|
|
</Accordion>
|
|
<Accordion title="representation">
|
|
Get the formatted representation for a peer.
|
|
|
|
```bash
|
|
honcho peer representation [<peer_id>]
|
|
```
|
|
|
|
<ParamField path="peer_id" type="string" />
|
|
<ParamField path="--target" type="string">
|
|
Target peer to get representation about.
|
|
</ParamField>
|
|
<ParamField path="--search-query" type="string">
|
|
Semantic search query to filter conclusions.
|
|
</ParamField>
|
|
<ParamField path="--max-conclusions" type="number">
|
|
Maximum number of conclusions to include.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="search">
|
|
Search a peer's messages.
|
|
|
|
```bash
|
|
honcho peer search <query>
|
|
```
|
|
|
|
<ParamField path="query" type="string" required />
|
|
<ParamField path="--limit" type="number" default="10">
|
|
Max results.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="set-metadata">
|
|
Set metadata for a peer.
|
|
|
|
```bash
|
|
honcho peer set-metadata <metadata>
|
|
```
|
|
|
|
<ParamField path="metadata" type="string" required />
|
|
<ParamField path="--peer" type="string">
|
|
Peer ID (uses default if omitted). Short alias: `-p`.
|
|
</ParamField>
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## honcho session
|
|
|
|
List, inspect, view, create, delete, and manage conversation sessions and their peers.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="add-peers">
|
|
Add peers to a session.
|
|
|
|
```bash
|
|
honcho session add-peers <session_id> <peer_ids>
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" required />
|
|
<ParamField path="peer_ids" type="string" required />
|
|
</Accordion>
|
|
<Accordion title="context">
|
|
Get session context (what an agent would see).
|
|
|
|
```bash
|
|
honcho session context [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
<ParamField path="--tokens" type="number">
|
|
Token budget.
|
|
</ParamField>
|
|
<ParamField path="--summary" type="boolean" default="true">
|
|
Include summary. Negate with `--no-summary`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="create">
|
|
Create or get a session.
|
|
|
|
```bash
|
|
honcho session create <session_id>
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" required />
|
|
<ParamField path="--peers" type="string">
|
|
Comma-separated peer IDs to add to the session.
|
|
</ParamField>
|
|
<ParamField path="--metadata" type="string">
|
|
JSON metadata to associate with the session.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="delete">
|
|
Delete a session and all its data. Destructive — requires --yes or interactive confirm.
|
|
|
|
```bash
|
|
honcho session delete [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
<ParamField path="--yes" type="boolean">
|
|
Skip confirmation. Short alias: `-y`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="get-metadata">
|
|
Get metadata for a session.
|
|
|
|
```bash
|
|
honcho session get-metadata [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
</Accordion>
|
|
<Accordion title="inspect">
|
|
Inspect a session: peers, message count, summaries, config.
|
|
|
|
```bash
|
|
honcho session inspect [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
</Accordion>
|
|
<Accordion title="list">
|
|
List sessions in the workspace.
|
|
|
|
```bash
|
|
honcho session list
|
|
```
|
|
|
|
<ParamField path="--peer" type="string">
|
|
Filter by peer. Short alias: `-p`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="peers">
|
|
List peers in a session.
|
|
|
|
```bash
|
|
honcho session peers [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
</Accordion>
|
|
<Accordion title="remove-peers">
|
|
Remove peers from a session.
|
|
|
|
```bash
|
|
honcho session remove-peers <session_id> <peer_ids>
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" required />
|
|
<ParamField path="peer_ids" type="string" required />
|
|
</Accordion>
|
|
<Accordion title="representation">
|
|
Get the representation of a peer within a session.
|
|
|
|
```bash
|
|
honcho session representation <peer_id> [<session_id>]
|
|
```
|
|
|
|
<ParamField path="peer_id" type="string" required />
|
|
<ParamField path="session_id" type="string" />
|
|
<ParamField path="--target" type="string">
|
|
Target peer (what peer_id knows about target).
|
|
</ParamField>
|
|
<ParamField path="--search-query" type="string">
|
|
Semantic search query to filter conclusions.
|
|
</ParamField>
|
|
<ParamField path="--max-conclusions" type="number">
|
|
Maximum number of conclusions to include.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="search">
|
|
Search messages in a session.
|
|
|
|
```bash
|
|
honcho session search <query> [<session_id>]
|
|
```
|
|
|
|
<ParamField path="query" type="string" required />
|
|
<ParamField path="session_id" type="string" />
|
|
<ParamField path="--limit" type="number" default="10">
|
|
Max results.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="set-metadata">
|
|
Set metadata for a session.
|
|
|
|
```bash
|
|
honcho session set-metadata [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
<ParamField path="--data" type="string" required>
|
|
JSON metadata to set (e.g. '\{"key": "value"\}'). Short alias: `-d`.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="summaries">
|
|
Get session summaries (short + long).
|
|
|
|
```bash
|
|
honcho session summaries [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
</Accordion>
|
|
<Accordion title="view">
|
|
View a session transcript as a chat log.
|
|
|
|
Modes (pick one):
|
|
|
|
- default / --last N: tail of the conversation (most recent N)
|
|
- --page N [--size M]: page through the full transcript
|
|
- --all: every message
|
|
|
|
Paging follows the requested order: --page 1 starts at the oldest message,
|
|
or the newest with --reverse.
|
|
|
|
Human mode prints a row-delimited table. JSON mode emits the message list
|
|
(same shape as message list).
|
|
|
|
```bash
|
|
honcho session view [<session_id>]
|
|
```
|
|
|
|
<ParamField path="session_id" type="string" />
|
|
<ParamField path="--last" type="number">
|
|
Show only the N most recent messages (default when no --page/--all: 50).
|
|
</ParamField>
|
|
<ParamField path="--page" type="number">
|
|
1-indexed page of the full transcript. Use for page 2+.
|
|
</ParamField>
|
|
<ParamField path="--size" type="number">
|
|
Messages per page; requires --page (1-100, default: 50).
|
|
</ParamField>
|
|
<ParamField path="--all" type="boolean">
|
|
Show the full transcript (every page).
|
|
</ParamField>
|
|
<ParamField path="--reverse" type="boolean">
|
|
Newest first (default is chronological: oldest at top).
|
|
</ParamField>
|
|
<ParamField path="--ids" type="boolean">
|
|
Include message IDs in the transcript.
|
|
</ParamField>
|
|
<ParamField path="--peer" type="string">
|
|
Filter by peer ID. Short alias: `-p`.
|
|
</ParamField>
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## honcho workspace
|
|
|
|
List, create, inspect, delete, and search workspaces.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="create">
|
|
Create or get a workspace.
|
|
|
|
```bash
|
|
honcho workspace create <workspace_id>
|
|
```
|
|
|
|
<ParamField path="workspace_id" type="string" required />
|
|
<ParamField path="--metadata" type="string">
|
|
JSON metadata to associate with the workspace.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="delete">
|
|
Delete a workspace. Use --dry-run first to see what will be deleted.
|
|
|
|
Requires --yes to skip confirmation, or will prompt interactively.
|
|
If sessions exist, requires --cascade to delete them first.
|
|
|
|
```bash
|
|
honcho workspace delete <workspace_id>
|
|
```
|
|
|
|
<ParamField path="workspace_id" type="string" required />
|
|
<ParamField path="--yes" type="boolean">
|
|
Skip confirmation prompt (for scripted/agent use). Short alias: `-y`.
|
|
</ParamField>
|
|
<ParamField path="--cascade" type="boolean">
|
|
Delete all sessions before deleting the workspace.
|
|
</ParamField>
|
|
<ParamField path="--dry-run" type="boolean">
|
|
Show what would be deleted without deleting.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="inspect">
|
|
Inspect a workspace: peers, sessions, config.
|
|
|
|
```bash
|
|
honcho workspace inspect [<workspace_id>]
|
|
```
|
|
|
|
<ParamField path="workspace_id" type="string" />
|
|
</Accordion>
|
|
<Accordion title="list">
|
|
List all accessible workspaces.
|
|
|
|
```bash
|
|
honcho workspace list
|
|
```
|
|
|
|
</Accordion>
|
|
<Accordion title="queue-status">
|
|
Get queue processing status.
|
|
|
|
```bash
|
|
honcho workspace queue-status
|
|
```
|
|
|
|
<ParamField path="--observer" type="string">
|
|
Filter by observer peer.
|
|
</ParamField>
|
|
<ParamField path="--sender" type="string">
|
|
Filter by sender peer.
|
|
</ParamField>
|
|
</Accordion>
|
|
<Accordion title="search">
|
|
Search messages across workspace.
|
|
|
|
```bash
|
|
honcho workspace search <query>
|
|
```
|
|
|
|
<ParamField path="query" type="string" required />
|
|
<ParamField path="--limit" type="number" default="10">
|
|
Max results.
|
|
</ParamField>
|
|
</Accordion>
|
|
</AccordionGroup>
|