CLI reference

The full command surface in one place.

The site reference mirrors the current CLI help text and repo documentation, with a little extra context around report formats and generated output.

Syntax

argiope <command> <url> [options]
argiope library [dir]

Most workflows start from a URL with `check` or `images`. The `library` command operates on a local directory instead.

Commands

`check <url>`

Crawl a website and report broken links.

`images <url>`

Download images and generate an HTML browser for the output tree.

`library [dir]`

Generate or regenerate the HTML browser for an existing directory.

Options

`--depth N`

Maximum crawl depth. Default: `3`.

`--timeout N`

Request timeout in seconds. Default: `10`.

`--delay N`

Delay between requests in milliseconds. Default: `100`.

`-o`, `--output DIR`

Output directory for downloads. Default: `./download`.

`--chapters N-M`

Chapter range to download for MangaFox input URLs.

`--verbose`

Print each URL as it is checked or discovered.

`--parallel`

Crawl URLs concurrently for better throughput.

`--report <file>`

Write a report to the given path instead of standard output.

`--report-format <fmt>`

Choose `text`, `markdown`, or `html`. Default: `text`.

`--include-positives`

Include successful links in report output.

`-h`, `--help`

Show help text.

`-v`, `--version`

Show the current CLI version.

Report formats

Text

Indented text output for logs and terminal-oriented review.

Markdown

GitHub-friendly summary output for PR comments and wiki pages.

HTML

Self-contained report with inline CSS and visual status treatment.

Report mode behavior: when `--report` is set, argiope suppresses normal console output so the file becomes the primary deliverable.

Examples

argiope check https://example.com
argiope check https://example.com --depth 5 --timeout 15
argiope check https://example.com --report report.md --report-format markdown
argiope check https://example.com --report report.html --report-format html --include-positives
argiope images https://example.com/gallery -o ./images
argiope images https://fanfox.net/manga/naruto --chapters 1-10 -o ./manga
argiope library ./manga