mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-09-01 18:32:40 +02:00
Code Issues Releases Wiki Activity

Updated Usage (markdown)

Nick Sweeting
2019-03-12 19:40:42 -04:00
parent 70e57091b0
commit beff5053a7
1 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Usage.md

@@ -15,14 +15,12 @@
## CLI Usage ## CLI Usage
<img src="https://i.imgur.com/biVfFYr.png" width="40%" align="right">
`./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.
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">
<img src="https://i.imgur.com/biVfFYr.png" width="50%"><br/>
</div>
### Run ArchiveBox with configuration options ### Run ArchiveBox with configuration options
You can set environment variables in your shell profile, a config file, or by using the `env` command. You can set environment variables in your shell profile, a config file, or by using the `env` command.