.TH SPICEDB 1 "2026-07-24" "spicedb" "A modern permissions database"
.SH NAME
spicedb - A modern permissions database
.SH SYNOPSIS
\fBspicedb\fP [\fIoptions\&.\&.\&.\fP] [\fIargument\&.\&.\&.\fP]
.SH DESCRIPTION
A database that stores and computes permissions
.SH OPTIONS
.TP
\fB--log-format\fP
format of logs ("auto", "console", "json")
.TP
\fB--log-level\fP
verbosity of logging ("trace", "debug", "info", "warn", "error")
.TP
\fB--skip-release-check\fP
if true, skips checking for new SpiceDB releases
.SH COMMANDS
.TP
\fBcompletion\fP
.RS 4
Generate the autocompletion script for the specified shell
.RE
.TP
\fBCOMMANDS\fP
.RS 4
\fBbash\fP
.RS 4
Generate the autocompletion script for bash
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--no-descriptions\fP
disable completion descriptions
.RE
.TP
\fBfish\fP
.RS 4
Generate the autocompletion script for fish
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--no-descriptions\fP
disable completion descriptions
.RE
.TP
\fBpowershell\fP
.RS 4
Generate the autocompletion script for powershell
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--no-descriptions\fP
disable completion descriptions
.RE
.TP
\fBzsh\fP
.RS 4
Generate the autocompletion script for zsh
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--no-descriptions\fP
disable completion descriptions
.RE
.RE
.TP
\fBdatastore\fP
.RS 4
datastore operations
.RE
.TP
\fBCOMMANDS\fP
.RS 4
\fBgc\fP
.RS 4
executes garbage collection
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--datastore-allowed-migrations\fP
migration levels that will not fail the health check (in addition to the current head migration)
.TP
\fB--datastore-bootstrap-files\fP
bootstrap data yaml files to load
.TP
\fB--datastore-bootstrap-overwrite\fP
overwrite any existing data with bootstrap data (this can be quite slow)
.TP
\fB--datastore-bootstrap-timeout\fP
maximum duration before timeout for the bootstrap data to be written
.TP
\fB--datastore-conn-healthcheck-interval\fP
amount of time between connection health checks in a remote datastore's connection pool
.TP
\fB--datastore-conn-max-idletime\fP
maximum amount of time a connection can idle in a remote datastore's connection pool
.TP
\fB--datastore-conn-max-lifetime\fP
maximum amount of time a connection can live in a remote datastore's connection pool
.TP
\fB--datastore-conn-max-lifetime-jitter\fP
waits rand(0, jitter) after a connection is open for max lifetime to actually close the connection (default: 20%!o(MISSING)f max lifetime, 30m for CockroachDB)
.TP
\fB--datastore-conn-max-open\fP
number of concurrent connections open in a remote datastore's connection pool
.TP
\fB--datastore-conn-min-open\fP
number of minimum concurrent connections open in a remote datastore's connection pool
.TP
\fB--datastore-conn-ping-timeout\fP
amount of time to wait for a liveness ping against an acquired idle connection before discarding it in a remote datastore's connection pool
.TP
\fB--datastore-conn-pool-read-healthcheck-interval\fP
amount of time between connection health checks in a remote datastore's connection pool
.TP
\fB--datastore-conn-pool-read-max-idletime\fP
maximum amount of time a connection can idle in a remote datastore's connection pool