archivebox.cli package

Submodules

archivebox.cli.archivebox_add module

archivebox.cli.archivebox_add.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Add a new URL or list of URLs to your archive

archivebox.cli.archivebox_config module

archivebox.cli.archivebox_config.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Get and set your ArchiveBox project configuration values

archivebox.cli.archivebox_help module

archivebox.cli.archivebox_help.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Print the ArchiveBox help message and usage

archivebox.cli.archivebox_status module

archivebox.cli.archivebox_status.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Print out some info and statistics about the archive collection

archivebox.cli.archivebox_init module

archivebox.cli.archivebox_init.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Initialize a new ArchiveBox collection in the current directory

archivebox.cli.archivebox_list module

archivebox.cli.archivebox_list.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

List, filter, and export information about archive entries

archivebox.cli.archivebox_manage module

archivebox.cli.archivebox_manage.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Run an ArchiveBox Django management command

archivebox.cli.archivebox_remove module

archivebox.cli.archivebox_remove.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Remove the specified URLs from the archive

archivebox.cli.archivebox_schedule module

archivebox.cli.archivebox_schedule.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Set ArchiveBox to regularly import URLs at specific times using cron

archivebox.cli.archivebox_server module

archivebox.cli.archivebox_server.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Run the ArchiveBox HTTP server

archivebox.cli.archivebox_shell module

archivebox.cli.archivebox_shell.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Enter an interactive ArchiveBox Django shell

archivebox.cli.archivebox_update module

archivebox.cli.archivebox_update.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Import any new links from subscriptions and retry any previously failed/skipped links

archivebox.cli.archivebox_version module

archivebox.cli.archivebox_version.main(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None[source]

Print the ArchiveBox version and dependency information

Module contents

archivebox.cli.list_subcommands() Dict[str, str][source]

find and import all valid archivebox_<subcommand>.py files in CLI_DIR

archivebox.cli.run_subcommand(subcommand: str, subcommand_args: List[str] = None, stdin: IO | None = None, pwd: Path | str | None = None) None[source]

Run a given ArchiveBox subcommand with the given list of args

archivebox.cli.help(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Print the ArchiveBox help message and usage

archivebox.cli.version(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Print the ArchiveBox version and dependency information

archivebox.cli.init(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Initialize a new ArchiveBox collection in the current directory

archivebox.cli.config(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Get and set your ArchiveBox project configuration values

archivebox.cli.setup(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Automatically install all ArchiveBox dependencies and extras

archivebox.cli.add(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Add a new URL or list of URLs to your archive

archivebox.cli.remove(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Remove the specified URLs from the archive

archivebox.cli.update(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Import any new links from subscriptions and retry any previously failed/skipped links

archivebox.cli.list(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

List, filter, and export information about archive entries

archivebox.cli.status(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Print out some info and statistics about the archive collection

archivebox.cli.shell(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Enter an interactive ArchiveBox Django shell

archivebox.cli.server(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Run the ArchiveBox HTTP server

archivebox.cli.manage(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Run an ArchiveBox Django management command

archivebox.cli.oneshot(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Create a single URL archive folder with an index.json and index.html, and all the archive method outputs. You can run this to archive single pages without needing to create a whole collection with archivebox init.

archivebox.cli.schedule(args: List[str] | None = None, stdin: IO | None = None, pwd: str | None = None) None

Set ArchiveBox to regularly import URLs at specific times using cron