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

Updated Usage (markdown)

Nick Sweeting
2019-01-23 02:57:21 -05:00
parent 8c5e7a4ae9
commit b203e2dbff
1 changed files with 15 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
Usage.md

@@ -22,7 +22,7 @@ cat urls_to_archive.txt | ./archive
./archive ~/Downloads/other_links.txt ./archive ~/Downloads/other_links.txt
``` ```
## Archive URLs from a remote RSS feed or file ## Import 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. 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 ```bash
@@ -31,6 +31,15 @@ ArchiveBox will download the URL to a local file in `output/sources/` and attemp
./archive https://example.com/links.txt ./archive https://example.com/links.txt
``` ```
## Import links from browser history
```bash
./bin/archivebox-export-browser-history --chrome
./archive output/sources/chrome_history.json
# or
./bin/archivebox-export-browser-history --firefox
./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). To access your archive, open `output/index.html` in a browser. You should see something [like this](https://archive.sweeting.me).
@@ -39,32 +48,10 @@ You can sort by column, search using the box in the upper right, and see the tot
Click the Favicon under the "Files" column to go to the details page for each link. Click the Favicon under the "Files" column to go to the details page for each link.
---
*Some alternatives that also work:* # More
Add a list of links from remote URL:
```bash
./archive "https://getpocket.com/users/yourusername/feed/all" # url to an RSS, html, or json links file
```
Add a single URL or list of URLs to archive via stdin:
```bash
cat ./urls_to_archive.txt | ./archive
# or
echo 'https://example.com' | ./archive
```
Add all the links from your browser history:
```bash
./bin/archivebox-export-browser-history --chrome # works with --firefox as well, can take path to SQLite history db
./archive output/sources/chrome_history.json
```
Or update the archive without adding new links:
```bash
./archive
```
---
- 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