The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-14 11:06:13 +05:00
Code Issues Actions Packages Projects Releases Wiki Activity
pirate-patch-1
ArchiveBox/docs/apidocs/archivebox/archivebox.cli.md
Nick Sweeting f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Details
Build Debian package / build (amd64) (push) Waiting to run
Details
Build Debian package / build (arm64) (push) Waiting to run
Details
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Details
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Details
Build Debian package / release (push) Blocked by required conditions
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Details
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Details
Run linters / lint (push) Waiting to run
Details
Build Pip package / build (push) Waiting to run
Details
Release State / release-state (push) Waiting to run
Details
Parallel Tests / Discover test files (push) Waiting to run
Details
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Details
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Details
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Details
Run tests / docker_tests (push) Waiting to run
Details
docs: regenerate sphinx apidocs to reflect current source tree 
Clean rebuild of docs/apidocs/archivebox/ via autodoc2:
- Removes 19 stale module pages whose source files no longer exist
  (cli_utils, host_utils, schedule_utils — renamed to *_util; actors,
  ideas, debugging, folders, legacy, progress_layout, tests_piping,
  config_tags, personas.runtime/views, orchestrator*, worker, tasks).
- Adds 29 new module pages for code that was added since the previous
  generation but not yet documented.
- Updates 100 existing pages to reflect API surface changes (e.g.
  ENABLED_PLUGINS Field removed, SNAPSHOTS_PER_PAGE clamp removed,
  default bumped to 50, etc.).

156 source modules <-> 156 apidoc files (zero drift). Build clean
under sphinx-build -W --keep-going.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-31 03:40:25 -07:00

5.5 KiB
Raw Permalink Blame History

{py:mod}archivebox.cli

:allowtitles:

Submodules

:titlesonly:
:maxdepth: 1

archivebox.cli.archivebox_shell
archivebox.cli.archivebox_schedule
archivebox.cli.archivebox_list
archivebox.cli.archivebox_archiveresult
archivebox.cli.archivebox_process
archivebox.cli.archivebox_tag
archivebox.cli.archivebox_config
archivebox.cli.archivebox_server
archivebox.cli.archivebox_binary
archivebox.cli.archivebox_snapshot
archivebox.cli.archivebox_pluginmap
archivebox.cli.archivebox_crawl_compat
archivebox.cli.archivebox_machine
archivebox.cli.archivebox_update
archivebox.cli.archivebox_extract
archivebox.cli.archivebox_crawl
archivebox.cli.archivebox_remove
archivebox.cli.archivebox_install
archivebox.cli.archivebox_mcp
archivebox.cli.archivebox_search
archivebox.cli.archivebox_version
archivebox.cli.archivebox_persona
archivebox.cli.archivebox_snapshot_compat
archivebox.cli.archivebox_add
archivebox.cli.archivebox_status
archivebox.cli.cli_util
archivebox.cli.archivebox_run
archivebox.cli.archivebox_init
archivebox.cli.archivebox_help
archivebox.cli.archivebox_manage

Package Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`ArchiveBoxGroup <archivebox.cli.ArchiveBoxGroup>`
  - ```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup
    :summary:
    ```

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`cli <archivebox.cli.cli>`
  - ```{autodoc2-docstring} archivebox.cli.cli
    :summary:
    ```
* - {py:obj}`main <archivebox.cli.main>`
  - ```{autodoc2-docstring} archivebox.cli.main
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`__command__ <archivebox.cli.__command__>`
  - ```{autodoc2-docstring} archivebox.cli.__command__
    :summary:
    ```
* - {py:obj}`STDERR <archivebox.cli.STDERR>`
  - ```{autodoc2-docstring} archivebox.cli.STDERR
    :summary:
    ```

API

:canonical: archivebox.cli.__command__
:value: >
   'archivebox'

```{autodoc2-docstring} archivebox.cli.__command__
```


:canonical: archivebox.cli.STDERR
:value: >
   'Console(...)'

```{autodoc2-docstring} archivebox.cli.STDERR
```


:canonical: archivebox.cli.ArchiveBoxGroup

Bases: {py:obj}`rich_click.Group`

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.__init__
```

````{py:attribute} meta_commands
:canonical: archivebox.cli.ArchiveBoxGroup.meta_commands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.meta_commands
```

````

````{py:attribute} setup_commands
:canonical: archivebox.cli.ArchiveBoxGroup.setup_commands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.setup_commands
```

````

````{py:attribute} model_commands
:canonical: archivebox.cli.ArchiveBoxGroup.model_commands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.model_commands
```

````

````{py:attribute} archive_commands
:canonical: archivebox.cli.ArchiveBoxGroup.archive_commands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.archive_commands
```

````

````{py:attribute} legacy_model_commands
:canonical: archivebox.cli.ArchiveBoxGroup.legacy_model_commands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.legacy_model_commands
```

````

````{py:attribute} all_subcommands
:canonical: archivebox.cli.ArchiveBoxGroup.all_subcommands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.all_subcommands
```

````

````{py:attribute} renamed_commands
:canonical: archivebox.cli.ArchiveBoxGroup.renamed_commands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.renamed_commands
```

````

````{py:attribute} legacy_model_subcommands
:canonical: archivebox.cli.ArchiveBoxGroup.legacy_model_subcommands
:value: >
   None

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.legacy_model_subcommands
```

````

````{py:method} get_canonical_name(cmd_name)
:canonical: archivebox.cli.ArchiveBoxGroup.get_canonical_name
:classmethod:

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup.get_canonical_name
```

````

````{py:method} _should_use_legacy_model_command(cmd_name: str) -> bool
:canonical: archivebox.cli.ArchiveBoxGroup._should_use_legacy_model_command
:classmethod:

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup._should_use_legacy_model_command
```

````

````{py:method} get_command(ctx, cmd_name)
:canonical: archivebox.cli.ArchiveBoxGroup.get_command

````

````{py:method} _lazy_load(cmd_name_or_path)
:canonical: archivebox.cli.ArchiveBoxGroup._lazy_load
:classmethod:

```{autodoc2-docstring} archivebox.cli.ArchiveBoxGroup._lazy_load
```

````


:canonical: archivebox.cli.cli

```{autodoc2-docstring} archivebox.cli.cli
```

:canonical: archivebox.cli.main

```{autodoc2-docstring} archivebox.cli.main
```