README.md 1.04 KB
Newer Older
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
1 2 3 4 5 6 7 8 9
# ipfs implementation in go.

See: https://github.com/jbenet/ipfs

Please put all issues regarding IPFS _design_ in the
[ipfs repo issues](https://github.com/jbenet/ipfs/issues).

Please put all issues regarding go IPFS _implementation_ in [this repo](https://github.com/jbenet/go-ipfs/issues).

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
10 11 12 13 14
## Install

[Install Go](http://golang.org/doc/install). Then:

```
15
go get github.com/jbenet/go-ipfs/cmd/ipfs
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
16 17
```

18 19
NOTE: `git` and mercurial (`hg`) are required in order for `go get` to fetch all dependencies.

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
## Usage

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