diff --git a/.gobuilder.yml b/.gobuilder.yml new file mode 100644 index 000000000..8940bb85e --- /dev/null +++ b/.gobuilder.yml @@ -0,0 +1,3 @@ +--- +triggers: + - github.com/Luzifer/gobuilder/cmd/starter diff --git a/cmd/ipfs/.gobuilder.yml b/cmd/ipfs/.gobuilder.yml new file mode 100644 index 000000000..38932a784 --- /dev/null +++ b/cmd/ipfs/.gobuilder.yml @@ -0,0 +1,5 @@ +--- +artifacts: + - dist/README.md + - dist/LICENSE + - dist/install.sh diff --git a/cmd/ipfs/README.md b/cmd/ipfs/README.md index 73167b30f..72a388926 100644 --- a/cmd/ipfs/README.md +++ b/cmd/ipfs/README.md @@ -1,38 +1,30 @@ -# go-ipfs/cmd/ipfs +# [go-ipfs/cmd/ipfs](http://github.com/ipfs/go-ipfs/tree/master/cmd/ipfs) -This is the ipfs commandline tool. For now, it's the main entry point to using IPFS. Use it. +![](https://raw.githubusercontent.com/ipfs/logo/master/ipfs-logo-text-256-ice.png) + +This is the ipfs commandline tool. For now, it's the main entry point to using IPFS. + + +## Install from source ``` -> go build -> go install -> ipfs -ipfs - global versioned p2p merkledag file system - -Basic commands: - - init Initialize ipfs local configuration - add Add an object to ipfs - cat Show ipfs object data - ls List links from an object - -Tool commands: - - config Manage configuration - update Download and apply go-ipfs updates - version Show ipfs version information - commands List all available commands - -Advanced Commands: - - mount Mount an ipfs read-only mountpoint - serve Serve an interface to ipfs - diag Print diagnostics - -Plumbing commands: - - block Interact with raw blocks in the datastore - object Interact with raw dag nodes - - -Use "ipfs help " for more information about a command. +go install +ipfs +``` + +## Install from [gobuilder.me](https://gobuilder.me/) + +If you're viewing this in [gobuilder](https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs), chose the binary that suits you best at the end of this page. Download it, unzip it, and move the binary into place. + +## Usage + +```sh +# initialize an ipfs node +ipfs init + +# list some commands +ipfs + +# get help +ipfs --help ``` diff --git a/cmd/ipfs/dist/LICENSE b/cmd/ipfs/dist/LICENSE new file mode 100644 index 000000000..c7386b3c9 --- /dev/null +++ b/cmd/ipfs/dist/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Juan Batiz-Benet + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/cmd/ipfs/dist/README.md b/cmd/ipfs/dist/README.md new file mode 100644 index 000000000..4d78e17d2 --- /dev/null +++ b/cmd/ipfs/dist/README.md @@ -0,0 +1,28 @@ +# ipfs commandline tool + +This is the [ipfs](http://ipfs.io) commandline tool. It contains a full ipfs node. + +## Install + +To install it, move the binary somewhere in your `$PATH`: + +```sh +mv ipfs /usr/local/bin/ipfs +``` + +Or run `install.sh` which does this for you. + +## Usage + +First, you must initialize your local ipfs node: + +```sh +ipfs init +``` + +This will give you directions to get started with ipfs. +You can always get help with: + +```sh +ipfs --help +``` diff --git a/cmd/ipfs/dist/install.sh b/cmd/ipfs/dist/install.sh new file mode 100755 index 000000000..d5bb19c04 --- /dev/null +++ b/cmd/ipfs/dist/install.sh @@ -0,0 +1,21 @@ +#!/bin/sh + +bin=ipfs + +# this script is currently brain dead. +# it merely tries two locations. +# in the future maybe use value of $PATH. + +binpath=/usr/local/bin +if [ -d "$binpath" ]; then + mv "$bin" "$binpath/$bin" + echo "installed $binpath/$bin" + exit 0 +fi + +binpath=/usr/bin +if [ -d "$binpath" ]; then + mv "$bin" "$binpath/$bin" + echo "installed $binpath/$bin" + exit 0 +fi