vakna snapshot

Verified against vakna 0.0.0-mock on 2026-10-20 · generated from the CLI's own definitions

vakna snapshot: take a point-in-time image of a box, to fork from. Proposed: the real CLI doesn't have this command yet.

Synopsis

vakna snapshot <box>

Flags

Flag	Default	What it does
`--format <format>`	`text`	text, or json: one JSON object per line
`--json`	`off`	the same as --format json
`-h, --help`	`off`	this help

Examples

Example

vakna snapshot api

prints snapshot snp_eu1a_z7a8b9c0 taken 0.19s

Exit code 0.

Another example

vakna snapshot api --format json

prints {"v":1,"event":"snapshot","box":"api","id":"sbx_eu1a_01JB7X9K3M4N5P6Q7R8S9T0V1W","snapshot":"snp_eu1a_01JB83S1T2V3W4X5Y6Z7A8B9C0","ms":190,"mocked":true}

Exit code 0.

When it fails

vakna snapshot apj

prints vakna: no box "apj" hint: vakna list # did you mean api?

Exit code 1.

Exit codes

Code	Meaning
0	ok
1	vakna failed; under shell, run, try or fork, the command in the box failed
2	usage: a missing argument, an unknown flag or command

JSON output

With --format json (or --json) every line is one JSON object. v is the format's version; mocked marks numbers from the mock.

vakna snapshot api --format json

prints {"v":1,"event":"snapshot","box":"api","id":"sbx_eu1a_01JB7X9K3M4N5P6Q7R8S9T0V1W","snapshot":"snp_eu1a_01JB83S1T2V3W4X5Y6Z7A8B9C0","ms":190,"mocked":true}

Errors

vakna: unknown command, unknown flag or missing argument: Run vakna <command> --help and fix the command line it points to.
vakna: no box "<box>": Run vakna list and use a name from it.
vakna: "<id>" matches more than one box: Use the box's name or its full id; vakna list shows both.

--help

This page and the help text come from one definition.

vakna snapshot · take a point-in-time image of a box, to fork from Proposed: the real CLI doesn't have this command yet. usage vakna snapshot <box> flags --format <format> text, or json: one JSON object per line (default: text) --json the same as --format json (default: off) -h, --help this help (default: off) examples vakna snapshot api vakna snapshot api --format json exit codes 0 ok 1 vakna failed; under shell, run, try or fork, the command in the box failed 2 usage: a missing argument, an unknown flag or command