Unsterwerx

Global Options

These options are available on every Unsterwerx command and subcommand.

Options

OptionShortTypeDefaultDescription
--jsonflagEnable machine-readable JSON transport for every command and subcommand
--data-dirpath~/.unsterwerxData directory for the database, CAS, and config
--configpathConfig file path (overrides default location)
--verbose-vflagIncrease verbosity. Can be repeated: -v (info), -vv (debug), -vvv (trace)
--help-hflagPrint help information
--version-VflagPrint version (top-level only)

JSON

--json is a root-global flag, so it can appear before or after the command path:

bash
unsterwerx --json status
unsterwerx status --json
unsterwerx knowledge build --json

JSON mode now uses one control-plane transport across the full CLI surface. Every command and subcommand emits the same envelope shape, command IDs are derived from the clap path in snake_case, and failures return a top-level error object on stdout. See JSON Output for the schema and examples.

--help and --version remain human-readable even when --json is present.

Data Directory

The data directory contains the SQLite database, CAS storage, and configuration. By default, it is ~/.unsterwerx/.

Override with --data-dir:

bash
unsterwerx --data-dir /path/to/data status

Or with the UNSTERWERX_DATA environment variable:

bash
export UNSTERWERX_DATA=/path/to/data
unsterwerx status

The --data-dir flag takes precedence over the environment variable.

Verbosity

Use -v flags to increase log output:

bash
unsterwerx -v ingest /path/to/docs      # info-level logging
unsterwerx -vv similarity                # debug-level logging
unsterwerx -vvv audit --verify           # trace-level logging

Version

bash
unsterwerx --version
unsterwerx 0.5.4