From 4fcdb23bd104ca1900ec59bf2066354cf02037a0 Mon Sep 17 00:00:00 2001 From: Juan Batiz-Benet Date: Tue, 22 Jul 2014 02:34:29 -0700 Subject: [PATCH] cli readme --- README.md | 2 +- cmd/ipfs/README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 cmd/ipfs/README.md diff --git a/README.md b/README.md index ed4322d04..9a6907a99 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Please put all issues regarding go IPFS _implementation_ in [this repo](https:// ``` git clone https://github.com/jbenet/go-ipfs -cd go-ipfs +cd go-ipfs/cmd/ipfs go install ``` diff --git a/cmd/ipfs/README.md b/cmd/ipfs/README.md new file mode 100644 index 000000000..0051f68e9 --- /dev/null +++ b/cmd/ipfs/README.md @@ -0,0 +1,29 @@ +# go-ipfs/cmd/ipfs + +This is the ipfs commandline tool. For now, it's the main entry point to using IPFS. Use it. + +``` +> go build +> go install +> ipfs +ipfs - global versioned p2p merkledag file system + +Basic commands: + + add Add an object to ipfs. + cat Show ipfs object data. + ls List links from an object. + refs List link hashes from an object. + +Tool commands: + + config Manage configuration. + version Show ipfs version information. + commands List all available commands. + +Advanced Commands: + + mount Mount an ipfs read-only mountpoint. + +Use "ipfs help " for more information about a command. +```