# README
go-ipfs-api
This repository is a modified version of go-ipfs-api
that may/may not contain code in upstream (ipfs/go-ipfs-api
not RTradeLtd/go-ipfs-api
).
readme from upstream
An unofficial go interface to ipfs's HTTP API
Install
go get -u github.com/ipfs/go-ipfs-api
This will download the source into $GOPATH/src/github.com/ipfs/go-ipfs-api
.
Usage
See the godocs for details on available methods. This should match the specs at ipfs/specs; however, there are still some methods which are not accounted for. If you would like to add any of them, see the contribute section below.
Example
Add a file with the contents "hello world!":
package main
import (
"fmt"
"strings"
"os"
shell "github.com/ipfs/go-ipfs-api"
)
func main() {
// Where your local node is running on localhost:5001
sh := shell.NewShell("localhost:5001")
cid, err := sh.Add(strings.NewReader("hello world!"))
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s", err)
os.Exit(1)
}
fmt.Printf("added %s", cid)
}
For a more complete example, please see: https://github.com/ipfs/go-ipfs-api/blob/master/tests/main.go
Contribute
Contributions are welcome! Please check out the issues.
Want to hack on IPFS?
License
MIT
# Packages
No description provided by the author
# Functions
CidVersion allows for selecting the CID version that ipfs should use.
Hash allows for selecting the multihash type.
NewDirectShell creates a new shell that directly uses the provided URL, instead of attempting to parse it into a multiaddr.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
Logger is used to handle incoming logs from the ipfs node.
No description provided by the author
No description provided by the author
Message is a pubsub message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PubSubSubscription allow you to receive pubsub records that where published on the network.
No description provided by the author
RequestBuilder is an IPFS commands request builder.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author