1. Home
2. Documentation
3. Command line

Command line

nkb lists, prints and checks packs, and on Windows types one value into the focused field. It runs in a terminal, a script or a CI pipeline.

nkb is its own program, separate from the palette, and it links no graphical toolkit, so it runs on a build server with no desktop at all. Everything it prints for a person goes to standard error, and everything a script takes goes to standard output, so nkb emit pack > file leaves a file of values and nothing else.

Every command answers --help with its usage, its options and what it does. The pages below are built from those answers, word for word, by the program’s own test, so they cannot drift from the program you run.

Commands

Options

The help, as the program prints it

What nkb --help prints, from nkb 0.1.0.

nkb 0.1.0 - malicious test data, one shortcut away

Usage:
  nkb <command> [options]

Commands:
  packs             List the packs this build can offer
  show <pack>       Print one pack in full
  emit <pack>       Print a pack's values for a script or a file
  send <pack>       Type one value into the focused field
  lint <file>       Check a pack file against the format rules
  fmt <file>        Rewrite a pack file in canonical shape
  new-pack <name>   Write the skeleton for a new pack

Options:
  -h, --help        Show this help and exit with 0
      --version     Print the version and exit with 0

The graphical interface is a separate executable: nkb-gui