JavaScript implementation of the IPFS specification
$ npm install ipfs
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 🐉..
$ npm install ipfs
If you are planning on using js-ipfs on the command line, install it globally:
$ npm install -g ipfs
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.min.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>
Learn how to bundle IPFS into your application with webpack, parceljs and browserify in the examples folder.
Please ask 'How do I?' questions on https://discuss.ipfs.io
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.
List of the main packages that make up the IPFS ecosystem.
This table is generated using the module
package-table
withpackage-table --data=package-list.json
.
© 2010 - cnpmjs.org x YWFE | Home | YWFE