Installed terminal help¶
Installed image: ghcr.io/living-proof-labs/livingproof:0.0.0-amd64 (sha256:f8fda7cb26d4813364cf21c20fce0bcf229cece9899b09711af2a4fd0d3dfa8a).
$ livingproof --help
Usage: livingproof [OPTIONS] COMMAND [ARGS]...
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
Options:
--version Show this tool’s build identity and package version.
--help Show this message and exit.
Commands:
capability Work with capability evidence through installed plugins.
completion Show Bash setup/status and exact activation commands; no...
plugins Explicitly manage known plugins.
$ livingproof capability --help
Usage: livingproof capability [OPTIONS] COMMAND [ARGS]...
Work with capability evidence through installed plugins.
Options:
--help Show this message and exit.
Commands:
report Optional reporting plugin (install required)
$ livingproof plugins --help
Usage: livingproof plugins [OPTIONS] COMMAND [ARGS]...
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.
Options:
--help Show this message and exit.
Commands:
install Install verified official release artifacts and their exact...
status Print the usable installed package version locally; exit 1...
versions List published tags and titles, including prereleases, newest...
$ livingproof completion --help
Usage: livingproof completion [OPTIONS] COMMAND [ARGS]...
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
Options:
--help Show this message and exit.
Commands:
bash Print Bash code.
install Register for this user in the standard directory; never edit...
status Show installed registration files and explain...
Installed image: ghcr.io/living-proof-labs/livingproof:0.0.0-reporting-amd64 (sha256:03e04a23ffb02895179aa8e3d1f8e9d857bce991026893533e6cb798275a6ba6).
$ livingproof capability report --help
Usage: livingproof capability report [OPTIONS] COMMAND [ARGS]...
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.
Options:
--version Show release or development identity, package version and
provenance source.
--help Show this message and exit.
Commands:
grade Grade a bundle MANIFEST into a new JSON report (no...
human-template Create an insufficient assessment for a person to...
render Render saved decisions; never regrade or overwrite...
validate Validate a bundle MANIFEST and its evidence integrity...
$ livingproof capability report validate --help
Usage: livingproof capability report validate [OPTIONS] MANIFEST
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.
Options:
--help Show this message and exit.
$ livingproof capability report grade --help
Usage: livingproof capability report grade [OPTIONS] MANIFEST
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.
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.
$ livingproof capability report render --help
Usage: livingproof capability report render [OPTIONS] REPORT_FILE
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.
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.