CLI reference¶
Auto-generated from the live Typer app at kuroi.cli:app. Every option
and subcommand below comes straight from the source — if it doesn't match
kuroi --help, file a bug.
kuroi¶
Usage: kuroi [OPTIONS] COMMAND [ARGS]...
Strip sensitive data from PDFs with LLM assistance.
Options:
-v, --verbose Show more detail (use -vv for debug). [default: 0]
-q, --quiet Show less.
--version Print version and exit.
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or customize
the installation.
--help Show this message and exit.
Commands:
doctor Check that everything is working.
verify Check an already-redacted PDF for leaks.
run Redact a PDF.
undo Restore the most recent backup.
setup Interactively configure kuroi.
diff Show what changed between original and redacted.
models List available LLM providers and models.
config Configuration management.
backups Manage backups.
kuroi doctor¶
Usage: kuroi doctor [OPTIONS]
Check that everything is working.
Options:
--help Show this message and exit.
kuroi verify¶
Usage: kuroi verify [OPTIONS] PDF
Check an already-redacted PDF for leaks.
Arguments:
PDF [required]
Options:
--help Show this message and exit.
kuroi run¶
Usage: kuroi run [OPTIONS] PDF
Redact a PDF.
Arguments:
PDF [required]
Options:
-o, --output PATH
--in-place Write to the input path; backup is taken.
--overwrite Replace an existing output file.
--rules TEXT Comma-separated rule set names.
-i, --instruct TEXT Natural-language redaction instruction.
-y Skip the apply confirmation.
--backup-dir PATH Backup directory [default:
$XDG_DATA_HOME/kuroi/backups].
--no-backup Skip backup creation. With --in-place the original is
unrecoverable.
--audit-dir PATH Audit log directory [default:
$XDG_DATA_HOME/kuroi/audit].
--provider TEXT LLM provider: 'anthropic', 'ollama', or 'claude-cli'.
Overrides env and config.
--model TEXT Model ID. Overrides env and config.
--ollama-url TEXT Base URL of the Ollama daemon. Overrides env and
config.
--claude-cli-path TEXT Path to the local `claude` binary for the claude-cli
provider. Defaults to the binary bundled with claude-
agent-sdk.
--claude-cli-timeout INTEGER RANGE
Per-call timeout in seconds for the claude-cli
provider. Default 300. [x>=1]
--seed INTEGER Reproducibility seed. Best-effort per provider;
recorded in audit.
--max-retries INTEGER RANGE Number of retries after the initial attempt. 0
disables retry. Overrides env and config. [x>=0]
--retry-backoff FLOAT RANGE Seconds before the first retry. Overrides env and
config. [x>=0.0]
--retry-backoff-multiplier FLOAT RANGE
Each retry waits M x the previous delay. Must be >=
1.0. Overrides env and config. [x>=1.0]
--pages-per-batch INTEGER RANGE
Split LLM analysis into batches of N pages. 0
(default) keeps the current single-call behavior.
[default: 0; x>=0]
--pages TEXT Process only the listed pages. Comma-separated list of
page numbers and/or inclusive ranges (e.g. `1`,
`1,2,14`, `1-5`, `1,3-5,10`). Default: all pages.
--layout-aware / --no-layout-aware
Wrap the LLM prompt with PyMuPDF block tags so the
model can see paragraph and other layout boundaries.
Default: off (or set [prompt] layout_aware in config).
--help Show this message and exit.
kuroi undo¶
Usage: kuroi undo [OPTIONS] [INPUT]
Restore the most recent backup.
Arguments:
[INPUT] PDF whose backup should be restored. Default: most recent backup overall.
Options:
-y Skip the restore confirmation.
--backup-dir PATH Backup directory [default: $XDG_DATA_HOME/kuroi/backups].
--audit-dir PATH Audit directory [default: $XDG_DATA_HOME/kuroi/audit].
--session TEXT Exact backup-session timestamp to undo.
--pages TEXT Restrict undo to a page range (same syntax as `kuroi run --pages`).
--page INTEGER Single page filter.
--kind TEXT Finding kind filter.
--words TEXT Word range filter START-END (requires --page).
--dry-run Print plan, write nothing.
--help Show this message and exit.
kuroi setup¶
Usage: kuroi setup [OPTIONS]
Interactively configure kuroi.
Options:
--help Show this message and exit.
kuroi diff¶
Usage: kuroi diff [OPTIONS] ORIGINAL REDACTED
Show what changed between original and redacted.
Arguments:
ORIGINAL [required]
REDACTED [required]
Options:
--format [text|html|json] Output format. [default: text]
-o, --output PATH
--help Show this message and exit.
kuroi models¶
Usage: kuroi models [OPTIONS] [PROVIDER]
List available LLM providers and models.
Arguments:
[PROVIDER] Filter to one provider.
Options:
--json Machine-readable output.
--help Show this message and exit.
kuroi config¶
Usage: kuroi config [OPTIONS] COMMAND [ARGS]...
Configuration management.
Options:
--help Show this message and exit.
Commands:
refresh-pricing Replace the user's pricing.json with the contents of `--from`.