ReferenceCLI
stash encrypt
Reference for the `stash encrypt` commands.
Generated from stash v1.0.0 via npx [email protected] manifest --json. Run npx [email protected] --help to see the live command surface.
The stash encrypt command group.
encrypt status
Show per-column migration status (phase, progress, drift)
npx stash encrypt statusencrypt plan
Diff intent (.cipherstash/migrations.json) vs observed state
npx stash encrypt planencrypt backfill
Resumably encrypt plaintext into the encrypted column
npx stash encrypt backfill [flags]Flags
| Flag | Description |
|---|---|
--table <name> | Target table. |
--column <name> | Target column. |
--pk-column <name> | Primary-key column used to page through rows. |
--chunk-size <n> | Rows encrypted per batch. |
--encrypted-column <name> | Destination encrypted column. |
--schema-column-key <key> | Schema key identifying the column config. |
--confirm-dual-writes-deployed | Assert the app is dual-writing before backfilling (safety gate). |
--force | Proceed past non-fatal safety checks. |
encrypt drop
Generate a migration to drop the plaintext column
npx stash encrypt drop [flags]Flags
| Flag | Description |
|---|---|
--table <name> | Target table. |
--column <name> | Target column. |
--migrations-dir <path> | Directory to write the drop migration into. |