mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-28 16:50:01 +02:00
Code Issues Releases Wiki Activity

Updated Usage (markdown)

Nick Sweeting
2019-03-12 19:29:10 -04:00
parent 1aeac9da70
commit e97bd471e9
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Usage.md

@@ -1,9 +1,9 @@
▶️ *Make sure you have all the ArchiveBox [dependencies installed](https://github.com/pirate/ArchiveBox/wiki/Install) before running any of the commands below.*
# CLI Usage # CLI Usage
`./archive` refers to the executable shortcut in the root of the project, but you can also call ArchiveBox via `./bin/archivebox`. If you add `/path/to/ArchiveBox/bin` to your shell `$PATH` then you can call `archivebox` from anywhere on your system. `./archive` refers to the executable shortcut in the root of the project, but you can also call ArchiveBox via `./bin/archivebox`. If you add `/path/to/ArchiveBox/bin` to your shell `$PATH` then you can call `archivebox` from anywhere on your system.
Make sure to run `./setup` or follow the [[Install]] instructions before archiving anything.
If you're using Docker, the CLI interface is similar but needs to be prefixed by `docker-compose exec ...` or `docker run ...`, for examples see the [[Docker]] page. If you're using Docker, the CLI interface is similar but needs to be prefixed by `docker-compose exec ...` or `docker run ...`, for examples see the [[Docker]] page.
<div align="center"> <div align="center">