cli readme

This commit is contained in:
Juan Batiz-Benet 2014-07-22 02:34:29 -07:00
parent 140317007e
commit 4fcdb23bd1
2 changed files with 30 additions and 1 deletions

View File

@ -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
```

29
cmd/ipfs/README.md Normal file
View File

@ -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 <path> Add an object to ipfs.
cat <ref> Show ipfs object data.
ls <ref> List links from an object.
refs <ref> 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 <command>" for more information about a command.
```