mirror of
https://github.com/ArchiveBox/ArchiveBox.git
synced 2026-09-14 11:06:13 +05:00
f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Build Debian package / build (amd64) (push) Waiting to run
Build Debian package / build (arm64) (push) Waiting to run
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Build Debian package / release (push) Blocked by required conditions
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Run linters / lint (push) Waiting to run
Build Pip package / build (push) Waiting to run
Release State / release-state (push) Waiting to run
Parallel Tests / Discover test files (push) Waiting to run
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Run tests / docker_tests (push) Waiting to run
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>
142 lines
4.1 KiB
Markdown
142 lines
4.1 KiB
Markdown
# {py:mod}`archivebox.cli.archivebox_binary`
|
|
|
|
```{py:module} archivebox.cli.archivebox_binary
|
|
```
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary
|
|
:allowtitles:
|
|
```
|
|
|
|
## Module Contents
|
|
|
|
### Functions
|
|
|
|
````{list-table}
|
|
:class: autosummary longtable
|
|
:align: left
|
|
|
|
* - {py:obj}`create_binary <archivebox.cli.archivebox_binary.create_binary>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.create_binary
|
|
:summary:
|
|
```
|
|
* - {py:obj}`list_binaries <archivebox.cli.archivebox_binary.list_binaries>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.list_binaries
|
|
:summary:
|
|
```
|
|
* - {py:obj}`update_binaries <archivebox.cli.archivebox_binary.update_binaries>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.update_binaries
|
|
:summary:
|
|
```
|
|
* - {py:obj}`delete_binaries <archivebox.cli.archivebox_binary.delete_binaries>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.delete_binaries
|
|
:summary:
|
|
```
|
|
* - {py:obj}`main <archivebox.cli.archivebox_binary.main>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.main
|
|
:summary:
|
|
```
|
|
* - {py:obj}`create_cmd <archivebox.cli.archivebox_binary.create_cmd>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.create_cmd
|
|
:summary:
|
|
```
|
|
* - {py:obj}`list_cmd <archivebox.cli.archivebox_binary.list_cmd>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.list_cmd
|
|
:summary:
|
|
```
|
|
* - {py:obj}`update_cmd <archivebox.cli.archivebox_binary.update_cmd>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.update_cmd
|
|
:summary:
|
|
```
|
|
* - {py:obj}`delete_cmd <archivebox.cli.archivebox_binary.delete_cmd>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.delete_cmd
|
|
:summary:
|
|
```
|
|
````
|
|
|
|
### Data
|
|
|
|
````{list-table}
|
|
:class: autosummary longtable
|
|
:align: left
|
|
|
|
* - {py:obj}`__command__ <archivebox.cli.archivebox_binary.__command__>`
|
|
- ```{autodoc2-docstring} archivebox.cli.archivebox_binary.__command__
|
|
:summary:
|
|
```
|
|
````
|
|
|
|
### API
|
|
|
|
````{py:data} __command__
|
|
:canonical: archivebox.cli.archivebox_binary.__command__
|
|
:value: >
|
|
'archivebox binary'
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.__command__
|
|
```
|
|
|
|
````
|
|
|
|
````{py:function} create_binary(name: str, abspath: str, version: str = '') -> int
|
|
:canonical: archivebox.cli.archivebox_binary.create_binary
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.create_binary
|
|
```
|
|
````
|
|
|
|
````{py:function} list_binaries(name: str | None = None, abspath__icontains: str | None = None, version__icontains: str | None = None, limit: int | None = None) -> int
|
|
:canonical: archivebox.cli.archivebox_binary.list_binaries
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.list_binaries
|
|
```
|
|
````
|
|
|
|
````{py:function} update_binaries(version: str | None = None, abspath: str | None = None) -> int
|
|
:canonical: archivebox.cli.archivebox_binary.update_binaries
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.update_binaries
|
|
```
|
|
````
|
|
|
|
````{py:function} delete_binaries(yes: bool = False, dry_run: bool = False) -> int
|
|
:canonical: archivebox.cli.archivebox_binary.delete_binaries
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.delete_binaries
|
|
```
|
|
````
|
|
|
|
````{py:function} main()
|
|
:canonical: archivebox.cli.archivebox_binary.main
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.main
|
|
```
|
|
````
|
|
|
|
````{py:function} create_cmd(name: str, abspath: str, version: str)
|
|
:canonical: archivebox.cli.archivebox_binary.create_cmd
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.create_cmd
|
|
```
|
|
````
|
|
|
|
````{py:function} list_cmd(name: str | None, abspath__icontains: str | None, version__icontains: str | None, limit: int | None)
|
|
:canonical: archivebox.cli.archivebox_binary.list_cmd
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.list_cmd
|
|
```
|
|
````
|
|
|
|
````{py:function} update_cmd(version: str | None, abspath: str | None)
|
|
:canonical: archivebox.cli.archivebox_binary.update_cmd
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.update_cmd
|
|
```
|
|
````
|
|
|
|
````{py:function} delete_cmd(yes: bool, dry_run: bool)
|
|
:canonical: archivebox.cli.archivebox_binary.delete_cmd
|
|
|
|
```{autodoc2-docstring} archivebox.cli.archivebox_binary.delete_cmd
|
|
```
|
|
````
|