Commands

vakna create: create a box

Note
This page is generated from a mock CLI, and its numbers are placeholders.

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

vakna create: create a box; its name goes to stdout.

Synopsis

sh
vakna create [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

sh
vakna create
prints created box-1 · started in 0.41s · cold boot box-1

Exit code 0.

Another example

sh
box=$(vakna create) && vakna shell "$box" -- uname -a
prints created box-1 · started in 0.41s · cold boot ran uname -a · exit 0 0.40s

Exit code 0.

When it fails

sh
vakna create api
prints vakna: a box named api already exists hint: vakna list

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.

sh
vakna create --json
prints {"v":1,"event":"created","box":"box-1","id":"sbx_eu1a_01JB83A1B2C3D4E5F6G7H8J9K0","ms":405,"from":"cold","mocked":true}

Errors

--help

This page and the help text come from one definition.

Output
vakna create · create a box; its name goes to stdout usage vakna create [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 create box=$(vakna create) && vakna shell "$box" -- uname -a 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

View as Markdown