heritrix3.cli¶

heritrix3¶

CLI for the Heritrix API.

heritrix3 [OPTIONS] COMMAND [ARGS]...

Options

-h, --host <host>¶

Heritrix base URI

Default: https://localhost:8443/engine

-u, --username <username>¶

HTTP Digest Username

Default: admin

-p, --password <password>¶

HTTP Digest Password

Default: admin

--version¶: Show the version and exit.

info¶

Show information about all jobs or a single job. If given a jobname as argument then only display information about this job. Tries to use pygments to colorize the output.

heritrix3 info [OPTIONS] [JOBNAME]

Options

--raw¶: Output plain XML response.

Arguments

JOBNAME¶: Optional argument

list-jobs¶

List jobs, allow filtering for unbuilt ones.

heritrix3 list-jobs [OPTIONS]

Options

--unbuilt¶

--sorted¶

list-jobs-actions¶

List jobs and available heritrix actions.

heritrix3 list-jobs-actions [OPTIONS]

Options

--sorted¶

shell¶

Open an interactive shell for testing.

heritrix3 shell [OPTIONS]