aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.org>2024-07-01 05:05:26 +0300
committerkaotisk <kaotisk@arching-kaos.org>2024-07-01 05:05:26 +0300
commit98af59585b378fddfb135a28ca499fa23df8d0ac (patch)
treecb2d96527efbafa9a2d655878c3ccd4b313c1108 /README
parentde53c55383ed07e0b65f69d33f5284a31d791664 (diff)
downloadarching-kaos-tools-98af59585b378fddfb135a28ca499fa23df8d0ac.tar.gz
arching-kaos-tools-98af59585b378fddfb135a28ca499fa23df8d0ac.tar.bz2
arching-kaos-tools-98af59585b378fddfb135a28ca499fa23df8d0ac.zip
moving towards 'ak zchain --crawl' over 'ak enter'
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 10 insertions, 7 deletions
diff --git a/README b/README
index 6b4771a..77c0836 100644
--- a/README
+++ b/README
@@ -155,26 +155,29 @@ Add is nice, you can add an already existing file directly. `news` is the second
module after `mixtape`. Both modules need refactoring but they work at a level
that someone can be productive with these tools.
-### Explore chains ( `ak-enter` )
+### Explore chains ( `ak-zchain --crawl` )
You can view your zchain as a JSON object using `enter`. There are some flags
in order to either view other zchains or change the depth of view ( includes or
ignores data object and action ).
``` console
-$ ak enter -h
-ak-enter - Crawl an arching kaos chain
-======================================
-ak-enter [-N | --no-verify] [-l | --limit <number>] [zblock]
-ak-enter [-N | --no-verify] [-l | --limit <number>] -n <zchain>
+$ ak zchain --crawl -h
+ak zchain --crawl [-N | --no-verify] [-l | --limit <number>] [zblock]
+ak zchain --crawl [-N | --no-verify] [-l | --limit <number>] -n <zchain>
Usage:
+
--help, -h Print this help and exit
+
--chain <ipns-link>, -n <ipns-link> Crawl specified chain
+
--no-verify, -N Don't verify signatures
+
<ipfs-link> Specify IPFS CID for entrance
Note that combined flags don't work for now
-Running with no flags crawls your chain based on AK_ZLATEST environment variable
+Running with no flags crawls your chain based on AK_ZLATEST environment
+variable
```
Podman (or Docker)