Commands · reference

config-weave list

2 min read · 2026-09-02 · config-weave 0.1.0

list prints the plays defined in a playbook, with their step counts and descriptions, followed by any playbook-local composites. It loads the playbook and reports load errors, but it does not run the full validation pipeline and never executes a script. With --json it prints the complete inventory instead: plays, composites and every package with its resources, gatherers, tests and scenarios.

Synopsis

console

config-weave list [OPTIONS] <PLAYBOOK_DIR>

Arguments

Argument	Meaning
PLAYBOOK_DIR	The playbook directory.

Options

All global options apply. --json changes the output as described below; the others have no effect.

Examples

The human-readable form.

console

config-weave list ./my-playbook
my-playbook v0.1.0 — A starter playbook
  baseline  (3 steps) — Base configuration for every host
  web  (5 steps) — Web tier
composites:
  user_with_home  (2 steps) — A user and its home directory

The JSON inventory. Each package entry carries name, description, builtin, resources (with concurrency and params), composites, gatherers, tests (with machine_kind, source and group) and scenarios.

console

config-weave list ./my-playbook --json | jq '.packages[].tests[] | "\(.name) on \(.source)"'

Exit status

0 when the playbook loaded. 2 when it could not be parsed or failed a load-time check.