1
0
mirror of https://github.com/ipfs/kubo.git synced 2025-09-10 11:52:21 +08:00

gobuilder improvements

- README.md
- install.sh script
- LICENSE
- trigger in main repo
This commit is contained in:
Juan Batiz-Benet
2015-04-02 03:00:49 -07:00
parent 0ba4a6ffb1
commit 20b5f96e6a
6 changed files with 104 additions and 34 deletions

3
.gobuilder.yml Normal file
View File

@ -0,0 +1,3 @@
---
triggers:
- github.com/Luzifer/gobuilder/cmd/starter

5
cmd/ipfs/.gobuilder.yml Normal file
View File

@ -0,0 +1,5 @@
---
artifacts:
- dist/README.md
- dist/LICENSE
- dist/install.sh

View File

@ -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 <path> Add an object to ipfs
cat <ref> Show ipfs object data
ls <ref> 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 <command>" 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 <subcmd> --help
```

21
cmd/ipfs/dist/LICENSE vendored Normal file
View File

@ -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
cmd/ipfs/dist/README.md vendored Normal file
View File

@ -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
cmd/ipfs/dist/install.sh vendored Executable file
View File

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