Upgrading from <=0.40 to 0.48? See the release notes for the list of API changes and the migration guide.
We've come a long way, but this project is still in Alpha, lots of development is happening, APIs might change, beware of 🐉..
- Read the docs
- Look into the examples to learn how to spawn an IPFS node in Node.js and in the Browser
- Consult the Core API docs to see what you can do with an IPFS node
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
- Check out https://docs.ipfs.io for tips, how-tos and more
- See https://blog.ipfs.io for news and more
- Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io
Installing ipfs globally will give you the jsipfs command which you can use to start a daemon running:
$ npm install -g ipfs
$ jsipfs daemon
Initializing IPFS daemon...
js-ipfs version: x.x.x
System version: x64/darwin
Node.js version: x.x.x
Swarm listening on /ip4/127.0
.... more outputYou can then add a file:
$ jsipfs add ./hello-world.txt
added QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf hello-world.txtIf you do not need to run a command line daemon, use the ipfs-core package - it has all the features of ipfs but in a lighter package:
$ npm install ipfs-coreThen start a node in your app:
const IPFS = require('ipfs-core')
const ipfs = await IPFS.create()
const { cid } = await ipfs.add('Hello world')
console.info(cid)
// QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCafThis project is broken into several modules, their purposes are:
/packages/interface-ipfs-coreTests to ensure adherence of an implementation to the spec/packages/ipfsThe core implementation/packages/ipfs-core-utilsHelpers and utilities common to core and the HTTP RPC API client/packages/ipfs-http-clientA client for the RPC-over-HTTP API presented by both js-ipfs and go-ipfs/packages/ipfs-message-port-clientA client for the RPC-over-HTTP API presented by both js-ipfs and go-ipfs/packages/ipfs-message-port-clientA client for the RPC-over-message-port API presented by js-ipfs running in a shared worker/packages/ipfs-message-port-protocolCode shared by the message port client & server/packages/ipfs-message-port-serverThe server that receives requests from ipfs-message-port-client
List of the main packages that make up the IPFS ecosystem.
This table is generated using the module
package-tablewithpackage-table --data=package-list.json.
The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
Read the Code of Conduct and JavaScript Contributing Guidelines.
- Check out existing issues The issue list has many that are marked as 'help wanted' or 'difficulty:easy' which make great starting points for development, many of which can be tackled with no prior IPFS knowledge
- Look at the IPFS Roadmap This are the high priority items being worked on right now
- Perform code reviews More eyes will help a. speed the project along b. ensure quality, and c. reduce possible future bugs.
- Add tests. There can never be enough tests.
- Join the Weekly Core Implementations Call it's where everyone discusses what's going on with IPFS and what's next
