Commands

vakna claim: keep a trial 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 claim: keep a trial box: sign in and it stays yours. Proposed: the real CLI doesn't have this command yet.

Synopsis

sh
vakna claim <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 claim acme-api
prints vakna: no box "acme-api" hint: vakna list # it lists your boxes

Exit code 1.

Another example

sh
vakna claim acme-api --format json
prints {"v":1,"event":"error","code":"not_found","message":"no box \"acme-api\"","hint":"vakna list # it lists your boxes","docs":"https://vakna.com/docs/errors/not_found","mocked":true}

Exit code 1.

When it fails

sh
vakna claim 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.

sh
vakna claim acme-api --format json
prints {"v":1,"event":"error","code":"not_found","message":"no box \"acme-api\"","hint":"vakna list # it lists your boxes","docs":"https://vakna.com/docs/errors/not_found","mocked":true}

Errors

--help

This page and the help text come from one definition.

Output
vakna claim · keep a trial box: sign in and it stays yours Proposed: the real CLI doesn't have this command yet. usage vakna claim <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 claim acme-api vakna claim acme-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

View as Markdown