Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orinadus.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Location

~/.config/urchin/config.toml
The file is optional. All keys have defaults. A missing file is not an error. An incomplete file is fine — only the keys that are present override the defaults.

​
Keys

​
vault_root
path
Absolute path to the vault (brain) directory. Vault projection writes daily notes here.Default: ~/brain
​
journal_path
path
Absolute path to the JSONL journal file.Default: ~/.local/share/urchin/journal/events.jsonlThe parent directory is created automatically on first write.
​
cache_path
path
Path to the event cache file used by certain query operations.Default: ~/.local/share/urchin/event-cache.jsonl
​
intake_port
integer
TCP port the HTTP intake server binds on 127.0.0.1.Default: 18799
​
intake_token
string
Bearer token required on every POST /ingest. If not set, all requests from loopback are accepted without auth.When set, requests must include Authorization: Bearer <token>. Missing or wrong token returns 401.
​
cloud_url
string
Full URL of the Orinadus cloud sync endpoint.Example: https://www.orinadus.com/api/urchin-syncNo default. Cloud sync is disabled when this key is absent.
​
cloud_token
string
Bearer token for the Orinadus cloud sync API. Required if cloud_url is set.
​
remote_host
string
Optional remote host override. Used by certain SDK clients for non-standard routing.

​
Example file

# ~/.config/urchin/config.toml

vault_root   = "/home/samhc/brain"
journal_path = "/home/samhc/.local/share/urchin/journal/events.jsonl"
intake_port  = 18799
intake_token = "your-local-token"
cloud_url    = "https://www.orinadus.com/api/urchin-sync"
cloud_token  = "your-cloud-token"

​
Precedence

Configuration is layered. Later layers win:
  1. Compiled defaults — applied unconditionally
  2. Config file — keys present in config.toml override defaults
  3. Environment variables — override both file and defaults. See Environment Variables.

​
Editing via CLI

# Set a key directly (creates the file if it doesn't exist)
urchin config set cloud_token your-token-here
urchin config set intake_port 19000

# View current resolved config
urchin config show
urchin config set writes only to the TOML file. It does not affect environment variables.

​
Notes

  • Sensitive values (cloud_token, intake_token) are shown as [set] in urchin doctor output — the actual values are never printed.
  • The file is parsed with TOML. Strings must be quoted. Integers must not be quoted.
  • Unknown keys in the file are silently ignored.