Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gobuilder improvements #1004

Merged
merged 1 commit into from
Apr 2, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gobuilder.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
triggers:
- github.com/Luzifer/gobuilder/cmd/starter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you want to change this line to start github.com/ipfs/go-ipfs/cmd/ipfs

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops

5 changes: 5 additions & 0 deletions cmd/ipfs/.gobuilder.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
artifacts:
- dist/README.md
- dist/LICENSE
- dist/install.sh
44 changes: 18 additions & 26 deletions cmd/ipfs/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,30 @@
# go-ipfs/cmd/ipfs
# [go-ipfs/cmd/ipfs](https://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)

```
> go build
> go install
> ipfs
ipfs - global versioned p2p merkledag file system

Basic commands:
This is the ipfs commandline tool. For now, it's the main entry point to using IPFS.

init Initialize ipfs local configuration
add <path> Add an object to ipfs
cat <ref> Show ipfs object data
ls <ref> List links from an object

Tool commands:
## Install from source

config Manage configuration
update Download and apply go-ipfs updates
version Show ipfs version information
commands List all available commands
```
go install
ipfs
```

Advanced Commands:
## Install from [gobuilder.me](https://gobuilder.me/)

mount Mount an ipfs read-only mountpoint
serve Serve an interface to ipfs
diag Print diagnostics
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.

Plumbing commands:
## Usage

block Interact with raw blocks in the datastore
object Interact with raw dag nodes
```sh
# initialize an ipfs node
ipfs init

# list some commands
ipfs

Use "ipfs help <command>" for more information about a command.
# get help
ipfs <subcmd> --help
```
21 changes: 21 additions & 0 deletions cmd/ipfs/dist/LICENSE
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions cmd/ipfs/dist/README.md
Original file line number Diff line number Diff line change
@@ -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
```
21 changes: 21 additions & 0 deletions cmd/ipfs/dist/install.sh
Original file line number Diff line number Diff line change
@@ -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