CLI reference

Generated straight from switchback --help and each command's own--help, so this page can never say something the CLI itself does not. Run most commands with --json for machine-readable output (init is the exception), or -h in place of --help.

switchback init

          usage: switchback init [--defaults] [--force]
        

switchback profile

          usage: switchback profile [--json] [--path] [--set key=value ...] [--import file|-]
        

switchback list

          usage: switchback list [--kind page|piece|preset] [--tag T] [--phase diverge|converge|either] [--fits-kit] [--all] [--json]
        

switchback show

          usage: switchback show <component-or-preset-id> [--json]
        

switchback build

          usage: switchback build <spec.json> [-o out.html] [--paper A4|Letter] [--pdf] [--open] [--json]
        

switchback proof

          usage: switchback proof <doc.md|-> [-o spec.json] [--title T] [--paper A4|Letter] [--max-pages N] [--json]
        

switchback media

          usage: switchback media <files…> [-o dir] [--max 1800] [--tiles auto|off] [--json]
        

switchback legend

          usage: switchback legend [--json]
        

switchback validate

          usage: switchback validate [spec.json] [--strict] [--json]