Skip to main content

Synopsis

urchin ingest --content <TEXT> [OPTIONS]

Flags

--content
string
required
The event payload. Must be non-empty. Short form: -c.
--source
string
Source identifier for the event (e.g. cli, claude, script). Defaults to cli when called from the binary. Short form: -s.
--workspace
string
Absolute path to the repo or workspace this event belongs to. Short form: -w.
--title
string
Short human-readable title for display in vault projections. Short form: -t.
--tags
string
Comma-separated list of tags. Short form: -T.
--tags architecture,auth,substrate
--kind
string
default:"conversation"
Event kind. Accepted values: conversation, agent, command, commit, file, decision. Any other string is stored as Other(value). Short form: -k.

Behaviour

  • Reads config from ~/.config/urchin/config.toml (or env overrides) to locate the journal.
  • Writes directly to the journal file — does not go through the HTTP intake server.
  • Attaches the local identity (account, device) as the actor field.
  • Exits 0 on success, non-zero on write failure.

Examples

urchin ingest --content "Fixed the memory leak in the event loop"
urchin ingest \
  --content "Chose file-backed flag for cross-process ephemeral mode" \
  --source claude \
  --workspace /home/user/dev/orinadus/substrate/urchin-rust \
  --title "Ephemeral design decision" \
  --tags architecture,ephemeral \
  --kind decision
git log --oneline -5 | urchin ingest --content "$(cat)" --kind commit --source git

Exit codes

CodeMeaning
0Event written successfully
1Config load error, journal write error, or invalid arguments