From 97c113d753c07e72cb9c64162995c9dad2327ee9 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 2 Feb 2021 11:48:56 -0500 Subject: [PATCH] add export example to output formats --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 600026b3..9b88d1ab 100644 --- a/README.md +++ b/README.md @@ -325,6 +325,14 @@ All of ArchiveBox's state (including the index, snapshot data, and config file) The on-disk layout is optimized to be easy to browse by hand and durable long-term. The main index is a standard sqlite3 database (it can also be exported as static JSON/HTML), and the archive snapshots are organized by date-added timestamp in the `archive/` subfolder. Each snapshot subfolder includes a static JSON and HTML index describing its contents, and the snapshot extrator outputs are plain files within the folder (e.g. `media/example.mp4`, `git/somerepo.git`, `static/someimage.png`, etc.) ```bash +# to browse your index statically without running the archivebox server, run: +archivebox list --html --with-headers > index.html +archivebox list --json --with-headers > index.json + +# then open the static index in a browser +open index.html + +# or browse the snapshots via filesystem directly ls ./archive// ```