Command line

pydebuprep [COMMAND] [OPTIONS]
pydebuprep --version | --help

Without a command, report runs: pydebuprep --format html is pydebuprep report --format html. Commands are only recognised as the first word. pydebuprep COMMAND --help prints a command's options.

The tables below are generated from the program's own argument parser.

report

Run all checks and print a report (default).

pydebuprep report [-h] [--format {text,json,yaml,html,markdown,jira,confluence}] [--output-dir DIR | --output FILE] [--baseline FILE | --no-baseline] [--snapshot-dir DIR] [--checks ID,...] [--skip ID,...] [--min-severity {info,warning,critical}] [--no-color] [--todo | --no-todo] [--check-option CHECK.OPTION=VALUE] [--config FILE | --no-config]

Argument	Description
--format, -f {text,json,yaml,html,markdown,jira,confluence}	output format (default: text)
--output-dir DIR	write the report to a timestamped file in DIR instead of stdout
--output, -o FILE	write the report to FILE (a timestamp is added if FILE exists); '-' means standard output, overriding a configured output_dir
--baseline FILE	compare against this snapshot
--no-baseline	do not compare against any snapshot
--snapshot-dir DIR	where to look for the newest snapshot (default: /var/lib/pydebuprep/snapshots)
--checks ID,...	run only these checks
--skip ID,...	do not run these checks
--min-severity {info,warning,critical}	hide findings below this severity (default: info; exit code still counts them)
--no-color	never colorize text output
--todo, --no-todo	add a TODO checklist of what needs fixing at the end of the report
--check-option CHECK.OPTION=VALUE	set a check option, overriding the config file (repeatable)
--config, -c FILE	read settings from FILE (default: /etc/pydebuprep.conf if it exists)
--no-config	ignore any config file

convert

Render a saved json or yaml report in another format.

pydebuprep convert [-h] [--format {text,json,yaml,html,markdown,jira,confluence}] [--output-dir DIR | --output FILE] [--no-color] [--todo | --no-todo] FILE

Argument	Description
FILE	a report written with --format json or --format yaml; '-' reads standard input
--format, -f {text,json,yaml,html,markdown,jira,confluence}	output format (default: text)
--output-dir DIR	write the report to a timestamped file in DIR instead of stdout
--output, -o FILE	write the report to FILE (a timestamp is added if FILE exists); '-' means standard output, overriding a configured output_dir
--no-color	never colorize text output
--todo, --no-todo	add a TODO checklist of what needs fixing at the end of the report

snapshot

Record a pre-upgrade baseline.

pydebuprep snapshot [-h] [--snapshot-dir DIR] [--check-option CHECK.OPTION=VALUE] [--config FILE | --no-config]

Argument	Description
--snapshot-dir DIR	where to store the snapshot (default: /var/lib/pydebuprep/snapshots)
--check-option CHECK.OPTION=VALUE	set a check option, overriding the config file (repeatable)
--config, -c FILE	read settings from FILE (default: /etc/pydebuprep.conf if it exists)
--no-config	ignore any config file

list-checks

List available checks.

pydebuprep list-checks [-h] [--verbose]

Argument	Description
--verbose, -v	also show each check's options

configtest

Validate the config file and exit.

pydebuprep configtest [-h] [--config FILE | --no-config]

Argument	Description
--config, -c FILE	read settings from FILE (default: /etc/pydebuprep.conf if it exists)
--no-config	ignore any config file

example-config

Print an example config file with all defaults.

pydebuprep example-config [-h]

completion

Print a shell completion script.

pydebuprep completion [-h] {bash,zsh}

Argument	Description
shell (bash, zsh)	shell to generate for