Skip to content

cayu storage

Generated from the released command parser. These commands show help only; operations run when you invoke the command without --help.

Terminal window
usage: cayu storage [-h] {status,migrate,export} ...


Inspect, migrate, and export Cayu storage. Schema changes are explicit; start
with `cayu storage status`.


positional arguments:
  {status,migrate,export}
    status              Show the database schema revision and any pending
                        migrations.
    migrate             Apply pending forward migrations under the backend
                        lock.
    export              Export sessions (or tasks) as JSON or JSONL for
                        backup/replay.


options:
  -h, --help            show this help message and exit

cayu storage status

Section titled “cayu storage status”
Terminal window
usage: cayu storage status [-h] [--sqlite PATH | --postgres DSN]
                           [--acknowledge-breaking REVISION]
                           [--reset-empty-recall-state]
                           [--format {json,table} | --json | --table]
                           [--output FILE]


Show the database schema revision and any pending migrations. Without --sqlite
or --postgres, the target resolves from CAYU_DATABASE_URL, then
[tool.cayu.session_store]. Use `--output FILE` to write data to a destination.
Exits 0 when up to date, 3 when a forward migration is available, and 4 when
this build cannot migrate the database with the given inputs.


options:
  -h, --help            show this help message and exit
  --sqlite PATH         Path to a SQLite database file (overrides the resolved
                        target).
  --postgres DSN        Postgres connection string (overrides the resolved
                        target). Prefer CAYU_DATABASE_URL to keep credentials
                        off the command line.
  --acknowledge-breaking REVISION
                        Acknowledge one exact pending breaking revision;
                        repeat for every breaking boundary in the planned
                        path.
  --reset-empty-recall-state
                        Authorize rebuilding the empty prerelease recall
                        checkpoint/delivery tables when crossing revision 73.
  --format {json,table}
                        Output format (default: json).
  --json                Emit JSON (shorthand for `--format json`).
  --table               Emit human-readable output (shorthand for `--format
                        table`).
  --output, -o FILE     Write output to FILE instead of stdout.

cayu storage migrate

Section titled “cayu storage migrate”
Terminal window
usage: cayu storage migrate [-h] [--sqlite PATH | --postgres DSN]
                            [--backup PATH | --backup-sha256 SHA256 |
                            --backup-managed REF | --waive-backup]
                            [--acknowledge-breaking REVISION]
                            [--reset-empty-recall-state]
                            [--format {json,table} | --json | --table]
                            [--output FILE]


Apply pending forward migrations under the backend lock. Without --sqlite or
--postgres, the target resolves from CAYU_DATABASE_URL, then
[tool.cayu.session_store]. Use `--output FILE` to write data to a destination.


options:
  -h, --help            show this help message and exit
  --sqlite PATH         Path to a SQLite database file (overrides the resolved
                        target).
  --postgres DSN        Postgres connection string (overrides the resolved
                        target). Prefer CAYU_DATABASE_URL to keep credentials
                        off the command line.
  --backup PATH         SQLite backup destination (default: a unique sibling
                        file). Not valid for Postgres.
  --backup-sha256 SHA256
                        Attest an application-consistent Postgres backup by
                        its lowercase SHA-256 digest.
  --backup-managed REF  Record a provider-managed Postgres backup: rds-
                        snapshot:<snapshot identifier> or rds-pitr:<RFC 3339
                        UTC timestamp>.
  --waive-backup        Explicitly waive retained backup/restore authority.
  --acknowledge-breaking REVISION
                        Acknowledge one exact pending breaking revision;
                        repeat for every breaking boundary in the planned
                        path.
  --reset-empty-recall-state
                        Authorize rebuilding the empty prerelease recall
                        checkpoint/delivery tables when crossing revision 73.
  --format {json,table}
                        Output format (default: json).
  --json                Emit JSON (shorthand for `--format json`).
  --table               Emit human-readable output (shorthand for `--format
                        table`).
  --output, -o FILE     Write output to FILE instead of stdout.

cayu storage export

Section titled “cayu storage export”
Terminal window
usage: cayu storage export [-h] [--sqlite PATH | --postgres DSN] [--tasks]
                           [--max-session-bytes MAX_SESSION_BYTES]
                           [--max-record-bytes MAX_RECORD_BYTES]
                           [--format {json,jsonl} | --json | --jsonl]
                           [--output FILE]


Export sessions (or tasks) as JSON or JSONL for backup/replay. Without
--sqlite or --postgres, the target resolves from CAYU_DATABASE_URL, then
[tool.cayu.session_store]. Use `--output FILE` to write data to a destination.


options:
  -h, --help            show this help message and exit
  --sqlite PATH         Path to a SQLite database file (overrides the resolved
                        target).
  --postgres DSN        Postgres connection string (overrides the resolved
                        target). Prefer CAYU_DATABASE_URL to keep credentials
                        off the command line.
  --tasks               Export tasks instead of sessions.
  --max-session-bytes MAX_SESSION_BYTES
                        Session export byte ceiling (default: 67108864); raise
                        for large histories.
  --max-record-bytes MAX_RECORD_BYTES
                        Session component byte ceiling (default: 8388608);
                        does not change stored-value validation.
  --format {json,jsonl}
                        Output format (default: json).
  --json                Emit JSON (shorthand for `--format json`).
  --jsonl               Emit JSON Lines (shorthand for `--format jsonl`).
  --output, -o FILE     Write output to FILE instead of stdout.
Section titled “Related guides”

Getting started · Operations · Configuration