sediment command-line interface
(CLI). The Quickstart covers installation.
The HTTP API reference describes server routes;
the Schema reference describes Facts and export rows.
sediment --help lists commands. sediment --version prints the installed
version. sediment <command> --help lists that command’s options.
Hook commands that the CLI hides from help are outside this reference.
Defaults come from the parsers. — means that the parser supplies no value;
the description names any runtime or environment fallback.
(required) marks a required option. If its description names an
environment default, the option is required only when that variable is unset.
Global options:
Command index
sediment factssediment evidencesediment evidence inventorysediment evidence inspectsediment evidence fetchsediment demosediment dbsediment db statussediment db upgradesediment db checksediment db provisionsediment quarantinesediment releasesediment quarantine-logsediment quarantine-inference-callssediment serversediment loginsediment logoutsediment guidesediment commitsediment derivesediment exportsediment export rlvrsediment export dposediment export sftsediment export diff-sftsediment export recoverysediment stampsediment repair-notessediment doctorsediment installsediment uninstallsediment transcriptsediment mirror-gcsediment deliverysediment delivery enqueuesediment delivery statussediment delivery replaysediment reportsediment report modelsediment report label-confidence-inspectionsediment report dataset-diagnosticssediment report recovery-yieldsediment report precisionsediment report abandonmentsediment report attribution-sharesediment report merge-retentionsediment report lifecycle
sediment facts
fact counts per table (remote; —database-url for direct)sediment evidence
read selected Session evidence with operator authoritysediment evidence inventory
print a complete bounded Session inventory as JSONsediment evidence inspect
print one Inference call’s part manifest as JSONsediment evidence fetch
write exact selected parts to a private local packet
Options:
sediment demo
plant one synthetic session so facts is non-zerosediment db
provision database roles or inspect and upgrade the schemasediment db status
inspect the schema revision without changing itsediment db upgrade
upgrade the schema under an advisory lock; as the migrator, also grant and validate the rolessediment db check
report every failed role and grant check without changing anythingsediment db provision
Read SEDIMENT_BOOTSTRAP_DATABASE_URL, SEDIMENT_MIGRATOR_PASSWORD, SEDIMENT_RUNTIME_PASSWORD, and SEDIMENT_OPERATOR_PASSWORD from the environment. SEDIMENT_MIGRATOR_ROLE, SEDIMENT_RUNTIME_ROLE, and SEDIMENT_OPERATOR_ROLE name the roles. Stop services before provisioning.sediment quarantine
quarantine one fact by id
Options:
sediment release
release one quarantined fact by id
Options:
sediment quarantine-log
the org’s quarantine historysediment quarantine-inference-calls
bulk-quarantine inference calls by filter (dry-run by default)sediment server
run a local API server with managed PostgreSQLsediment login
store verified operator credentials, or separate ingest credentials with —capture. Remote URLs must use HTTPS; HTTP is accepted only for localhost or a literal loopback IP address. A loopback URL enrolls both credentials sediment server generated in ~/.sediment/server/server.env; any other server prompts, or takes —with-token on stdin.
Options:
sediment logout
remove stored credentialssediment guide
print the agent guide for operators and developerssediment commit
pretty-print attributions for a commit
Options:
sediment derive
materialize a reviewed canonical derivation bundlesediment export
run an export projectionsediment export rlvr
export one explicit RLVR targetsediment export dpo
dpo.jsonl — chosen/rejected pairssediment export sft
sft.jsonl — supervised training targetssediment export diff-sft
diff_sft.jsonl — per-commit, per-file training rowssediment export recovery
recovery.jsonl — red-to-green CI-transition recovery pairssediment stamp
Write this repository’s pending Session markers to the note on HEAD under refs/notes/sediment, then clear the markers that it wrote. The post-commit hook runs this command after each commit. Run it yourself only to recover a pending stamp, while HEAD is still the commit that the markers belong to. The command always exits 0, prints each failure on stderr, and logs it to ~/.sediment/attribution.log.sediment repair-notes
Fetch refs/notes/sediment from the remote, union-merge it into the local notes ref, and push the result. Run it inside a repository whensediment doctor --fetch reports a notes ref that is behind or diverged. Unlike the pre-push hook, the command exits 1 when it can’t reconcile or push.
sediment doctor
Options:
sediment install
Options:
sediment uninstall
Options:
sediment transcript
Read one hook event on stdin: a JSON object with session_id and transcript_path. Extract the Session’s Edit observations from that agent transcript, and send them to SEDIMENT_OTLP_ENDPOINT. For Claude Code, also send Rejected edits and Retry linkages. Agent session-end hooks run this command. Run it yourself to recover a Session that ended without its extractor. The command always exits 0 and reports problems on stderr. If SEDIMENT_OTLP_ENDPOINT is unset, it does nothing.
Options: