1
0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-29 17:19:53 +02:00

Updated Usage (markdown)

Nick Sweeting
2019-03-12 19:32:25 -04:00
parent df68f8d1ab
commit e48f71b0a1

@@ -1,6 +1,12 @@
▶️ *Make sure you have ArchiveBox [fully installed](https://github.com/pirate/ArchiveBox/wiki/Install) before running any of the commands below.*
# CLI Usage
- [CLI Usage](#CLI-Usage)
- [UI Usage](#UI-Usage)
- [Usage in Docker](https://github.com/pirate/ArchiveBox/wiki/Docker)
- [More](#More)
## 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.
@@ -10,7 +16,7 @@ If you're using Docker, the CLI interface is similar but needs to be prefixed by
<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.
```bash
@@ -19,7 +25,7 @@ env FETCH_MEDIA=True MEDIA_TIMEOUT=500 ./archive ...
See [[Configuration]] page for more details about the available options and ways to pass config.
If you're using Docker, also make sure to read the Configuration section on the [[Docker]] page.
## Import a single URL or list of URLs via stdin
### Import a single URL or list of URLs via stdin
```bash
echo 'https://example.com' | ./archive
# or
@@ -27,7 +33,7 @@ cat urls_to_archive.txt | ./archive
```
You can also pipe in RSS, XML, Netscape, or any of the other supported import formats via stdin.
## Import list of links exported from browser or another service
### Import list of links exported from browser or another service
```bash
./archive ~/Downloads/browser_bookmarks_export.html
@@ -39,7 +45,7 @@ You can also pipe in RSS, XML, Netscape, or any of the other supported import fo
Passing a file as an argument here does not archive the file, it parses it as a list of URLs and archives the links *inside of it*, so only use it for *lists of links* to archive, not HTML files or other content you want added directy to the archive.
## Import list of URLs from a remote RSS feed or file
### Import list of URLs from a remote RSS feed or file
ArchiveBox will download the URL to a local file in `output/sources/` and attempt to autodetect the format and import any URLs found. Currently, Netscape HTML, JSON, RSS, and plain text links lists are supported.
```bash
@@ -50,7 +56,7 @@ ArchiveBox will download the URL to a local file in `output/sources/` and attemp
Passing a URL as an argument here does not archive the specified URL, it downloads it and archives the links *inside* of it, so only use it for RSS feeds or other *lists of links* you want to add. To add an individual link use the instruction above and pass the URL via stdin instead of as an argument.
## Import list of links from browser history
### Import list of links from browser history
```bash
./bin/archivebox-export-browser-history --chrome
./archive output/sources/chrome_history.json
@@ -59,7 +65,7 @@ Passing a URL as an argument here does not archive the specified URL, it downloa
./archive output/sources/firefox_history.json
```
# UI Usage
### UI Usage
To access your archive, open `output/index.html` in a browser. You should see something [like this](https://archive.sweeting.me).
@@ -70,11 +76,11 @@ Click the Favicon under the "Files" column to go to the details page for each li
<img src="https://i.imgur.com/52RjhUM.png" width="45%">
<img src="https://i.imgur.com/Gg9sTyq.png" width="45%">
# More
## More
- Read [[Docker]] to learn about ArchiveBox usage with Docker and Docker Compose
- Read [[Configuration]] to learn about the various archive method options
- Read [[Scheduled Archiving]] to learn how to set up automatic daily archiving
- Read [[Publishing Your Archive]] if you want to host your archive for others to access online
- Read [[Troubleshooting]] if you encounter any problems
- Read [[Troubleshooting]] if you encounter any problems
- View [Screenshots](https://github.com/pirate/ArchiveBox#Screenshots) of the CLI and outputted HTML