Package - ipfs

The JavaScript implementation of the IPFS protocol

Upgrading from <=0.40 to 0.41? 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 🐉..

Getting started

Look into the examples folder to learn how to spawn an IPFS node in Node.js and in the Browser
Read 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-beta.ipfs.io for tips, how-tos and more

Tech Lead

David Dias

Lead Maintainer

Alex Potsides

Getting started
Install
- Browser CDN
- Browser bundle
Documentation
Want to hack on IPFS?
Packages
License

Install

$ npm install ipfs

If you are planning on using js-ipfs on the command line, install it globally:

$ npm install -g ipfs

Browser CDN

You can load IPFS right in your browser by adding the following to your page using the super fast jsdelivr CDN:

<!-- loading the minified version using jsDelivr -->
<script src="https://cdn.jsdelivr.net/npm/ipfs/dist/index.min.js"></script>

<!-- loading the human-readable (not minified) version jsDelivr -->
<script src="https://cdn.jsdelivr.net/npm/ipfs/dist/index.js"></script>

Inserting one of the above lines will make an Ipfs object available in the global namespace:

<script>
async function main () {
  const node = await window.Ipfs.create()
  // Ready to use!
  // See https://github.com/ipfs/js-ipfs#core-api
}
main()
</script>

Browser bundle

Learn how to bundle IPFS into your application with webpack, parceljs and browserify in the examples folder.

Documentation

Core API

API Docs

How to run IPFS in various environments

How to use IPFS in your application

docs/MODULE.md

Different topics in detail

Questions?

docs/FAQ.md

Need help?

Please ask 'How do I?' questions on https://discuss.ipfs.io

Want to hack on IPFS?

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

Packages

List of the main packages that make up the IPFS ecosystem.

Package	Version	Deps	CI/Travis	Coverage	Lead Maintainer
Files
`ipfs-unixfs-exporter`					Alex Potsides
`ipfs-unixfs-importer`					Alex Potsides
`ipfs-unixfs`					Alex Potsides
Repo
`ipfs-repo`					Alex Potsides
Exchange
`ipfs-block-service`					Volker Mische
`ipfs-block`					Volker Mische
`ipfs-bitswap`					Dirk McCormick
IPNS
`ipfs-name`					N/A
Generics/Utils
`ipfs-utils`					Hugo Dias
`ipfs-http-client`					Alan Shaw
`ipfs-http-response`					Vasco Santos
`ipfsd-ctl`					Hugo Dias
`is-ipfs`					Marcin Rataj
`aegir`					Hugo Dias
`ipfs-repo-migrations`					N/A
libp2p
`libp2p`					Jacob Heun
`peer-id`					Vasco Santos
`peer-info`					Vasco Santos
`libp2p-crypto`					Jacob Heun
`libp2p-keychain`					Vasco Santos
`libp2p-circuit`					Jacob Heun
`libp2p-floodsub`					Vasco Santos
`libp2p-gossipsub`					Cayman Nava
`libp2p-kad-dht`					Vasco Santos
`libp2p-mdns`					Jacob Heun
`libp2p-bootstrap`					Vasco Santos
`libp2p-secio`					Friedel Ziegelmayer
`libp2p-tcp`					Jacob Heun
`libp2p-webrtc-star`					Vasco Santos
`libp2p-websocket-star`					Jacob Heun
`libp2p-websockets`					Jacob Heun
`pull-mplex`					Jacob Heun
IPLD
`ipld`					Volker Mische
`ipld-dag-pb`					Volker Mische
`ipld-dag-cbor`					Volker Mische
Multiformats
`multihashing`					Hugo Dias
`mafmt`					Vasco Santos
`multiaddr`					Jacob Heun
`multihashes`					David Dias