validate

libtmux-workspace 0.1.0.alpha.2 · Source

validate reads and checks a YAML or JSON workspace without starting tmux, opening a socket, creating a session, or running configured shell commands. Use it before inspecting or applying a plan.

Check a workspace¶

Save the complete example configuration as workspace.yaml, then validate it:

$ libtmux-workspace validate workspace.yaml

Success prints Workspace configuration is valid. and exits with status 0. To request a JSON result:

$ libtmux-workspace validate \
    --json \
    workspace.yaml

The result contains valid, profile, and version. Invalid configuration exits with status 2. In JSON mode, the error object is written to stdout; otherwise diagnostics go to stderr.

Options and limits¶

The common options control output and explicit environment expansion. Omit the filename only when the current directory contains exactly one discoverable configuration. --socket, --live, --attach, --switch, and --compensate are invalid for validation.

Validation checks the supported configuration format. It does not prove that a session name is free on a server, a shell command will succeed, or a program is installed. Use live planning to inspect the chosen server, and check load results when applying the workspace.

CLI parser and implementation.