archivebox.cli.archivebox_archiveresult

archivebox archiveresult [args…] [–filters]

Manage ArchiveResult records (plugin extraction results).

Actions: create - Create ArchiveResults for Snapshots (queue extractions) list - List ArchiveResults as JSONL (with optional filters) update - Update ArchiveResults from stdin JSONL delete - Delete ArchiveResults from stdin JSONL

Examples: # Create ArchiveResults for snapshots (queue for extraction) archivebox snapshot list –status=queued | archivebox archiveresult create archivebox archiveresult create –plugin=screenshot –snapshot-id=

# List with filters
archivebox archiveresult list --status=failed
archivebox archiveresult list --plugin=screenshot --status=succeeded

# Update (reset failed extractions to queued)
archivebox archiveresult list --status=failed | archivebox archiveresult update --status=queued

# Delete
archivebox archiveresult list --plugin=singlefile | archivebox archiveresult delete --yes

# Re-run failed extractions
archivebox archiveresult list --status=failed | archivebox run

Module Contents

Functions

build_archiveresult_request
create_archiveresults	Create ArchiveResult request records for Snapshots.
list_archiveresults	List ArchiveResults as JSONL with optional filters.
update_archiveresults	Update ArchiveResults from stdin JSONL.
delete_archiveresults	Delete ArchiveResults from stdin JSONL.
main	Manage ArchiveResult records (plugin extraction results).
create_cmd	Create ArchiveResults for Snapshots from stdin JSONL.
list_cmd	List ArchiveResults as JSONL.
update_cmd	Update ArchiveResults from stdin JSONL.
delete_cmd	Delete ArchiveResults from stdin JSONL.

Data

__command__

API

archivebox.cli.archivebox_archiveresult.__command__

‘archivebox archiveresult’

archivebox.cli.archivebox_archiveresult.build_archiveresult_request(snapshot_id: str, plugin: str, hook_name: str = '', status: str = 'queued') → dict

archivebox.cli.archivebox_archiveresult.create_archiveresults(snapshot_id: str | None = None, plugin: str | None = None, status: str = 'queued') → int

Create ArchiveResult request records for Snapshots.

Reads Snapshot records from stdin and emits ArchiveResult request JSONL. Pass-through: Non-Snapshot/ArchiveResult records are output unchanged. If –plugin is specified, only emits requests for that plugin. Otherwise, emits requests for all enabled snapshot hooks.

Exit codes: 0: Success 1: Failure

archivebox.cli.archivebox_archiveresult.list_archiveresults(status: str | None = None, plugin: str | None = None, snapshot_id: str | None = None, limit: int | None = None) → int

List ArchiveResults as JSONL with optional filters.

Exit codes: 0: Success (even if no results)

archivebox.cli.archivebox_archiveresult.update_archiveresults(status: str | None = None) → int

Update ArchiveResults from stdin JSONL.

Reads ArchiveResult records from stdin and applies updates. Uses PATCH semantics - only specified fields are updated.

Exit codes: 0: Success 1: No input or error

archivebox.cli.archivebox_archiveresult.delete_archiveresults(yes: bool = False, dry_run: bool = False) → int

Delete ArchiveResults from stdin JSONL.

Requires –yes flag to confirm deletion.

Exit codes: 0: Success 1: No input or missing –yes flag

archivebox.cli.archivebox_archiveresult.main()

Manage ArchiveResult records (plugin extraction results).

archivebox.cli.archivebox_archiveresult.create_cmd(snapshot_id: str | None, plugin: str | None, status: str)

Create ArchiveResults for Snapshots from stdin JSONL.

archivebox.cli.archivebox_archiveresult.list_cmd(status: str | None, plugin: str | None, snapshot_id: str | None, limit: int | None)

List ArchiveResults as JSONL.

archivebox.cli.archivebox_archiveresult.update_cmd(status: str | None)

Update ArchiveResults from stdin JSONL.

archivebox.cli.archivebox_archiveresult.delete_cmd(yes: bool, dry_run: bool)

Delete ArchiveResults from stdin JSONL.