العربية Català Čeština Dansk Deutsch English Français Bahasa Indonesia Italiano 日本語 한국어 (韩国)Nederlands Polski Português Português (Brasil)Русский Türkçe 中文（中国）Add your language

A full P2P protocol written entirely in JavaScript

A P2P JavaScript protocol

js-ipfs paves the way for the Browser implementation of the IPFS protocol. Written entirely in JavaScript, it runs in a Browser, a Service Worker, a Web Extension and Node.js, opening the door to a world of possibilities.

js-ipfs runs in a Browser, a Service Worker, a Web Extension and Node.js, opening the door to a world of possibilities.

Disable Animation

The js-ipfs library is in Alpha state.The codebase hasn't been audited by security specialists and it shouldn't be used to store, share or publish sensitive information.

Features

Packed with all the things you know and love about IPFS. This implementation also carries some extra neat things that are unique to the Browser. It's the toolkit to power all your DWeb Applications.

Run on Node.js and the Browser

js-ipfs works out of the box on Node.js, Electron and any modern browser. It is also customizable by design so that you can use it on your favorite runtime.

Implements the full IPFS Stack

No feature was left behind. js-ipfs is not a light client, it is the full implementation of the IPFS protocol.

Use PubSub to communicate in realtime with the other peers

IPFS nodes can create network topologies based on topics of interest to broadcast events in realtime.

Add and retrieve files from anywhere in the IPFS Network

IPFS is designed to use the power of Content Addressing to find the nodes in the network that have the content you are looking for. In the same way, you can add data and other nodes will find it too.

Use the DAG API to traverse over any hash linked data structure

IPFS uses IPLD, the InterPlanetary Linked-Data, a model that enables you interact with data from multiple sources, such as git, blockchains and more.

libp2p is built in

libp2p is the Modular Networking Stack that was created for IPFS and now you can use it through IPFS for your application directly as well.

Run it as a daemon

js-ipfs also comes with the option to run it as a daemon so that you can interact with it using the HTTP API that you are familiar with from go-ipfs.

Create stable addresses for changing data

It comes with IPNS, the Interplanetary Naming System, a way to author mutable pointers (records) to distribute updates in an authenticated and certified way.

Getting Started

IPFS gives you a Content Addressing primitive for all your data on the DWeb. You can make data available to the network or fetch existing data through its CID, the Content Identifier. Try it out below or explore our ProtoSchool tutorials!

Adding data to IPFS

const node = await IPFS.create()

const data = 'Hello, <YOUR NAME HERE>'

// add your data to IPFS - this can be a string, a Buffer,
// a stream of Buffers, etc
const results = node.add(data)

// we loop over the results because 'add' supports multiple 
// additions, but we only added one entry here so we only see
// one log line in the output
for await (const { cid } of results) {
  // CID (Content IDentifier) uniquely addresses the data
  // and can be used to get it again.
  console.log(cid.toString())
}

const node = await IPFS.create()
const data = 'Hello, <YOUR NAME HERE>'
// add your data to IPFS - this can be a string, a Buffer,
// a stream of Buffers, etc
const results = node.add(data)
// we loop over the results because 'add' supports multiple 
// additions, but we only added one entry here so we only see
// one log line in the output
for await (const { cid } of results) {
  // CID (Content IDentifier) uniquely addresses the data
  // and can be used to get it again.
  console.log(cid.toString())
}

Output

Getting data from IPFS

Using Javascript in the Browser or Node.js

const node = await IPFS.create()

const stream = node.cat('<YOUR CID HERE>')
const decoder = new TextDecoder()
let data = ''

for await (const chunk of stream) {
  // chunks of data are returned as a Uint8Array, convert it back to a string
  data += decoder.decode(chunk, { stream: true })
}

console.log(data)

const node = await IPFS.create()
const stream = node.cat('<YOUR CID HERE>')
const decoder = new TextDecoder()
let data = ''
for await (const chunk of stream) {
  // chunks of data are returned as a Uint8Array, convert it back to a string
  data += decoder.decode(chunk, { stream: true })
}
console.log(data)

Output

Using the CLI

npm install ipfs -g
jsipfs cat

Using the HTTP Gateway

https://ipfs.io/ipfs/

Learn More

Service Worker Gateway

Turn this page into a full IPFS Gateway without touching any servers or using HTTP to fetch content from the IPFS Network! Yes, you read it right, the Service Worker Gateway with js-ipfs can connect directly to the IPFS Network.

Enable Service Worker

What people are building with it

The whole Internet Archive, but decentralized. Access the archive's over 40m items via the DWeb. Combining a seeding gateway and a javascript UI for Firefox and Chrome.

Learn More

What you can build with JS-IPFS

There are unlimited options for you to use js-ipfs. The following examples provide you an idea of what you can build with js-ipfs. Try them out!

Stream Video through IPFS

Upload and send files

Have suggestions?Share them here!

Publications & Talks

Watch project updates, demos and other talks by the IPFS Community on the JavaScript project of IPFS. We will be adding dozens more talks soon from the IPFS Dev Meetings.

IPFS on the Brave Browser, Alan Shaw

CRDTs as the foundation for Distributed Web Apps, Pedro Teixeira

A Regular JS Core Dev Call, join us!

Community

js-ipfs is an MIT Licensed, Open Source project from the IPFS community. There are many ways you can contribute: help write the specification, code implementations and tools using js-ipfs, craft examples and tutorials, and join our working group calls to discuss IPFS with us.

Come hang out!

Community

Github

Twitter