CLI command reference
stable
Stable · CLI · @sift-wiki/cli@0.1.10
Generated from the command manifest. Download JSON.
| Command | Purpose | Example |
|---|---|---|
add |
Capture a local file into the selected brain. | sift add ./notes.md |
agent register |
Compatibility command: agent profiles are retired and tools use the connected user’s permissions. | sift agent register --name "Claude Code" --description "Coding agent" |
agent status |
Compatibility command: report that agent profiles are retired and registration is unnecessary. | sift agent status --json |
ask |
Ask a grounded question using a simple read alias. | sift ask "what changed?" |
audit events |
Inspect redacted audit events when authorized. | sift audit events <target-id> |
auth status |
Inspect local authentication state. | sift auth status --json |
brain list |
List brains available to the current scope. | sift brain list |
brain use |
Select the current brain scope for subsequent operations. | sift brain use <brain-id> |
capture batch |
Capture a bounded batch of text or file inputs. | sift capture batch manifest.json |
capture file |
Capture file metadata and content without treating the local path as canonical. | sift capture file ./notes.md --source Notes --external-id note-1 |
capture health |
Inspect local capture-hook health. | sift capture health --json |
capture nudge |
Run a fail-closed agent capture hook. | sift capture nudge --client codex |
capture text |
Capture text or markdown through the ingestion spine. The receipt’s status reports the real ingestion state: ‘indexed’ means it is searchable now, ‘queued’ means it is stored durably but not yet searchable (indexing will finish in the background). Never assume queued content is retrievable yet. For agent conversation memory, set contentKind to ‘agent_conversation_exchange’ and fill provenance (actingClient, model, clientSessionRef, clientTurnRef, clientEventTime); use a stable externalId per exchange so retries dedupe. | sift capture text --source Notes --external-id note-1 |
context assemble |
Assemble grounded answer-preparation context with request time, caller identity, task guidance from visible Sift skills when available, safe source metadata, gaps, and raw cited fallback. | sift context assemble 'launch risks' |
context profile |
Read a permission-filtered profile context model. | sift context profile |
contract get |
Fetch the Sift agent contract (kernel + workspace overlay) and the contractVersion to echo on every gated tool call. Call this before any other Sift work. | sift contract get |
decide |
Create a decision from explicit intent. | sift decide --statement "Ship" |
decision create |
Create a canonical decision record. | sift decision create |
doctor |
Check the local profile and hosted API connection. | sift doctor --json |
edit |
Patch a bounded record section. | sift edit <record-id> --section Notes |
event list |
List authorized brain events. | sift event list |
evidence get |
Read an authorized evidence item. | sift evidence get <evidence-id> |
evidence list |
List authorized evidence links for a record. | sift evidence list <record-id> |
graph neighbors |
Traverse authorized graph neighbors. | sift graph neighbors <record-id> |
hooks install |
Install a supported agent capture hook. | sift hooks install claude-code |
hooks uninstall |
Remove a supported agent capture hook. | sift hooks uninstall claude-code |
ingestion status |
Inspect ingestion job status. | sift ingestion status <job-id> |
login |
Authenticate in the browser and save a local profile. | sift login |
logout |
Revoke the local session and remove its profile. | sift logout |
mcp serve |
Serve Sift tools to a local MCP client over stdio. | sift mcp serve |
record create-markdown |
Create a versioned markdown brain record. | sift record create-markdown --type memory |
record get |
Read an authorized markdown record. | sift record get <record-id> |
record list |
List authorized records. | sift record list |
record patch-section |
Patch a stable markdown heading section with conflict detection. | sift record patch-section <record-id> <anchor> |
record versions |
List record versions. | sift record versions <record-id> |
remember |
Create a durable markdown record after explicit intent. | sift remember "Decision text" |
roam import |
Import explicitly selected Roam pages. | sift roam import --scope sift-tag --workspace-attestation |
scope current |
Show the authenticated workspace and brain scope. | sift scope current |
search |
Search the selected brain using a simple alias. | sift search "launch decision" |
search query |
Search authorized brain context and return raw cited candidate results for exploration. | sift search query 'launch risks' |
show |
Read a record using a simple alias. | sift show <record-id> |
skill get |
Read a skill’s pinned active version markdown body, version id, and bundle file paths by skill record id. | sift skill get <skill-id> |
skill import commit |
Commit an explicit create, exact-link, or fork action from a skill import preview. | sift skill import commit ./my-skill --action create --preview-token <token> --idempotency-key <key> --visibility team --instruction 'Migrate this workflow' |
skill import preview |
Safely scan and preview migration of one explicit local skill path. | sift skill import preview ./my-skill --visibility team --instruction 'Migrate this workflow' |
skill install |
Install a bundled skill into an agent workspace. | sift skill install sift-setup |
skill list |
List bundled agent skills without authentication. | sift skill list |
skill print |
Print a bundled skill. | sift skill print sift-cli |
skill show |
Print a bundled skill. | sift skill show sift-cli |
skill update |
Directly replace an existing skill’s markdown body when the user asks an agent to modify that skill; execution-discovered learning stays on skill.teach or skill.feedback. | sift skill update <skill-id> --expected-version <version-id> --markdown <body> |
source create |
Create a source for future captures. | sift source create --name Notes --visibility team |
source get |
Read source metadata. | sift source get <source-id> |
source list |
List sources visible in the selected brain. | sift source list |
source status |
Inspect source processing status. | sift source status <source-id> |
status |
Show current workspace, brain, and authentication scope. | sift status --json |
task create |
Create a canonical task record. | sift task create |
todo |
Create a task from explicit intent. | sift todo --title "Verify docs" |
tools help |
Return compact help for a tool. | sift tools help search.query |
tools list |
List tools available to this transport and scope. | sift tools list |
tools schema |
Return JSON schemas for available tools. | sift tools schema --json |