summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2019-07-04 12:02:14 +0200
committerLars-Dominik Braun <lars@6xq.net>2019-07-04 12:02:14 +0200
commitec5e6a0aea7a2892f66ca1d196d83af521ca3955 (patch)
tree3489964340e346347a21793e282d9986ad68e7da /doc
parent123b370aa19e65864f1986e9f62cdeb511fa4fbd (diff)
downloadcrocoite-ec5e6a0aea7a2892f66ca1d196d83af521ca3955.tar.gz
crocoite-ec5e6a0aea7a2892f66ca1d196d83af521ca3955.tar.bz2
crocoite-ec5e6a0aea7a2892f66ca1d196d83af521ca3955.zip
Rename cli utils
crocoite-recursive is now just crocoite, crocoite-grab is not user-facing any more and called crocoite-single. In preparation for 1.0 release.
Diffstat (limited to 'doc')
-rw-r--r--doc/usage.rst23
1 files changed, 18 insertions, 5 deletions
diff --git a/doc/usage.rst b/doc/usage.rst
index 9049356..a3c2cc7 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -1,15 +1,28 @@
Usage
-----
-.. autofunction:: crocoite.cli.single
+One-shot command line interface and pywb_ playback:
-Recursion
-^^^^^^^^^
+.. code:: bash
-.. autofunction:: crocoite.cli.recursive
+ pip install pywb
+ crocoite http://example.com/ example.com.warc.gz
+ rm -rf collections && wb-manager init test && wb-manager add test example.com.warc.gz
+ wayback &
+ $BROWSER http://localhost:8080
+
+.. _pywb: https://github.com/ikreymer/pywb
IRC bot
^^^^^^^
-.. autofunction:: crocoite.cli.irc
+A simple IRC bot (“chromebot”) is provided with the command ``crocoite-irc``.
+It reads its configuration from a config file like the example provided in
+``contrib/chromebot.json`` and supports the following commands:
+a <url> -j <concurrency> -r <policy>
+ Archive <url> with <concurrency> processes according to recursion <policy>
+s <uuid>
+ Get job status for <uuid>
+r <uuid>
+ Revoke or abort running job with <uuid>