Command reference¶
Generated from the installed root and reporter wheels, not source imports.
livingproof¶
Living Proof Labs: specs, evidence, assessments and portable reports.
Plugins come from packages explicitly installed in this Python environment.
Enable tab completion in this Bash shell: eval "$(livingproof completion bash)" For installed-file status and new-shell setup: livingproof completion status
Usage:
livingproof [OPTIONS] COMMAND [ARGS]...
Options:
--version Show this tool’s build identity and package version.
--help Show this message and exit.
capability¶
Work with capability evidence through installed plugins.
Usage:
livingproof capability [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
report¶
Validate a bundle, grade its evidence, then render the saved report.
Start with a bundle manifest: it contains version information, evidence paths and assessment references. Individual observation files are evidence referenced by that manifest, not standalone reporter input.
Run this example from the repository root or extracted source archive:
livingproof-capability-report validate examples/bundle/manifest.json livingproof-capability-report grade examples/bundle/manifest.json -o report.json livingproof-capability-report render report.json
For your own bundle, substitute its manifest path. Validate checks structure and evidence integrity; grade saves decisions; render displays them without regrading. Output files must be new; choose another name when rerunning.
Usage:
livingproof capability report [OPTIONS] COMMAND [ARGS]...
Options:
--version Show release or development identity, package version and
provenance source.
--help Show this message and exit.
grade¶
Grade a bundle MANIFEST into a new JSON report (no overwriting).
Use the bundle manifest, not an individual observation. From the repository root or extracted source archive, validate first, then save and view a report:
livingproof-capability-report validate examples/bundle/manifest.json livingproof-capability-report grade examples/bundle/manifest.json -o report.json livingproof-capability-report render report.json
Choose a new output filename when rerunning.
Usage:
livingproof capability report grade [OPTIONS] MANIFEST
Options:
--human FILE
--previous FILE Retain a completed report and append a new grade
revision.
--require-pass Write report, then exit nonzero unless all pass.
--policy TEXT [default: all-required-v1@1.0.0]
-o, --output PATH [required]
--help Show this message and exit.
human-template¶
Create an insufficient assessment for a person to review and complete.
Usage:
livingproof capability report human-template [OPTIONS] MANIFEST
Options:
--result TEXT [required]
-o, --output PATH [required]
--assessment-id TEXT [default: human-review]
--reviewer TEXT Self-declared reviewer identity; enables human-review
evaluator.
--recorded-at TEXT Review timestamp, required with --reviewer.
--help Show this message and exit.
render¶
Render saved decisions; never regrade or overwrite existing files.
REPORT_FILE is the JSON report created by grade, not the bundle manifest or an observation. Create it first with the bundled example from the repository root or extracted source archive:
livingproof-capability-report validate examples/bundle/manifest.json livingproof-capability-report grade examples/bundle/manifest.json -o report.json livingproof-capability-report render report.json livingproof-capability-report render report.json --format html -o report.html
Default stdout is a terminal table. Choose new output filenames when rerunning.
Usage:
livingproof capability report render [OPTIONS] REPORT_FILE
Options:
--format [table|json|html|csv] Default: table on stdout; HTML when --output
is supplied (v1 compatibility).
-o, --output PATH Write a new file; otherwise print to stdout.
Existing files are never overwritten.
--help Show this message and exit.
validate¶
Validate a bundle MANIFEST and its evidence integrity (no grading).
Pass the manifest JSON, not an individual evidence/observation file. It contains version information, evidence paths and assessment references.
From the repository root or extracted source archive:
livingproof-capability-report validate examples/bundle/manifest.json livingproof-capability-report grade examples/bundle/manifest.json -o report.json livingproof-capability-report render report.json
Validation checks integrity; grade saves decisions; render displays them.
Usage:
livingproof capability report validate [OPTIONS] MANIFEST
Options:
--help Show this message and exit.
completion¶
Show Bash setup/status and exact activation commands; no startup-file edits.
Enable in the CURRENT Bash shell: eval "$(livingproof completion bash)" Show installed files and NEW-shell setup: livingproof completion status
Usage:
livingproof completion [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
bash¶
Print Bash code. Activate with: eval "$(livingproof completion bash)".
Usage:
livingproof completion bash [OPTIONS]
Options:
--help Show this message and exit.
install¶
Register for this user in the standard directory; never edit startup files.
Requires bash-completion to be loaded in future shells. Existing unrelated files are never overwritten. No administrator privileges are requested.
Usage:
livingproof completion install [OPTIONS]
Options:
--remove Remove only the user registration created here.
--help Show this message and exit.
status¶
Show installed registration files and explain current/new-shell setup.
Usage:
livingproof completion status [OPTIONS]
Options:
--help Show this message and exit.
plugins¶
Explicitly manage known plugins. Help/status never install packages.
Exit codes: 0 success; 1 absent/broken plugin, download or installation failure; 2 invalid command/options. Install never prompts or elevates privileges.
Usage:
livingproof plugins [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
install¶
Install verified official release artifacts and their exact common dependency.
Debian-owned root uses apt; virtual-environment root uses that Python's pip. Requires network access. An explicit version may upgrade or downgrade a plugin. Repeating an installed version lets the package manager reconcile dependencies. No automatic sudo, passwords, system pip override, or interactive prompt.
Usage:
livingproof plugins install [OPTIONS] {livingproof-capability-report}
Options:
--version TEXT Exact published version (optional v prefix); default: latest
stable.
--dry-run Download and verify the full plan without installing.
--help Show this message and exit.
status¶
Print the usable installed package version locally; exit 1 when absent/broken.
Usage:
livingproof plugins status [OPTIONS] {livingproof-capability-report}
Options:
--help Show this message and exit.
versions¶
List published tags and titles, including prereleases, newest API entries first.
Read-only; requires network. Installation defaults to GitHub's latest stable release. Pin a listed version explicitly to select an older release/prerelease.
Usage:
livingproof plugins versions [OPTIONS] {livingproof-capability-report}
Options:
--limit INTEGER RANGE Maximum releases; automatically traverse API pages.
[default: 20; x>=1]
--help Show this message and exit.