cli readme
Juan Batiz-Benet committed
Jul 22, 2014 at 02:34 UTC
4fcdb23bd104ca1900ec59bf2066354cf02037a0
2 files changed
+30
-1
README.md
+1
-1
@@ -13,7 +13,7 @@ Please put all issues regarding go IPFS _implementation_ in [this repo](https://
13
14
```
15
git clone https://github.com/jbenet/go-ipfs
16
-cd go-ipfs
16
+cd go-ipfs/cmd/ipfs
17
go install
18
```
19
cmd/ipfs/README.md
new
+29
@@ -0,0 +1,29 @@
1
+# go-ipfs/cmd/ipfs
2
+
3
+This is the ipfs commandline tool. For now, it's the main entry point to using IPFS. Use it.
4
+
5
+```
6
+> go build
7
+> go install
8
+> ipfs
9
+ipfs - global versioned p2p merkledag file system
10
+
11
+Basic commands:
12
+
13
+ add <path> Add an object to ipfs.
14
+ cat <ref> Show ipfs object data.
15
+ ls <ref> List links from an object.
16
+ refs <ref> List link hashes from an object.
17
+
18
+Tool commands:
19
+
20
+ config Manage configuration.
21
+ version Show ipfs version information.
22
+ commands List all available commands.
23
+
24
+Advanced Commands:
25
+
26
+ mount Mount an ipfs read-only mountpoint.
27
+
28
+Use "ipfs help <command>" for more information about a command.
29
+```