coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 18:37:45 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
An IPFS implementation in Go
161 Commits 160 Branches 212 Tags 122 MiB
Go 82.9%
Shell 16.4%
Makefile 0.6%
Dockerfile 0.1%
691d1b36bb
Go to file
Jeromy 691d1b36bb integrate bitswap and blockservice into the core package
2014-08-29 11:34:50 -07:00
bitswap integrate bitswap and blockservice into the core package 2014-08-29 11:34:50 -07:00
blocks more work on bitswap and other code cleanup 2014-08-25 09:44:42 -07:00
blockservice integrate bitswap and blockservice into the core package 2014-08-29 11:34:50 -07:00
cmd/ipfs integrate bitswap and blockservice into the core package 2014-08-29 11:34:50 -07:00
config mkdir .go-ipfs bugfix 2014-08-20 18:26:28 -07:00
core integrate bitswap and blockservice into the core package 2014-08-29 11:34:50 -07:00
fuse/readonly integrate bitswap and blockservice into the core package 2014-08-29 11:34:50 -07:00
identify fix a few race conditions and add in newlines to print statements 2014-08-20 18:42:26 -07:00
importer more work on bitswap and other code cleanup 2014-08-25 09:44:42 -07:00
merkledag integrate bitswap and blockservice into the core package 2014-08-29 11:34:50 -07:00
msgproto add a package header so the package compiles 2014-07-18 18:29:53 -07:00
path integrate bitswap and blockservice into the core package 2014-08-29 11:34:50 -07:00
peer more tests and add in table filtering by peer latency 2014-08-11 20:11:23 -07:00
routing rework bitswap to reflect discussion on PR #32 2014-08-28 16:48:00 -07:00
swarm rework bitswap to reflect discussion on PR #32 2014-08-28 16:48:00 -07:00
util POut should not have a newline 2014-08-20 18:29:31 -07:00
.gitignore more work on bitswap and other code cleanup 2014-08-25 09:44:42 -07:00
.travis.yml 1.1 fails with multihash 2014-07-30 01:53:29 -07:00
dev.md dev pseudo-roadmap 2014-07-30 02:41:26 -07:00
LICENSE added MIT license 2014-07-10 12:16:22 -07:00
README.md more work on bitswap and other code cleanup 2014-08-25 09:44:42 -07:00

README.md

ipfs implementation in go.

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

Please put all issues regarding IPFS design in the ipfs repo issues.

Please put all issues regarding go IPFS implementation in this repo.

Install

Install Go. Then:

go get github.com/jbenet/go-ipfs/cmd/ipfs
cd $GOPATH/src/github.com/jbenet/go-ipfs/cmd/ipfs
go install

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

If you are interested in development, please install the development dependencies as well.

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.

Contributing

go-ipfs is MIT licensed open source software. We welcome contributions big and small! Please make sure to check the issues. Search the closed ones before reporting things, and help us with the open ones.

Guidelines:

  • see the dev pseudo-roadmap
  • please adhere to the protocol described in the main ipfs repo and paper.
  • please make branches + pull-request, even if working on the main repository
  • ask questions or talk about things in Issues or #ipfs on freenode.
  • ensure you are able to contribute (no legal issues please-- we'll probably setup a CLA)
  • run go fmt before pushing any code
  • run golint and go vet too -- some things (like protobuf files) are expected to fail.
  • if you'd like to work on ipfs part-time (20+ hrs/wk) or full-time (40+ hrs/wk), contact @jbenet
  • have fun!

Todo

Ipfs is still under heavy development, there is a lot to be done!

  • Finish Bitswap
  • Connect fuse interface to Blockservice
  • Write tests for bitswap
  • Come up with more TODO items

Development Dependencies

If you make changes to the protocol buffers, you will need to install the protoc compiler.

License

MIT