Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Commands

Every verb below is one annotated Rust function, and each is reachable from the CLI, from HTTP at POST /ops/<name>, and from MCP — except where reach forbids it. See Ops.

centinel --help builds this list by iterating the registry, so it is never out of date.

Pipeline

CommandWhat it does
runCollect everything new for every configured source, then index and embed it.
sourceAdd, list and remove the sources centinel run walks.
scheduleWrite and remove the cadences centinel serve fires runs on.

Stages

Each is what run does for you, available on its own.

CommandWhat it does
discoverEnumerate every address a source declares.
collectAcquire every address the latest discovery run found, skipping what is already stored.
extractDerive searchable text from collected documents.
transcribeTranscribe collected audio with a local Whisper model.
indexChunk extracted text into the search index.
embedEmbed indexed chunks into the vector table.
ingestFetch one or more URLs into the content-addressed store.

Corpus

CommandWhat it does
searchSearch the corpus for a passage.
readRead the extracted text of a collected document.
openOpen a collected document in an application. (host)
listList sources in the store with resource counts and liveness.
checkSee what extraction makes of one link or file. Nothing is stored.
investigateAsk the registry what it makes of an address. Nothing is stored.
schedulesShow configured schedules, when each next fires, and how the last one went.
historyShow what scheduled and manual runs did, newest first.

Host

CommandWhat it does
doctorReport host readiness: required binaries, store location, corpus size.
modelsInspect, fetch, verify and remove model weights.

Servers

CommandWhat it does
serveRun the HTTP server (ops as routes, plus MCP over HTTP). Default bind 127.0.0.1:8787.
mcpRun an MCP server over stdio.

serve --no-schedule serves the read API without firing any [[schedule]].

Global flags

FlagEffect
--root DIRstore root. Also $CENTINEL_ROOT.
--config FILEconfig file. Also $CENTINEL_CONFIG.
--jsonforce JSON output on a terminal
--prettyforce rendered prose into a pipe
--color auto|always|neveroverride colour. NO_COLOR is honoured.

Output format defaults to the destination: prose to a terminal, JSON to a pipe.

Flags worth knowing

centinel run --source tampa --limit 50 --skip embed
centinel collect --source tampa --match /assets/ --rps 5
centinel embed --dry-run
centinel embed --limit 100
centinel search "budget" --source tampa -n 20 --snippet-chars 0
centinel schedules --check
centinel history --failed --since 2026-08-01T00:00:00Z
centinel history --run 8f3c

--limit on run and collect bounds collection, never discovery — a truncated snapshot of a source’s address set would look exactly like a source that shrank.

--user-agent and --timeout-secs are available on the ops that fetch on your behalf (check, investigate). A descriptive User-Agent measurably reduces WAF 403s.

Handles

search, read and open all print a short blob hash, and all three accept one back by prefix, git-style.

centinel read 3f9a2c1
centinel open 3f9a2c1

Both the original blob_sha and the derived_sha are valid targets.