archivebox.cli packageο
Submodulesο
archivebox.cli.archivebox_add moduleο
archivebox.cli.archivebox_config moduleο
archivebox.cli.archivebox_help moduleο
archivebox.cli.archivebox_status moduleο
archivebox.cli.archivebox_init moduleο
archivebox.cli.archivebox_list moduleο
archivebox.cli.archivebox_manage moduleο
archivebox.cli.archivebox_remove moduleο
archivebox.cli.archivebox_schedule moduleο
archivebox.cli.archivebox_server moduleο
archivebox.cli.archivebox_shell moduleο
archivebox.cli.archivebox_update moduleο
archivebox.cli.archivebox_version moduleο
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