The JavaScript implementation of the IPFS protocol
\n\n
\n \n \n \n \n
\n\n
\n \n \n \n \n \n \n \n \n \n \n \n
\n\n> **Upgrading from <=0.40?** See the [release notes](https://github.com/ipfs/js-ipfs/issues/2656) for the list of API changes and the [migration guide](https://github.com/ipfs/js-ipfs/tree/master/docs/docs/MIGRATION-TO-ASYNC-AWAIT.md).\n\n`ipfs` is the core API, a CLI and a HTTP server that functions as a HTTP to IPFS bridge and an RPC endpoint.\n\nIf you want to integrate IPFS into your application without including a CLI or HTTP server, see the [ipfs-core](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core) module.\n\n## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Getting Started](#getting-started)\n - [Install](#install)\n - [Next Steps](#next-steps)\n- [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Getting Started\n\nWe've come a long way, but this project is still in Alpha, lots of development is happening, APIs might change, beware of 🐉..\n\n### Install\n\nInstalling `ipfs` globally will give you the `jsipfs` command which you can use to start a daemon running:\n\n```console\n$ npm install -g ipfs\n$ jsipfs daemon\nInitializing IPFS daemon...\njs-ipfs version: x.x.x\nSystem version: x64/darwin\nNode.js version: x.x.x\nSwarm listening on /ip4/127.0\n.... more output\n```\n\nYou can then add a file:\n\n```console\n$ jsipfs add ./hello-world.txt\nadded QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf hello-world.txt\n```\n\n### Next Steps\n\n* Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)\n* Look into the [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser\n* Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node\n* Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it\n* Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs\n* Check out https://docs.ipfs.io for tips, how-tos and more\n* See https://blog.ipfs.io for news and more\n* Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io\n\n## Want to hack on IPFS?\n\n[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n\nThe IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:\n\nRead the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).\n\n- **Check out existing issues** The [issue list](https://github.com/ipfs/js-ipfs/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge\n- **Look at the [IPFS Roadmap](https://github.com/ipfs/roadmap)** This are the high priority items being worked on right now\n- **Perform code reviews** More eyes will help\n a. speed the project along\n b. ensure quality, and\n c. reduce possible future bugs.\n- **Add tests**. There can never be enough tests.\n- **Join the [Weekly Core Implementations Call](https://github.com/ipfs/team-mgmt/issues/992)** it's where everyone discusses what's going on with IPFS and what's next\n\n## License\n\n[](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)\n\n[](https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core)\n","browser":{"go-ipfs":false,"./src/cli.js":false},"engines":{"npm":">=6.0.0","node":">=10.0.0"},"gitHead":"bc6e389099df351b06772e10fea7923ebb028f66","license":"(Apache-2.0 OR MIT)","scripts":{"lint":"aegir lint","test":"echo 'Only interface tests live here'","build":"npm run build:bundle && npm run build:types","clean":"rimraf ./dist","coverage":"nyc --reporter=text --reporter=lcov npm run test:interface:core -- -t node","dep-check":"aegir dep-check -i cross-env -i typescript -i ipfs-interop -i electron-webrtc -i wrtc -i rimraf","build:types":"tsc --build","build:bundle":"aegir build","test:interop":"cross-env IPFS_JS_EXEC=$PWD/src/cli.js IPFS_JS_MODULE=$PWD IPFS_JS_HTTP_MODULE=$PWD/../ipfs-http-client IPFS_REUSEPORT=false ipfs-interop","test:external":"aegir test-dependant","test:interface:core":"aegir test -f test/interface-core.js","test:interface:http-go":"aegir test -f test/interface-http-go.js","test:interface:http-js":"aegir test -f test/interface-http-js.js"},"_npmUser":{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},"homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs#readme","keywords":["IPFS"],"deprecated":"js-IPFS has been deprecated in favour of Helia - please see https://github.com/ipfs/js-ipfs/issues/4336 for details","repository":{"url":"git+https://github.com/ipfs/js-ipfs.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v14.15.1+x64 (linux)","description":"JavaScript implementation of the IPFS specification","directories":{},"maintainers":[{"name":"jacobheun","email":"jacobheun@gmail.com"},{"name":"daviddias","email":"mail@daviddias.me"},{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":"alan138@gmail.com"},{"name":"hugomrdias","email":"mail@hugodias.me"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"}],"_nodeVersion":"14.15.1","contributors":[{"name":"0xflotus","email":"0xflotus@gmail.com"},{"name":"A_A","email":"21040751+Otto-AA@users.noreply.github.com"},{"name":"Adam Uhlíř","email":"adam@uhlir.dev"},{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Alan Shaw","email":"alan@tableflip.io"},{"name":"Alex North","email":"alex@alexnorth.me"},{"name":"Alex Potsides","email":"alex@achingbrain.net"},{"name":"Andrew Nesbitt","email":"andrewnez@gmail.com"},{"name":"Andrew de Andrade","email":"andrew@deandrade.com.br"},{"name":"André Cruz","email":"andremiguelcruz@msn.com"},{"name":"Arkadiy Kukarkin","email":"parkan@users.noreply.github.com"},{"name":"Arpit Agarwal","email":"93arpit@gmail.com"},{"name":"Arpit Agarwal","email":"atvanguard@users.noreply.github.com"},{"name":"Ayush Mahajan","email":"mahajan.ayush2306@gmail.com"},{"name":"Bernard Mordan","email":"bernard@tableflip.io"},{"name":"Brian Vander Schaaf","email":"bvs330@gmail.com"},{"name":"Bruno Zell","email":"bruno.zzell@gmail.com"},{"name":"CHEVALAY JOSSELIN","email":"josselin54.chevalay@gmail.com"},{"name":"Caio Gondim","email":"me@caiogondim.com"},{"name":"Chance Hudson","email":"jchancehud@gmail.com"},{"name":"Chirag Shinde","email":"chirag-shinde@users.noreply.github.com"},{"name":"Christian Couder","email":"chriscool@tuxfamily.org"},{"name":"Dafeng","email":"dfguo.joe@gmail.com"},{"name":"Dan Ordille","email":"dordille@gmail.com"},{"name":"Dan Shields","email":"35669742+NukeManDan@users.noreply.github.com"},{"name":"Daniel Buchner","email":"danieljb2@gmail.com"},{"name":"Daniel J. O'Quinn","email":"danieljoquinn@gmail.com"},{"name":"Daniela Borges Matos de Carvalho","email":"alunassertiva@gmail.com"},{"name":"David Dias","email":"daviddias.p@gmail.com"},{"name":"David Gilbertson","email":"gilbertson.david@gmail.com"},{"name":"David da Silva","email":"dasilvacontin@gmail.com"},{"name":"Diogo Silva","email":"fsdiogo@gmail.com"},{"name":"Dmitriy Ryajov","email":"dryajov@gmail.com"},{"name":"Dominic Della Valle","email":"ddvpublic@Gmail.com"},{"name":"Dzmitry Bachko","email":"dbachko@gmail.com"},{"name":"Enrico Marino","email":"enrico.marino@email.com"},{"name":"Faheel Ahmad","email":"faheel@live.in"},{"name":"Felix Yan","email":"felixonmars@archlinux.org"},{"name":"Francisco Baio Dias","email":"xicombd@gmail.com"},{"name":"Francisco Baio Dias","email":"francisco@typeform.com"},{"name":"Friedel Ziegelmayer","email":"dignifiedquire@gmail.com"},{"name":"Gabriel Garrido Calvo","email":"gabriel.garrido.work@gmail.com"},{"name":"Gar","email":"gar+gh@danger.computer"},{"name":"Georgios Rassias","email":"georassias@gmail.com"},{"name":"Gorka Ludlow","email":"gorka@aquigorka.com"},{"name":"Grant Herman","email":"grantlouisherman041@gmail.com"},{"name":"Greenkeeper","email":"support@greenkeeper.io"},{"name":"Haad","email":"haadcode@users.noreply.github.com"},{"name":"Haoliang Yu","email":"haoliangyu@users.noreply.github.com"},{"name":"Harsh Vakharia","email":"harshjv@users.noreply.github.com"},{"name":"Henrique Dias","email":"hacdias@gmail.com"},{"name":"Henry Rodrick","email":"moshisushi@gmail.com"},{"name":"Heo Sangmin","email":"heo@mapiacompany.com"},{"name":"Hugo Dias","email":"hugomrdias@gmail.com"},{"name":"Hugo Dias","email":"mail@hugodias.me"},{"name":"Irakli Gozalishvili","email":"contact@gozala.io"},{"name":"Jacob Heun","email":"jacobheun@gmail.com"},{"name":"Jacob Heun","email":"jake@andyet.net"},{"name":"Jade Meskill","email":"jade.meskill@gmail.com"},{"name":"Jessica Schilling","email":"jessica@protocol.ai"},{"name":"Johannes Wikner","email":"johannes.wikner@gmail.com"},{"name":"Jon Schlinkert","email":"dev@sellside.com"},{"name":"Jonathan","email":"jkrone@vt.edu"},{"name":"Jonybang","email":"Jonybange@gmail.com"},{"name":"Jorropo","email":"jorropo.pgm@gmail.com"},{"name":"João Antunes","email":"j.goncalo.antunes@gmail.com"},{"name":"João Santos","email":"joaosantos15@users.noreply.github.com"},{"name":"Kevin Wang","email":"kevin@fossa.io"},{"name":"Lars Gierth","email":"larsg@systemli.org"},{"name":"Lukas Drgon","email":"lukas.drgon@gmail.com"},{"name":"Maciej Krüger","email":"mkg20001@gmail.com"},{"name":"Marcin Rataj","email":"lidel@lidel.org"},{"name":"Marcus Bernales","email":"mboperator@gmail.com"},{"name":"Marius Darila","email":"marius.darila@gmail.com"},{"name":"Mark Robert Henderson","email":"henderson.mark@gmail.com"},{"name":"Mat Kelly","email":"machawk1@gmail.com"},{"name":"Michelle Lee","email":"michelle@protocol.ai"},{"name":"Mikeal Rogers","email":"mikeal.rogers@gmail.com"},{"name":"Mithgol","email":"getgit@mithgol.ru"},{"name":"Molly","email":"momack2@users.noreply.github.com"},{"name":"Mounish Sai","email":"pvsmounish@gmail.com"},{"name":"My9Bot","email":"34904312+My9Bot@users.noreply.github.com"},{"name":"Nick Poulden","email":"nick@poulden.com"},{"name":"Nitin Patel","email":"31539366+niinpatel@users.noreply.github.com"},{"name":"Nuno Nogueira","email":"nunofmn@gmail.com"},{"name":"Oli Evans","email":"oli@tableflip.io"},{"name":"Oskar Nyberg","email":"oskar@oskarnyberg.com"},{"name":"Pascal Precht","email":"pascal.precht@googlemail.com"},{"name":"Pau Ramon Revilla","email":"masylum@gmail.com"},{"name":"Paulo Rodrigues","email":"me@paulogr.com"},{"name":"Pedro Santos","email":"pedro.santos@moxy.studio"},{"name":"Pedro Santos","email":"pedromiguelsousasantos@hotmail.com"},{"name":"Pedro Teixeira","email":"i@pgte.me"},{"name":"Portia Burton","email":"plburton@gmail.com"},{"name":"Prabhakar Poudel","email":"yuvrajzohan@gmail.com"},{"name":"Qmstream","email":"51881352+Qmstream@users.noreply.github.com"},{"name":"Raoul Millais","email":"raoul@raoulmillais.com"},{"name":"RasmusErik Voel Jensen","email":"github@solsort.com"},{"name":"Richard Littauer","email":"richard.littauer@gmail.com"},{"name":"Richard Schneider","email":"makaretu@gmail.com"},{"name":"Rob Brackett","email":"rob@robbrackett.com"},{"name":"Rod Keys","email":"rod@zokos.com"},{"name":"Sangwon Hong","email":"qpakzk@gmail.com"},{"name":"Sid Harder","email":"sideharder@gmail.com"},{"name":"SidHarder","email":"softwarenavigator@gmail.com"},{"name":"Stephen Whitmore","email":"stephen.whitmore@gmail.com"},{"name":"Stephen Whitmore","email":"noffle@users.noreply.github.com"},{"name":"Steven Allen","email":"steven@stebalien.com"},{"name":"Tapasweni Pathak","email":"tapaswenipathak@gmail.com"},{"name":"Terence Pae","email":"terencepae@gmail.com"},{"name":"Teri Chadbourne","email":"terichadbourne@users.noreply.github.com"},{"name":"Travis CI","email":"travis@travis-ci.org"},{"name":"Uroš Jurglič","email":"jurglic@gmail.com"},{"name":"Vasco Santos","email":"vasco.santos@moxy.studio"},{"name":"Vasco Santos","email":"vasco.santos@ua.pt"},{"name":"Vincent Martin","email":"vince@finalatomicbuster.net"},{"name":"Volker Mische","email":"volker.mische@gmail.com"},{"name":"Xiao Liang","email":"yxliang01@users.noreply.github.com"},{"name":"Yahya","email":"ya7yaz@gmail.com"},{"name":"Yole","email":"yole@ultiledger.io"},{"name":"bitspill","email":"bitspill+github@bitspill.net"},{"name":"datafatmunger","email":"jbg@peerparty.org"},{"name":"dirkmc","email":"dirkmdev@gmail.com"},{"name":"dirkmc","email":"dirk@mccormick.cx"},{"name":"greenkeeper[bot]","email":"23040076+greenkeeper[bot]@users.noreply.github.com"},{"name":"greenkeeper[bot]","email":"greenkeeper[bot]@users.noreply.github.com"},{"name":"haad","email":"haad@headbanggames.com"},{"name":"hapsody","email":"hapsody@gmail.com"},{"name":"jbenet","email":"juan@benet.ai"},{"name":"jonahweissman","email":"19804455+jonahweissman@users.noreply.github.com"},{"name":"kevingzhang","email":"kevin.zhang.canada@gmail.com"},{"name":"kumavis","email":"kumavis@users.noreply.github.com"},{"name":"nginnever","email":"ginneversource@gmail.com"},{"name":"npmcdn-to-unpkg-bot","email":"npmcdn-to-unpkg-bot@users.noreply.github.com"},{"name":"reasv","email":"7143787+reasv@users.noreply.github.com"},{"name":"robbsolter","email":"35879806+robbsolter@users.noreply.github.com"},{"name":"seungwon-kang","email":"ksw3894@gmail.com"},{"name":"swedneck","email":"40505480+swedneck@users.noreply.github.com"},{"name":"tcme","email":"hi@this-connect.me"},{"name":"victorbjelkholm","email":"victorbjelkholm@gmail.com"},{"name":"Łukasz Magiera","email":"magik6k@users.noreply.github.com"},{"name":"Максим Ильин","email":"negamaxi@gmail.com"},{"name":"Xmader","email":"xmader@outlook.com"}],"dependencies":{"debug":"^4.1.1","semver":"^7.3.2","ipfs-cli":"^0.2.3-rc.1+bc6e3890","ipfs-core":"^0.3.1-rc.1+bc6e3890","ipfs-repo":"^7.0.0","update-notifier":"^5.0.0"},"typesVersions":{"*":{"*":["dist/*","dist/*/index"]}},"_hasShrinkwrap":false,"leadMaintainer":"Alex Potsides ","readmeFilename":"README.md","devDependencies":{"wrtc":"^0.4.6","aegir":"^28.2.0","rimraf":"^3.0.2","go-ipfs":"^0.7.0","iso-url":"^1.0.0","cross-env":"^7.0.0","ipfsd-ctl":"^7.0.2","ipfs-utils":"^5.0.0","typescript":"4.0.x","ipfs-interop":"^3.0.0","merge-options":"^2.0.0","electron-webrtc":"^0.3.0","ipfs-http-client":"^48.1.3-rc.1+bc6e3890","libp2p-webrtc-star":"^0.20.1","interface-ipfs-core":"^0.142.3-rc.1+bc6e3890"},"_npmOperationalInternal":{"tmp":"tmp/ipfs_0.52.3-rc.1_1606379079020_0.17567133144285285","host":"s3://npm-registry-packages"},"_id":"ipfs@0.52.3-rc.1","version":"0.52.3-rc.1"}
![\"IPFS](\"https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png\")
\n \n![](\"https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat\"){kind=icon}
\n ![](\"https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat\"){kind=icon}
\n ![](\"https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord&style=flat\")
![](\"https://img.shields.io/badge/team-mgmt-blue.svg?style=flat\"){kind=icon}
\n![](\"https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg\"){kind=icon}
\n ![](\"https://david-dm.org/ipfs/js-ipfs.svg?style=flat&path=packages/ipfs\")
\n ![](\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat\"){kind=icon}
\n ![](\"https://img.shields.io/badge/npm-%3E%3D6.0.0-orange.svg?style=flat\"){kind=icon}
\n ![](\"https://img.shields.io/badge/Node.js-%3E%3D10.0.0-orange.svg?style=flat\"){kind=icon}
\n ![](\"https://img.shields.io/npm/dm/ipfs.svg\")
\n