CLI Reference
This reference is generated from the checked-in riffdb command tree. See
Installation for setup and
Configuration for configuration-file semantics.
riffdb
Usage: riffdb [OPTIONS] <COMMAND>
Commands:
lsp Starts the bounded compiler-backed Language Server Protocol service on stdio
outbox Inspects the stopped server's protected local outbox destination
telemetry Summarizes bounded flight-recorder telemetry NDJSON logs from soak and endurance runs
init Initializes RiffDB schema files in a new or existing project
push Checks, locks, and installs the configured schema
generate Regenerates configured SDK targets from the exact project lock
agent Installs repository-local generated agent guidance and MCP configuration
status Reports the configured local and installed schema identities
diff Reports the bounded installed-versus-local schema difference
migrate Runs the existing staged migration path for the configured schema
new Creates a deterministic application-first RiffDB repository
application Validates and regenerates an exact application package
migration Inspects exact local contract migration artifacts
dev Starts the bounded local symbolic development workflow
contract
command
entity
commit
event Describes and reads partitioned domain events
contextual Consumes and resolves contextual agent work through generated identities
projection
query
role Checks, describes, binds, or revokes an exact symbolic application role
capability
follower Manages audited follower retention policy and permanent primary fencing
server
backup
export Exports one authorized symbolic application snapshot as canonical JSONL pages
reimport Reconstitutes one empty not-ready database from an exact portability export
storage Inspects or upgrades one closed database's durable format
retention Offline exclusive retention maintenance on a closed database file
demo
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb lsp
Starts the bounded compiler-backed Language Server Protocol service on stdio
Usage: riffdb lsp [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb outbox
Inspects the stopped server's protected local outbox destination
Usage: riffdb outbox [OPTIONS] <COMMAND>
Commands:
archive
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb telemetry
Summarizes bounded flight-recorder telemetry NDJSON logs from soak and endurance runs
Usage: riffdb telemetry [OPTIONS] <COMMAND>
Commands:
summarize Aggregates a bounded flight-recorder NDJSON file into throughput, latency, and byte growth metrics
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb init
Initializes RiffDB schema files in a new or existing project
Usage: riffdb init [OPTIONS] [APPLICATION]
Arguments:
[APPLICATION]
Options:
--config <PATH>
--generator <rust|go|typescript|python|mcp>
[default: rust] [possible values: rust, go, typescript, python, mcp]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb push
Checks, locks, and installs the configured schema
Usage: riffdb push [OPTIONS]
Options:
--accept-lock <64_LOWERCASE_HEX_HASH>
Accepts one exact compiler-owned successor lock identity
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--generate
Regenerates configured SDK targets in the same invocation
--database <DATABASE>
--migrate
Runs staged contract migration check and confirmed apply when the successor requires migration
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb generate
Regenerates configured SDK targets from the exact project lock
Usage: riffdb generate [OPTIONS]
Options:
--config <PATH>
--sync-manifest
Discovers `riffdb/queries/*.riffq` and grants new operations to the target role before locking
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--sync-role <ROLE>
Explicit role name in `riffdb.application.json` to receive newly discovered operations
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb agent
Installs repository-local generated agent guidance and MCP configuration
Usage: riffdb agent [OPTIONS] <COMMAND>
Commands:
init Installs or verifies the exact repository-local agent rails
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb status
Reports the configured local and installed schema identities
Usage: riffdb status [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb diff
Reports the bounded installed-versus-local schema difference
Usage: riffdb diff [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migrate
Runs the existing staged migration path for the configured schema
Usage: riffdb migrate [OPTIONS] <COMMAND>
Commands:
plan Prints the exact read-only migration plan for the project lock
check Runs one read-only server preflight for the exact project migration
apply Applies one exact project migration after hash confirmation
up Runs server preflight check and confirmed apply in one step for the exact project migration
operation Observes one caller-stable project migration operation
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb new
Creates a deterministic application-first RiffDB repository
Usage: riffdb new [OPTIONS] <APPLICATION>
Arguments:
<APPLICATION>
Options:
--config <PATH>
--language <rust|go|typescript|python>
[default: rust] [possible values: rust, go, typescript, python]
--directory <DIRECTORY>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb application
Validates and regenerates an exact application package
Usage: riffdb application [OPTIONS] <COMMAND>
Commands:
conformance Validates one bounded adapter conformance manifest and optional exact installation plan
install Starts or resumes one exact, caller-identified installation campaign
installation Observes one retained installation campaign without changing its plan
migrate Previews or atomically writes an explicit local application-format migration
check Read-only symbolic compilation and safety analysis
preview Compiles and prints the exact proposed lock without writing
lock Writes or verifies the compiler-owned exact lock and generated artifacts
generate Regenerates V1 manifests or exact locked symbolic application bindings
deploy Deploys one exact lock, with optional explicit role provisioning and seed
bind-dev-role Idempotently deploys and binds one explicit short-lived application role
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migration
Inspects exact local contract migration artifacts
Usage: riffdb migration [OPTIONS] <COMMAND>
Commands:
plan Prints the exact read-only migration plan for a locked application
check Runs one read-only server preflight for the exact locked migration
apply Applies one exact locked migration after explicit hash confirmation
up Runs server preflight check and confirmed apply in one step for the exact locked migration
operation Observes one caller-stable migration operation after the database reopens
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb dev
Starts the bounded local symbolic development workflow
Usage: riffdb dev [OPTIONS]
Options:
--config <PATH>
--role <ROLE_PRESET>
[default: application]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--tenant <TENANT_ID>
Explicit tenant identifier when binding a tenant-scoped role in local development
--database <DATABASE>
--watch
--output <human|json>
[possible values: human, json]
--run
Runs the repository's generated application against the local server
--exec <COMMAND>
Runs an arbitrary command against the ephemeral local server and tears down on exit
--max-attempts <1..10>
--credential-file <PATH>
--go-runner-package <PATH>
Repository-relative Go main-package directory used by `--run`
--seed
--tls-trust-root <PATH>
--seed-dir <DIRECTORY>
--tls-server-name <SERVER_NAME>
--seed-concurrency <1..8>
[default: 8]
--reset
Resets disposable local development state under `.riffdb/dev` before starting
--sync-manifest
Discovers `riffdb/queries/*.riffq` and grants new operations to the target role before starting
--sync-role <ROLE>
Explicit role name in `riffdb.application.json` to receive newly discovered operations
-h, --help
Print help
riffdb contract
Usage: riffdb contract [OPTIONS] <COMMAND>
Commands:
validate
explain Describes one local contract's aggregates, keys, and deletion proofs
deploy
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb command
Usage: riffdb command [OPTIONS] <COMMAND>
Commands:
batch Runs or resumes bounded ordinary symbolic commands from JSONL
run
execute
outcome
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb entity
Usage: riffdb entity [OPTIONS] <COMMAND>
Commands:
get
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb commit
Usage: riffdb commit [OPTIONS] <COMMAND>
Commands:
show
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb event
Describes and reads partitioned domain events
Usage: riffdb event [OPTIONS] <COMMAND>
Commands:
describe Describes one event in the active contract
replay Replays one exact event partition
tail Waits for events after one exact partition position
consume Leases one bounded batch from a named reactive event stream
ack Acknowledges one exact live event lease
nack Negatively acknowledges one exact live event lease
seek Moves a consumer checkpoint after exact seek authorization
retire Retires one consumer and releases its retention fence
status Reads bounded status for one exact consumer
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contextual
Consumes and resolves contextual agent work through generated identities
Usage: riffdb contextual [OPTIONS] <COMMAND>
Commands:
next Leases at most one event with fresh same-snapshot context
ack Acknowledges one exact contextual work-item lease
nack Negatively acknowledges one exact contextual work-item lease
status Reads bounded status for one exact contextual consumer
react Executes one declared command reaction using its server-issued proof
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb projection
Usage: riffdb projection [OPTIONS] <COMMAND>
Commands:
query
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query
Usage: riffdb query [OPTIONS] <COMMAND>
Commands:
describe
check
explain
run
run-named
watch Receives one closed update from an exact generated live named query
deploy
module
repl
inspect-vector Inspects authoritative vector freshness or model-version state
projected Executes one org-scoped projected columnar query under a freshness policy
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb role
Checks, describes, binds, or revokes an exact symbolic application role
Usage: riffdb role [OPTIONS] <COMMAND>
Commands:
check
describe
bind
revoke
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb capability
Usage: riffdb capability [OPTIONS] <COMMAND>
Commands:
bootstrap
create
revoke
list Lists non-secret capability summaries from a quiescent database path or local operator inventory file
show Shows non-secret capability details from a quiescent database path or local operator inventory file
rotate Rotates an active capability into a replacement capability with identical grants, atomically writes the replacement credential file, and optionally revokes the superseded capability
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb follower
Manages audited follower retention policy and permanent primary fencing
Usage: riffdb follower [OPTIONS] <COMMAND>
Commands:
status Inspects replication role, frontiers, lag sequences, and registered followers
failover Fences the primary and promotes this follower in one audited cutover sequence
promote Promotes a follower using the configured source's authenticated fence proof
fence-primary Permanently fences this primary; it may remain unavailable if promotion fails
register Registers or exactly replays the selected immutable policy
retire Retires only the original generation reported by registration
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb server
Usage: riffdb server [OPTIONS] <COMMAND>
Commands:
health
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb backup
Usage: riffdb backup [OPTIONS] <COMMAND>
Commands:
create
restore
retire Retires one exact immutable backup through the receipted public surface
operation
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb export
Exports one authorized symbolic application snapshot as canonical JSONL pages
Usage: riffdb export [OPTIONS] <COMMAND>
Commands:
start Starts or exactly replays one immutable snapshot export
page Writes one exact bounded page to a newly created canonical JSONL file
status Observes one durable export checkpoint or terminal receipt
cancel Closes one nonterminal export with a durable incomplete receipt
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb reimport
Reconstitutes one empty not-ready database from an exact portability export
Usage: riffdb reimport [OPTIONS] <COMMAND>
Commands:
start Starts or exactly replays one immutable reimport campaign
page Applies one exact hash-bearing entity page from the source export
status Observes one durable reimport checkpoint or terminal receipt
cancel Cancels one nonterminal reimport campaign
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb storage
Inspects or upgrades one closed database's durable format
Usage: riffdb storage [OPTIONS] <COMMAND>
Commands:
restore Restores a full backup plus its configured archive through maintenance admission
scrub Requests the complete offline storage validation pass. It takes the database offline, validates it, and reopens it; observe the printed operation with `riffdb backup operation`
preflight Compares the retained format identity without opening the database
upgrade Runs the sole manifest-authorized offline transition from a verified backup
compact Compacts freed pages in a closed database file and lowers its on-disk high-water mark
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention
Offline exclusive retention maintenance on a closed database file
Usage: riffdb retention [OPTIONS] <COMMAND>
Commands:
status Prints the retention watermark and fencing breakdown for a closed database
hold Operator hold management (add / remove)
projection-detach Detaches a projection identity from the fencing minimum (audited)
projection-reattach Reattaches a previously detached projection to the minimum (audited)
prune Offline prune of commits/events/outbox through a target inclusive sequence
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb demo
Usage: riffdb demo [OPTIONS] <COMMAND>
Commands:
budget
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb outbox archive
Usage: riffdb outbox archive [OPTIONS] <COMMAND>
Commands:
inspect Validates bounded pages without exposing event payloads. Requires exclusive archive custody
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb telemetry summarize
Aggregates a bounded flight-recorder NDJSON file into throughput, latency, and byte growth metrics
Usage: riffdb telemetry summarize [OPTIONS] <PATH>
Arguments:
<PATH>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb agent init
Installs or verifies the exact repository-local agent rails
Usage: riffdb agent init [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migrate plan
Prints the exact read-only migration plan for the project lock
Usage: riffdb migrate plan [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migrate check
Runs one read-only server preflight for the exact project migration
Usage: riffdb migrate check [OPTIONS] --operation-id <UUIDV7>
Options:
--config <PATH>
--operation-id <UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--migration-hash <64_LOWERCASE_HEX_HASH>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migrate apply
Applies one exact project migration after hash confirmation
Usage: riffdb migrate apply [OPTIONS] --operation-id <UUIDV7> --confirm-apply <64_LOWERCASE_HEX_HASH>
Options:
--config <PATH>
--operation-id <UUIDV7>
--confirm-apply <64_LOWERCASE_HEX_HASH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migrate up
Runs server preflight check and confirmed apply in one step for the exact project migration
Usage: riffdb migrate up [OPTIONS]
Options:
--config <PATH>
--operation-id <UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migrate operation
Observes one caller-stable project migration operation
Usage: riffdb migrate operation [OPTIONS] <UUIDV7>
Arguments:
<UUIDV7>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb application conformance
Validates one bounded adapter conformance manifest and optional exact installation plan
Usage: riffdb application conformance [OPTIONS] <ADAPTER_CONFORMANCE_MANIFEST>
Arguments:
<ADAPTER_CONFORMANCE_MANIFEST>
Options:
--config <PATH>
--plan <CANONICAL_INSTALLATION_PLAN>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb application install
Starts or resumes one exact, caller-identified installation campaign
Usage: riffdb application install [OPTIONS] --plan <CANONICAL_PLAN> --campaign-id <UUID_V7>
Options:
--config <PATH>
--plan <CANONICAL_PLAN>
--campaign-id <UUID_V7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--driver-proof <rust|go|typescript|python>
Attests exact successful first-party driver identity handshakes [possible values: rust, go, typescript, python]
--output <human|json>
[possible values: human, json]
--seed-receipts <CANONICAL_SEED_RECEIPTS>
Attests one canonical plan-bound ordinary-command seed receipt set
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb application installation
Observes one retained installation campaign without changing its plan
Usage: riffdb application installation [OPTIONS] --campaign-id <UUID_V7>
Options:
--campaign-id <UUID_V7>
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb application migrate
Previews or atomically writes an explicit local application-format migration
Usage: riffdb application migrate [OPTIONS] --to <v2> [APPLICATION_SOURCE]
Arguments:
[APPLICATION_SOURCE] [default: riffdb.application.json]
Options:
--config <PATH>
--to <v2> [possible values: v2]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--write
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb application check
Read-only symbolic compilation and safety analysis
Usage: riffdb application check [OPTIONS] [APPLICATION_SOURCE]
Arguments:
[APPLICATION_SOURCE] [default: riffdb.application.json]
Options:
--config <PATH>
--source-only
Compiles author-owned sources and roles without comparing the exact lock or generated files
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--refusals
Reports only anonymized operational refusal classes
--database <DATABASE>
--sync-manifest
Discovers `riffdb/queries/*.riffq` and grants new operations to the target role before checking
--output <human|json>
[possible values: human, json]
--sync-role <ROLE>
Explicit role name in `riffdb.application.json` to receive newly discovered operations
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb application preview
Compiles and prints the exact proposed lock without writing
Usage: riffdb application preview [OPTIONS] [APPLICATION_SOURCE]
Arguments:
[APPLICATION_SOURCE] [default: riffdb.application.json]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb application lock
Writes or verifies the compiler-owned exact lock and generated artifacts
Usage: riffdb application lock [OPTIONS] [APPLICATION_SOURCE]
Arguments:
[APPLICATION_SOURCE] [default: riffdb.application.json]
Options:
--config <PATH>
--write
--check
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--lock <APPLICATION_LOCK>
[default: riffdb.application.lock.json]
--output <human|json>
[possible values: human, json]
--sync-manifest
Discovers `riffdb/queries/*.riffq` and grants new operations to the target role before locking
--max-attempts <1..10>
--sync-role <ROLE>
Explicit role name in `riffdb.application.json` to receive newly discovered operations
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb application generate
Regenerates V1 manifests or exact locked symbolic application bindings
Usage: riffdb application generate [OPTIONS] [APPLICATION_SOURCE_OR_V1_MANIFEST]
Arguments:
[APPLICATION_SOURCE_OR_V1_MANIFEST] [default: riffdb.application.json]
Options:
--config <PATH>
--locked
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--lock <APPLICATION_LOCK> [default: riffdb.application.lock.json]
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb application deploy
Deploys one exact lock, with optional explicit role provisioning and seed
Usage: riffdb application deploy [OPTIONS] [APPLICATION_SOURCE]
Arguments:
[APPLICATION_SOURCE] [default: riffdb.application.json]
Options:
--config <PATH>
--lock <APPLICATION_LOCK>
[default: riffdb.application.lock.json]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--provision-role <ROLE>
--database <DATABASE>
--tenant <TENANT>
--lifetime-seconds <SECONDS>
[default: 28800]
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--seed
--credential-file <PATH>
--seed-concurrency <1..32>
[default: 8]
--replace-role-credential
--tls-trust-root <PATH>
--installation-plan <CANONICAL_PLAN>
Binds deployment to one exact installation plan and campaign
--tls-server-name <SERVER_NAME>
--installation-campaign-id <UUID_V7>
Caller-stable campaign resumed before and after remote deployment
-h, --help
Print help
riffdb application bind-dev-role
Idempotently deploys and binds one explicit short-lived application role
Usage: riffdb application bind-dev-role [OPTIONS] --role <ROLE> [APPLICATION_SOURCE]
Arguments:
[APPLICATION_SOURCE] [default: riffdb.application.json]
Options:
--config <PATH>
--lock <APPLICATION_LOCK> [default: riffdb.application.lock.json]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--role <ROLE>
--database <DATABASE>
--tenant <TENANT>
--lifetime-seconds <SECONDS> [default: 28800]
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--replace-role-credential
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migration plan
Prints the exact read-only migration plan for a locked application
Usage: riffdb migration plan [OPTIONS]
Options:
--application <APPLICATION_SOURCE> [default: riffdb.application.json]
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--lock <APPLICATION_LOCK> [default: riffdb.application.lock.json]
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migration check
Runs one read-only server preflight for the exact locked migration
Usage: riffdb migration check [OPTIONS] --operation-id <UUIDV7>
Options:
--application <APPLICATION_SOURCE> [default: riffdb.application.json]
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--lock <APPLICATION_LOCK> [default: riffdb.application.lock.json]
--database <DATABASE>
--operation-id <UUIDV7>
--migration-hash <64_LOWERCASE_HEX_HASH>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migration apply
Applies one exact locked migration after explicit hash confirmation
Usage: riffdb migration apply [OPTIONS] --operation-id <UUIDV7> --confirm-apply <64_LOWERCASE_HEX_HASH>
Options:
--application <APPLICATION_SOURCE> [default: riffdb.application.json]
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--lock <APPLICATION_LOCK> [default: riffdb.application.lock.json]
--database <DATABASE>
--operation-id <UUIDV7>
--confirm-apply <64_LOWERCASE_HEX_HASH>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migration up
Runs server preflight check and confirmed apply in one step for the exact locked migration
Usage: riffdb migration up [OPTIONS]
Options:
--application <APPLICATION_SOURCE> [default: riffdb.application.json]
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--lock <APPLICATION_LOCK> [default: riffdb.application.lock.json]
--database <DATABASE>
--operation-id <UUIDV7>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb migration operation
Observes one caller-stable migration operation after the database reopens
Usage: riffdb migration operation [OPTIONS] <UUIDV7>
Arguments:
<UUIDV7>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contract validate
Usage: riffdb contract validate [OPTIONS] <SOURCE>
Arguments:
<SOURCE>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contract explain
Describes one local contract's aggregates, keys, and deletion proofs
Usage: riffdb contract explain [OPTIONS] <SOURCE>
Arguments:
<SOURCE>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contract deploy
Usage: riffdb contract deploy [OPTIONS] <SOURCE>
Arguments:
<SOURCE>
Options:
--config <PATH>
--expected-version <VERSION>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb command batch
Runs or resumes bounded ordinary symbolic commands from JSONL
Usage: riffdb command batch [OPTIONS] <COMMAND_NAME> <JSONL_INPUT>
Arguments:
<COMMAND_NAME>
<JSONL_INPUT>
Options:
--config <PATH>
--expected-version <VERSION>
--concurrency <1..32>
[default: 8]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--idempotency-field <FIELD>
Symbolic idempotency input; derived from --application when omitted
--checkpoint <PATH>
--output <human|json>
[possible values: human, json]
--error-outcome <OUTCOME>
--max-attempts <1..10>
--credential-file <PATH>
--progress
--application <RIFFDB.APPLICATION.JSON>
Exact application source used to preflight compiled collection bounds
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb command run
Usage: riffdb command run [OPTIONS] <COMMAND_NAME>
Arguments:
<COMMAND_NAME>
Options:
--config <PATH>
--input <JSON_INPUT>
--arg <KEY=VALUE>
Inline command input field as KEY=JSON_OR_STRING_VALUE (repeatable)
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--input-json <JSON_OBJECT>
Inline command input fields as a JSON object string
--expected-version <VERSION>
--output <human|json>
[possible values: human, json]
--application <RIFFDB.APPLICATION.JSON>
Exact application source used to preflight compiled collection bounds
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb command execute
Usage: riffdb command execute [OPTIONS] --input <JSON_INPUT> <COMMAND_NAME>
Arguments:
<COMMAND_NAME>
Options:
--config <PATH>
--input <JSON_INPUT>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--expected-version <VERSION>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb command outcome
Usage: riffdb command outcome [OPTIONS] [COMMAND_NAME]
Arguments:
[COMMAND_NAME]
Options:
--config <PATH>
--lineage <CONTRACT_LINEAGE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--idempotency-key <IDEMPOTENCY_KEY>
--database <DATABASE>
--outcome-uri <OUTCOME_URI>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb entity get
Usage: riffdb entity get [OPTIONS] <ENTITY_TYPE_ID_OR_NAME>
Arguments:
<ENTITY_TYPE_ID_OR_NAME>
Options:
--config <PATH>
--entity-key <BASE64_ENTITY_KEY>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--key <FIELD=VALUE>
Symbolic primary-key field as FIELD=JSON_OR_STRING_VALUE (repeatable)
--database <DATABASE>
--key-json <JSON_OBJECT>
Symbolic primary-key fields as a JSON object string
--contract-source <PATH>
Contract or application source used to resolve symbolic entity, key, and field names
--output <human|json>
[possible values: human, json]
--contract-lineage <LINEAGE>
--max-attempts <1..10>
--contract-version <VERSION>
--credential-file <PATH>
--field <FIELD_ID_OR_NAME>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb commit show
Usage: riffdb commit show [OPTIONS] <COMMIT_SEQUENCE>
Arguments:
<COMMIT_SEQUENCE>
Options:
--config <PATH>
--observed-history-incarnation <INCARNATION>
Observed history incarnation fence (ADR-0072). Stale values fail closed
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb event describe
Describes one event in the active contract
Usage: riffdb event describe [OPTIONS] <EVENT>
Arguments:
<EVENT>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb event replay
Replays one exact event partition
Usage: riffdb event replay [OPTIONS] <EVENT>
Arguments:
<EVENT>
Options:
--config <PATH>
--partition <FIELD=JSON_VALUE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--field <FIELD>
--after <COMMIT:ORDINAL>
--database <DATABASE>
--limit <ROWS>
--output <human|json> [possible values: human, json]
--cursor <BASE64_CURSOR>
--max-attempts <1..10>
--credential-file <PATH>
--observed-history-incarnation <INCARNATION>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb event tail
Waits for events after one exact partition position
Usage: riffdb event tail [OPTIONS] <EVENT>
Arguments:
<EVENT>
Options:
--config <PATH>
--partition <FIELD=JSON_VALUE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--field <FIELD>
--after <COMMIT:ORDINAL>
--database <DATABASE>
--limit <ROWS>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--wait-nanos <NANOSECONDS> [default: 30000000000]
--credential-file <PATH>
--observed-history-incarnation <INCARNATION>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb event consume
Leases one bounded batch from a named reactive event stream
Usage: riffdb event consume [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--batch-limit <1..64> [default: 1]
--max-attempts <1..10>
--credential-file <PATH>
--in-flight-limit <1..64> [default: 16]
--lease-seconds <5..900> [default: 60]
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
--wait-nanos <NANOSECONDS> [default: 0]
--progress-cursor <BASE64_CURSOR>
-h, --help Print help
riffdb event ack
Acknowledges one exact live event lease
Usage: riffdb event ack [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER> --event-id <COMMIT:ORDINAL> --lease-token <64_HEX_CHARS> --history-incarnation <INCARNATION>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--event-id <COMMIT:ORDINAL>
--max-attempts <1..10>
--credential-file <PATH>
--lease-token <64_HEX_CHARS>
--history-incarnation <INCARNATION>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb event nack
Negatively acknowledges one exact live event lease
Usage: riffdb event nack [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER> --event-id <COMMIT:ORDINAL> --lease-token <64_HEX_CHARS> --history-incarnation <INCARNATION>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--event-id <COMMIT:ORDINAL>
--max-attempts <1..10>
--credential-file <PATH>
--lease-token <64_HEX_CHARS>
--history-incarnation <INCARNATION>
--tls-trust-root <PATH>
--retry-delay-nanos <NANOSECONDS> [default: 0]
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb event seek
Moves a consumer checkpoint after exact seek authorization
Usage: riffdb event seek [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json>
[possible values: human, json]
--checkpoint <before-first|COMMIT:ORDINAL>
--max-attempts <1..10>
--credential-file <PATH>
--progress-cursor <BASE64_CURSOR>
Opaque protected-consumer cursor returned by status or consume
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb event retire
Retires one consumer and releases its retention fence
Usage: riffdb event retire [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb event status
Reads bounded status for one exact consumer
Usage: riffdb event status [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contextual next
Leases at most one event with fresh same-snapshot context
Usage: riffdb contextual next [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--wait-nanos <NANOSECONDS> [default: 0]
--credential-file <PATH>
--progress-cursor <BASE64_CURSOR>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contextual ack
Acknowledges one exact contextual work-item lease
Usage: riffdb contextual ack [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER> --event-id <COMMIT:ORDINAL> --lease-token <64_HEX_CHARS> --history-incarnation <INCARNATION>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--event-id <COMMIT:ORDINAL>
--max-attempts <1..10>
--credential-file <PATH>
--lease-token <64_HEX_CHARS>
--history-incarnation <INCARNATION>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contextual nack
Negatively acknowledges one exact contextual work-item lease
Usage: riffdb contextual nack [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER> --event-id <COMMIT:ORDINAL> --lease-token <64_HEX_CHARS> --history-incarnation <INCARNATION>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--event-id <COMMIT:ORDINAL>
--max-attempts <1..10>
--credential-file <PATH>
--lease-token <64_HEX_CHARS>
--history-incarnation <INCARNATION>
--tls-trust-root <PATH>
--retry-delay-nanos <NANOSECONDS> [default: 0]
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contextual status
Reads bounded status for one exact contextual consumer
Usage: riffdb contextual status [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb contextual react
Executes one declared command reaction using its server-issued proof
Usage: riffdb contextual react [OPTIONS] --module-hash <64_HEX_CHARS> --operation <OPERATION> --consumer-name <CONSUMER> --reaction <REACTION> --causation-token <OPAQUE_LOWER_HEX> --command-name <COMMAND> --input <JSON_INPUT>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--operation <OPERATION>
--database <DATABASE>
--parameter <NAME=JSON_VALUE>
--consumer-name <CONSUMER>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--reaction <REACTION>
--causation-token <OPAQUE_LOWER_HEX>
--credential-file <PATH>
--command-name <COMMAND>
--tls-trust-root <PATH>
--input <JSON_INPUT>
--tls-server-name <SERVER_NAME>
--expected-version <VERSION>
-h, --help Print help
riffdb projection query
Usage: riffdb projection query [OPTIONS] --input <JSON_INPUT> <PROJECTION_ID>
Arguments:
<PROJECTION_ID>
Options:
--config <PATH>
--input <JSON_INPUT>
--contract-lineage <LINEAGE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--contract-version <VERSION>
--database <DATABASE>
--after <COMMIT_SEQUENCE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--wait-nanos <NANOSECONDS>
--credential-file <PATH>
--limit <ROWS>
--cursor <BASE64_CURSOR>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query describe
Usage: riffdb query describe [OPTIONS]
Options:
--config <PATH>
--contract-lineage <LINEAGE>
--contract-version <VERSION>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query check
Usage: riffdb query check [OPTIONS] [RIFFQL_SOURCE_OR_QUERY_NAME]
Arguments:
[RIFFQL_SOURCE_OR_QUERY_NAME]
Options:
--config <PATH>
--inline <RIFFQL> Checks an inline read-only RiffQL query string
--contract-lineage <LINEAGE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--contract-version <VERSION>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query explain
Usage: riffdb query explain [OPTIONS] [RIFFQL_SOURCE_OR_QUERY_NAME]
Arguments:
[RIFFQL_SOURCE_OR_QUERY_NAME]
Options:
--config <PATH>
--inline <RIFFQL> Explains an inline read-only RiffQL query string
--contract-lineage <LINEAGE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--contract-version <VERSION>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query run
Usage: riffdb query run [OPTIONS] [RIFFQL_SOURCE]
Arguments:
[RIFFQL_SOURCE]
Options:
--config <PATH>
--inline <RIFFQL>
Executes an inline read-only RiffQL query string
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--parameters <JSON_PARAMETERS>
--database <DATABASE>
--param <KEY=VALUE>
Inline query parameter as KEY=JSON_OR_STRING_VALUE (repeatable)
--output <human|json>
[possible values: human, json]
--params-json <JSON_OBJECT>
Inline query parameters as a JSON object string
--cursor <CURSOR>
--max-attempts <1..10>
--credential-file <PATH>
--read-after-commit <COMMIT_SEQUENCE>
--consistency <CONSISTENCY>
[possible values: admission-head]
--tls-trust-root <PATH>
--contract-lineage <LINEAGE>
--tls-server-name <SERVER_NAME>
--contract-version <VERSION>
-h, --help
Print help
riffdb query run-named
Usage: riffdb query run-named [OPTIONS] <QUERY_NAME>
Arguments:
<QUERY_NAME>
Options:
--config <PATH>
--module-hash <MODULE_HASH_HEX>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--parameters <JSON_PARAMETERS>
--database <DATABASE>
--param <KEY=VALUE>
Inline query parameter as KEY=JSON_OR_STRING_VALUE (repeatable)
--output <human|json>
[possible values: human, json]
--params-json <JSON_OBJECT>
Inline query parameters as a JSON object string
--cursor <CURSOR>
--max-attempts <1..10>
--credential-file <PATH>
--read-after-commit <COMMIT_SEQUENCE>
--consistency <CONSISTENCY>
[possible values: admission-head]
--tls-trust-root <PATH>
--contract-lineage <LINEAGE>
--tls-server-name <SERVER_NAME>
--contract-version <VERSION>
-h, --help
Print help
riffdb query watch
Receives one closed update from an exact generated live named query
Usage: riffdb query watch [OPTIONS] --module-hash <64_HEX_CHARS> <OPERATION>
Arguments:
<OPERATION>
Options:
--config <PATH>
--module-hash <64_HEX_CHARS>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--parameter <NAME=JSON_VALUE>
--cursor <BASE64_CURSOR>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query deploy
Usage: riffdb query deploy [OPTIONS] --module-name <MODULE_NAME> --module-version <POSITIVE_VERSION> <QUERY_DIRECTORY>
Arguments:
<QUERY_DIRECTORY>
Options:
--config <PATH>
--module-name <MODULE_NAME>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--module-version <POSITIVE_VERSION>
--database <DATABASE>
--expected-active <any|absent|MODULE_HASH_HEX> [default: any]
--contract-lineage <LINEAGE>
--output <human|json> [possible values: human, json]
--contract-version <VERSION>
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query module
Usage: riffdb query module [OPTIONS]
Options:
--config <PATH>
--module-hash <MODULE_HASH_HEX>
--contract-lineage <LINEAGE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--contract-version <VERSION>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query repl
Usage: riffdb query repl [OPTIONS]
Options:
--config <PATH>
--contract-lineage <LINEAGE>
--contract-version <VERSION>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb query inspect-vector
Inspects authoritative vector freshness or model-version state
Usage: riffdb query inspect-vector [OPTIONS] --partition <JSON_VALUE> <ENTITY> <FIELD>
Arguments:
<ENTITY> Symbolic entity name that owns the maintained vector field
<FIELD> Symbolic maintained vector field name
Options:
--config <PATH>
--partition <JSON_VALUE>
Exact partition value as typed InputValue JSON
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--kind <KIND>
Whether to inspect stale evidence or outdated model versions [default: stale] [possible values: stale, outdated]
--database <DATABASE>
--limit <ROWS>
Maximum returned entity items when row policy forbids summary counts
--cursor-hex <HEX>
Opaque continuation cursor as lower-hex bytes
--output <human|json>
[possible values: human, json]
--contract-lineage <LINEAGE>
--max-attempts <1..10>
--contract-version <VERSION>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb query projected
Executes one org-scoped projected columnar query under a freshness policy
Usage: riffdb query projected [OPTIONS] --org-scope <JSON_VALUE> <PROJECTION_NAME>
Arguments:
<PROJECTION_NAME> Registered projection name
Options:
--config <PATH>
--org-scope <JSON_VALUE>
Organization scope as typed InputValue JSON (e.g. `{"type":"uuid","value":"..."}`)
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--select <FIELD>
Selected field names (repeatable). Empty = all projected fields
--database <DATABASE>
--eq <FIELD=JSON_VALUE>
Equality predicate as `FIELD=JSON_VALUE` (repeatable)
--output <human|json>
[possible values: human, json]
--range <FIELD=[LOW,HIGH]>
Range predicate as `FIELD=[LOW_JSON,HIGH_JSON]`: a JSON two-element array whose bounds are typed JSON values or `null` for unbounded (inclusive low, exclusive high; at least one bound; repeatable)
--max-attempts <1..10>
--order <FIELD[:desc]>
Order key as `FIELD` or `FIELD:desc` (repeatable). With `--group-by`, every ordered field must be a group-by key
--aggregate <OP:FIELD|count>
Aggregate as `OP:FIELD` where OP is `count_present`, `count_distinct`, `count_distinct_present`, `sum`, `mean`, `min`, `max`, `any`, or `all`, or the bare word `count` (repeatable). Any aggregate returns groups instead of rows; more than one requires `--group-by`
--credential-file <PATH>
--group-by <FIELD>
Group-by key field name (repeatable)
--tls-trust-root <PATH>
--limit <ROWS>
Post-sort row or group limit. With unordered `--group-by` this is the maximum number of groups (exceeding it is rejected); with `--group-by` and `--order` it truncates to the top N ordered groups; it does not apply to an aggregate without `--group-by`
--tls-server-name <SERVER_NAME>
--freshness <POLICY>
Freshness policy: `available`, `bounded:N`, or `causal` (requires token) [default: available]
--token-hex <HEX>
Opaque commit-token bytes as hex, exactly as `commit_token` is reported by a ready projected read (causal only)
--token-file <PATH>
Opaque commit-token raw bytes (not hex) from a file (causal only)
--token-stdin
Opaque commit-token raw bytes (not hex) from stdin (causal only)
--max-wait-nanos <NANOSECONDS>
Maximum wait for causal catch-up (nanoseconds). Default 30s
--packed
Request packed column-major Ready encoding
--contract-lineage <LINEAGE>
--contract-version <VERSION>
-h, --help
Print help
riffdb role check
Usage: riffdb role check [OPTIONS] --role <ROLE> <APPLICATION_MANIFEST>
Arguments:
<APPLICATION_MANIFEST>
Options:
--config <PATH>
--role <ROLE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--tenant <TENANT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb role describe
Usage: riffdb role describe [OPTIONS] --role <ROLE> <APPLICATION_MANIFEST>
Arguments:
<APPLICATION_MANIFEST>
Options:
--config <PATH>
--role <ROLE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--tenant <TENANT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb role bind
Usage: riffdb role bind [OPTIONS] --role <ROLE> --principal <PRINCIPAL> --actor-kind <human|agent|service> --audience <AUDIENCE> --credential-output <PATH> <APPLICATION_MANIFEST>
Arguments:
<APPLICATION_MANIFEST>
Options:
--config <PATH>
--role <ROLE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--tenant <TENANT>
--database <DATABASE>
--principal <PRINCIPAL>
--actor-kind <human|agent|service>
[possible values: human, agent, service]
--output <human|json>
[possible values: human, json]
--lifetime-seconds <SECONDS>
[default: 3600]
--max-attempts <1..10>
--audience <AUDIENCE>
--credential-file <PATH>
--principal-facts <JSON_OBJECT_PATH>
Operator-owned bounded fact values for a compiler-protected role
--tls-trust-root <PATH>
--capability-id <CAPABILITY_UUIDV7>
--tls-server-name <SERVER_NAME>
--credential-output <PATH>
-h, --help
Print help
riffdb role revoke
Usage: riffdb role revoke [OPTIONS] --reason <REASON> <CAPABILITY_UUIDV7>
Arguments:
<CAPABILITY_UUIDV7>
Options:
--config <PATH>
--reason <REASON>
[possible values: requested, replaced, suspected_compromise, policy_change]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb capability bootstrap
Usage: riffdb capability bootstrap [OPTIONS] --request <JSON_REQUEST>
Options:
--config <PATH>
--request <JSON_REQUEST>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--generate <PATH>
--bootstrap-file <PATH>
--database <DATABASE>
--bootstrap-stdin
--output <human|json> [possible values: human, json]
--bearer-output <PATH>
--max-attempts <1..10>
--credential-file <PATH>
--inventory-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb capability create
Usage: riffdb capability create [OPTIONS] --request <JSON_REQUEST> --credential-output <PATH>
Options:
--config <PATH>
--request <JSON_REQUEST>
--capability-id <CAPABILITY_UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--credential-output <PATH>
--database <DATABASE>
--inventory-file <PATH>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb capability revoke
Usage: riffdb capability revoke [OPTIONS] --reason <REASON> <CAPABILITY_UUIDV7>
Arguments:
<CAPABILITY_UUIDV7>
Options:
--config <PATH>
--reason <REASON>
[possible values: requested, replaced, suspected_compromise, policy_change]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--inventory-file <PATH>
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb capability list
Lists non-secret capability summaries from a quiescent database path or local operator inventory file
Usage: riffdb capability list [OPTIONS]
Options:
--config <PATH>
--database-path <PATH>
Quiescent local Redb database path to inspect
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--inventory-file <PATH>
Non-secret operator capability inventory JSON file to inspect
--database <DATABASE>
--status <STATUS>
Filter by capability lifecycle status (`active` or `revoked`) [possible values: active, revoked]
--output <human|json>
[possible values: human, json]
--principal <PRINCIPAL>
Filter by exact principal identifier
--after <CAPABILITY_UUIDV7>
Resume pagination strictly after the given capability UUIDv7
--max-attempts <1..10>
--credential-file <PATH>
--limit <COUNT>
Bounded page size (`1..=256`, default `100`) [default: 100]
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb capability show
Shows non-secret capability details from a quiescent database path or local operator inventory file
Usage: riffdb capability show [OPTIONS] <CAPABILITY_UUIDV7>
Arguments:
<CAPABILITY_UUIDV7>
Options:
--config <PATH>
--database-path <PATH>
Quiescent local Redb database path to inspect
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--inventory-file <PATH>
Non-secret operator capability inventory JSON file to inspect
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb capability rotate
Rotates an active capability into a replacement capability with identical grants, atomically writes the replacement credential file, and optionally revokes the superseded capability
Usage: riffdb capability rotate [OPTIONS] --credential-output <PATH> <CAPABILITY_UUIDV7>
Arguments:
<CAPABILITY_UUIDV7> Existing capability UUIDv7 to rotate
Options:
--config <PATH>
--credential-output <PATH>
Destination path for the newly issued bearer credential
--capability-id <NEW_CAPABILITY_UUIDV7>
Optional explicit UUIDv7 for the replacement capability
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--ttl-ms <MILLISECONDS>
Optional lifetime override in milliseconds (rounded up to whole seconds)
--output <human|json>
[possible values: human, json]
--revoke-old
Revoke the superseded capability (`reason = replaced`) after retaining the new credential
--max-attempts <1..10>
--request <JSON_REQUEST>
Optional JSON capability-create request template supplying the grant to preserve
--credential-file <PATH>
--inventory-file <PATH>
Non-secret operator capability inventory JSON file to read and update
--database-path <PATH>
Quiescent local Redb database path to read the source capability grant from
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb follower status
Inspects replication role, frontiers, lag sequences, and registered followers
Usage: riffdb follower status [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb follower failover
Fences the primary and promotes this follower in one audited cutover sequence
Usage: riffdb follower failover [OPTIONS] --database-id <SOURCE_DATABASE_UUIDV7> --history-incarnation <NONZERO_U64> --leadership-epoch <NONZERO_U64> --hold-id <32_LOWERCASE_HEX_DIGITS> --registration-generation <REGISTRATION_GENERATION>
Options:
--config <PATH>
--database-id <SOURCE_DATABASE_UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--history-incarnation <NONZERO_U64>
--database <DATABASE>
--leadership-epoch <NONZERO_U64>
--hold-id <32_LOWERCASE_HEX_DIGITS>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--registration-generation <REGISTRATION_GENERATION>
--credential-file <PATH>
--primary-endpoint <URI>
Primary endpoint URI to fence before promoting this follower
--primary-config <PATH>
Operator client configuration file targeting the primary to fence
--tls-trust-root <PATH>
--primary-credential-file <PATH>
Optional credential file for fencing the primary (defaults to primary config or current credential)
--tls-server-name <SERVER_NAME>
--operation-id <PROMOTION_OPERATION_UUIDV7>
Promotion operation UUIDv7 (minted automatically when omitted)
--fence-operation-id <FENCE_OPERATION_UUIDV7>
Primary fence operation UUIDv7 (minted automatically when omitted)
-h, --help
Print help
riffdb follower promote
Promotes a follower using the configured source's authenticated fence proof
Usage: riffdb follower promote [OPTIONS] --database-id <SOURCE_DATABASE_UUIDV7> --history-incarnation <NONZERO_U64> --leadership-epoch <NONZERO_U64> --hold-id <32_LOWERCASE_HEX_DIGITS> --registration-generation <REGISTRATION_GENERATION> --operation-id <PROMOTION_OPERATION_UUIDV7> --fence-operation-id <FENCE_OPERATION_UUIDV7>
Options:
--config <PATH>
--database-id <SOURCE_DATABASE_UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--history-incarnation <NONZERO_U64>
--database <DATABASE>
--leadership-epoch <NONZERO_U64>
--hold-id <32_LOWERCASE_HEX_DIGITS>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--registration-generation <REGISTRATION_GENERATION>
--credential-file <PATH>
--operation-id <PROMOTION_OPERATION_UUIDV7>
--fence-operation-id <FENCE_OPERATION_UUIDV7>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb follower fence-primary
Permanently fences this primary; it may remain unavailable if promotion fails
Usage: riffdb follower fence-primary [OPTIONS] --database-id <SOURCE_DATABASE_UUIDV7> --history-incarnation <NONZERO_U64> --leadership-epoch <NONZERO_U64> --hold-id <32_LOWERCASE_HEX_DIGITS> --registration-generation <REGISTRATION_GENERATION> --operation-id <OPERATION_ID>
Options:
--config <PATH>
--database-id <SOURCE_DATABASE_UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--history-incarnation <NONZERO_U64>
--database <DATABASE>
--leadership-epoch <NONZERO_U64>
--hold-id <32_LOWERCASE_HEX_DIGITS>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--registration-generation <REGISTRATION_GENERATION>
--credential-file <PATH>
--operation-id <OPERATION_ID>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb follower register
Registers or exactly replays the selected immutable policy
Usage: riffdb follower register [OPTIONS] --database-id <SOURCE_DATABASE_UUIDV7> --history-incarnation <NONZERO_U64> --leadership-epoch <NONZERO_U64> --hold-id <32_LOWERCASE_HEX_DIGITS> --hold-budget-sequences <NONZERO_U64>
Options:
--config <PATH>
--database-id <SOURCE_DATABASE_UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--history-incarnation <NONZERO_U64>
--database <DATABASE>
--leadership-epoch <NONZERO_U64>
--hold-id <32_LOWERCASE_HEX_DIGITS>
--output <human|json> [possible values: human, json]
--hold-budget-sequences <NONZERO_U64>
--max-attempts <1..10>
--credential-file <PATH>
--expires-at-sequence <NONZERO_APPLICATION_SEQUENCE>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb follower retire
Retires only the original generation reported by registration
Usage: riffdb follower retire [OPTIONS] --database-id <SOURCE_DATABASE_UUIDV7> --history-incarnation <NONZERO_U64> --leadership-epoch <NONZERO_U64> --hold-id <32_LOWERCASE_HEX_DIGITS> --registration-generation <NONZERO_U64>
Options:
--config <PATH>
--database-id <SOURCE_DATABASE_UUIDV7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--history-incarnation <NONZERO_U64>
--database <DATABASE>
--leadership-epoch <NONZERO_U64>
--hold-id <32_LOWERCASE_HEX_DIGITS>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--registration-generation <NONZERO_U64>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb server health
Usage: riffdb server health [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb backup create
Usage: riffdb backup create [OPTIONS] <NAME>
Arguments:
<NAME>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb backup restore
Usage: riffdb backup restore [OPTIONS] <NAME>
Arguments:
<NAME>
Options:
--config <PATH>
--confirm-replace-current-database
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb backup retire
Retires one exact immutable backup through the receipted public surface
Usage: riffdb backup retire [OPTIONS] <NAME>
Arguments:
<NAME>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb backup operation
Usage: riffdb backup operation [OPTIONS] <MAINTENANCE_OPERATION_ID>
Arguments:
<MAINTENANCE_OPERATION_ID>
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb export start
Starts or exactly replays one immutable snapshot export
Usage: riffdb export start [OPTIONS] --lineage <CONTRACT_LINEAGE> --scope <principal|whole>
Options:
--config <PATH>
--lineage <CONTRACT_LINEAGE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--scope <principal|whole>
Possible values:
- principal: Apply the current application role's row and field policy
- whole: Use explicit whole-application export authority
--database <DATABASE>
--entities
--events
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--provenance
--credential-file <PATH>
--public-audit
--lease-seconds <60..86400>
[default: 3600]
--tls-trust-root <PATH>
--operation-id <UUID_V7>
--tls-server-name <SERVER_NAME>
--portability-manifest <PORTABILITY_MANIFEST_JSON>
Starts a portability-intent export bound to this exact canonical manifest
-h, --help
Print help (see a summary with '-h')
riffdb export page
Writes one exact bounded page to a newly created canonical JSONL file
Usage: riffdb export page [OPTIONS] --operation-id <UUID_V7> --cursor <OPAQUE_BASE64_CURSOR> --jsonl <NEW_JSONL_FILE>
Options:
--config <PATH>
--operation-id <UUID_V7>
--cursor <OPAQUE_BASE64_CURSOR>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--max-rows <1..500> [default: 500]
--jsonl <NEW_JSONL_FILE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb export status
Observes one durable export checkpoint or terminal receipt
Usage: riffdb export status [OPTIONS] --operation-id <UUID_V7>
Options:
--config <PATH>
--operation-id <UUID_V7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb export cancel
Closes one nonterminal export with a durable incomplete receipt
Usage: riffdb export cancel [OPTIONS] --operation-id <UUID_V7>
Options:
--config <PATH>
--operation-id <UUID_V7>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb reimport start
Starts or exactly replays one immutable reimport campaign
Usage: riffdb reimport start [OPTIONS] --lineage <CONTRACT_LINEAGE> --scope <principal|whole> --portability-manifest <PORTABILITY_MANIFEST_JSON> --export-manifest <EXPORT_MANIFEST_JSON> --export-receipt <EXPORT_RECEIPT_JSON>
Options:
--config <PATH>
--lineage <CONTRACT_LINEAGE>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--scope <principal|whole>
Possible values:
- principal: Reconstitute only the principal-filtered source authorized by the grant
- whole: Reconstitute the explicitly authorized whole-application source
--database <DATABASE>
--portability-manifest <PORTABILITY_MANIFEST_JSON>
--export-manifest <EXPORT_MANIFEST_JSON>
--output <human|json>
[possible values: human, json]
--export-receipt <EXPORT_RECEIPT_JSON>
--max-attempts <1..10>
--campaign-id <UUID_V7>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help (see a summary with '-h')
riffdb reimport page
Applies one exact hash-bearing entity page from the source export
Usage: riffdb reimport page [OPTIONS] --campaign-id <UUID_V7> --export-operation-id <UUID_V7> --page-number <POSITIVE_INTEGER> --jsonl <CANONICAL_JSONL_FILE> --page-hash <LOWER_HEX_SHA256>
Options:
--campaign-id <UUID_V7>
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--export-operation-id <UUID_V7>
--database <DATABASE>
--page-number <POSITIVE_INTEGER>
--jsonl <CANONICAL_JSONL_FILE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--page-hash <LOWER_HEX_SHA256>
--class-complete
--credential-file <PATH>
--operation-complete
--tls-trust-root <PATH>
--next-cursor <OPAQUE_BASE64_CURSOR>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb reimport status
Observes one durable reimport checkpoint or terminal receipt
Usage: riffdb reimport status [OPTIONS] --campaign-id <UUID_V7>
Options:
--campaign-id <UUID_V7>
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb reimport cancel
Cancels one nonterminal reimport campaign
Usage: riffdb reimport cancel [OPTIONS] --campaign-id <UUID_V7>
Options:
--campaign-id <UUID_V7>
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb storage restore
Restores a full backup plus its configured archive through maintenance admission
Usage: riffdb storage restore [OPTIONS] --archive <ARCHIVE_NAME> <BACKUP_NAME>
Arguments:
<BACKUP_NAME>
Options:
--archive <ARCHIVE_NAME>
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--stop-at-sequence <STOP_AT_SEQUENCE>
--confirm-replace-current-database
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb storage scrub
Requests the complete offline storage validation pass. It takes the database offline, validates it, and reopens it; observe the printed operation with `riffdb backup operation`
Usage: riffdb storage scrub [OPTIONS]
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb storage preflight
Compares the retained format identity without opening the database
Usage: riffdb storage preflight [OPTIONS] --database-path <PATH>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb storage upgrade
Runs the sole manifest-authorized offline transition from a verified backup
Usage: riffdb storage upgrade [OPTIONS] --database-path <PATH> --backup <BACKUP_DIRECTORY>
Options:
--config <PATH>
--database-path <PATH>
--backup <BACKUP_DIRECTORY>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb storage compact
Compacts freed pages in a closed database file and lowers its on-disk high-water mark
Usage: riffdb storage compact [OPTIONS] --database-path <PATH>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention status
Prints the retention watermark and fencing breakdown for a closed database
Usage: riffdb retention status [OPTIONS] --database-path <PATH>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention hold
Operator hold management (add / remove)
Usage: riffdb retention hold [OPTIONS] <COMMAND>
Commands:
add
remove
Options:
--config <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention projection-detach
Detaches a projection identity from the fencing minimum (audited)
Usage: riffdb retention projection-detach [OPTIONS] --database-path <PATH> --projection-id <ID> --reason <TEXT>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--projection-id <ID>
--database <DATABASE>
--reason <TEXT>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention projection-reattach
Reattaches a previously detached projection to the minimum (audited)
Usage: riffdb retention projection-reattach [OPTIONS] --database-path <PATH> --projection-id <ID> --reason <TEXT>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--projection-id <ID>
--database <DATABASE>
--reason <TEXT>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention prune
Offline prune of commits/events/outbox through a target inclusive sequence
Usage: riffdb retention prune [OPTIONS] --database-path <PATH> --target-sequence <N>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--target-sequence <N>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb demo budget
Usage: riffdb demo budget [OPTIONS] --runner <PATH> --case <CASE>
Options:
--config <PATH>
--runner <PATH>
--case <CASE>
[possible values: sequential, contention, same_key_replay]
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--output <human|json>
[possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help
Print help
riffdb outbox archive inspect
Validates bounded pages without exposing event payloads. Requires exclusive archive custody
Usage: riffdb outbox archive inspect [OPTIONS] --directory <ABSOLUTE_DIRECTORY> --database-id <32_HEX_DATABASE_ID>
Options:
--config <PATH>
--directory <ABSOLUTE_DIRECTORY>
--database-id <32_HEX_DATABASE_ID>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--database <DATABASE>
--max-pages <1..256> [default: 1]
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention hold add
Usage: riffdb retention hold add [OPTIONS] --database-path <PATH> --hold-id <ID> --sequence <N> --reason <TEXT>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--hold-id <ID>
--database <DATABASE>
--sequence <N>
--output <human|json> [possible values: human, json]
--reason <TEXT>
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help
riffdb retention hold remove
Usage: riffdb retention hold remove [OPTIONS] --database-path <PATH> --hold-id <ID>
Options:
--config <PATH>
--database-path <PATH>
--endpoint <HTTP_OR_HTTPS_ENDPOINT>
--hold-id <ID>
--database <DATABASE>
--output <human|json> [possible values: human, json]
--max-attempts <1..10>
--credential-file <PATH>
--tls-trust-root <PATH>
--tls-server-name <SERVER_NAME>
-h, --help Print help