archivebox.cli.archivebox_tag

archivebox tag [args…] [–filters]

Manage Tag records.

Actions: create - Create Tags list - List Tags as JSONL (with optional filters) update - Update Tags from stdin JSONL delete - Delete Tags from stdin JSONL

Examples: # Create archivebox tag create news tech science archivebox tag create “important stuff”

# List
archivebox tag list
archivebox tag list --name__icontains=news

# Update (rename tags)
archivebox tag list --name=oldname | archivebox tag update --name=newname

# Delete
archivebox tag list --name=unused | archivebox tag delete --yes

Module Contents

Functions

create_tags	Create Tags from names.
list_tags	List Tags as JSONL with optional filters.
update_tags	Update Tags from stdin JSONL.
delete_tags	Delete Tags from stdin JSONL.
main	Manage Tag records.
create_cmd	Create Tags from names.
list_cmd	List Tags as JSONL.
update_cmd	Update Tags from stdin JSONL.
delete_cmd	Delete Tags from stdin JSONL.

Data

__command__

API

archivebox.cli.archivebox_tag.__command__

‘archivebox tag’

archivebox.cli.archivebox_tag.create_tags(names: collections.abc.Iterable[str]) → int

Create Tags from names.

Exit codes: 0: Success 1: Failure

archivebox.cli.archivebox_tag.list_tags(name: str | None = None, name__icontains: str | None = None, limit: int | None = None) → int

List Tags as JSONL with optional filters.

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

archivebox.cli.archivebox_tag.update_tags(name: str | None = None) → int

Update Tags from stdin JSONL.

Reads Tag 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_tag.delete_tags(yes: bool = False, dry_run: bool = False) → int

Delete Tags from stdin JSONL.

Requires –yes flag to confirm deletion.

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

archivebox.cli.archivebox_tag.main()

Manage Tag records.

archivebox.cli.archivebox_tag.create_cmd(names: tuple)

Create Tags from names.

archivebox.cli.archivebox_tag.list_cmd(name: str | None, name__icontains: str | None, limit: int | None)

List Tags as JSONL.

archivebox.cli.archivebox_tag.update_cmd(name: str | None)

Update Tags from stdin JSONL.

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

Delete Tags from stdin JSONL.