The JavaScript implementation of the IPFS protocol
\n\n
\n\n\n\n\n\n\n\n\n\n\n \n
\n\n# ipfs-core \n\n`ipfs-core` is the implementation of the IPFS Core API written in JavaScript without depending on other languages/implementations. It contains all you need to integrate IPFS into your application.\n\nIf you want to run IPFS as a standalone daemon process, see the [ipfs](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs) module.\n\n## Getting Started\n\nThe `ipfs-core` package contains all the features of `ipfs` but in a lighter package without the CLI or HTTP servers:\n\n```console\n$ npm install ipfs-core\n```\n\nThen start a node in your app:\n\n```javascript\nimport * as IPFS from 'ipfs-core'\n\nconst ipfs = await IPFS.create()\nconst { cid } = await ipfs.add('Hello world')\nconsole.info(cid)\n// QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf\n```\n\n## Next Steps\n\n- Look into the [js-ipfs-examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser\n- Read 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- Head over to to take interactive tutorials that cover core IPFS APIs\n- Check out for tips, how-tos and more\n- See for news and more\n- Need help? Please ask 'How do I?' questions on \n\n### Browser CDN\n\nYou can load IPFS right in your browser by adding the following to your page using the super fast [jsdelivr](https://www.jsdelivr.com) CDN:\n\n```html\n\n\n\n\n\n```\n\nInserting one of the above lines will make an `IpfsCore` object available in the global namespace:\n\n```html\n\n```\n\n### Browser bundle\n\nLearn how to bundle IPFS into your application with webpack, parceljs and browserify in the [examples](https://github.com/ipfs/js-ipfs/tree/master/examples).\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- **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\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )\n- MIT ([LICENSE-MIT](LICENSE-MIT) / )\n\n## Contribute\n\nContributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs/issues).\n\nAlso see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.\n\nPlease be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.\n\n[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n","engines":{"npm":">=7.0.0","node":">=16.0.0"},"exports":{".":{"types":"./dist/src/index.d.ts","import":"./src/index.js"},"./config/profiles":{"types":"./src/components/config/profiles.d.ts","import":"./src/components/config/profiles.js"}},"gitHead":"a614528c55b8b22866bbdd2ffcde2e38eb5f578f","license":"Apache-2.0 OR MIT","scripts":{"lint":"aegir lint","test":"aegir test","build":"aegir build","clean":"aegir clean","dep-check":"aegir dep-check -i interface-ipfs-core -i ipfs-core-types --i interface-blockstore -i @libp2p/interface-dht -i @libp2p/interface-keys -i @libp2p/interface-transport -i @libp2p/interfaces","test:node":"aegir test -t node --cov","test:chrome":"aegir test -t browser --cov","test:firefox":"aegir test -t browser -- --browser firefox","prepublishOnly":"node scripts/update-version.js","test:bootstrapers":"IPFS_TEST=bootstrapers aegir test -t browser -f test/bootstrappers.js","test:electron-main":"aegir test -t electron-main","test:chrome-webworker":"aegir test -t webworker","test:firefox-webworker":"aegir test -t webworker -- --browser firefox"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"homepage":"https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core#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/6.0.1/node@v16.17.1+x64 (linux)","description":"JavaScript implementation of the IPFS specification","directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"ipfs-npm-publisher-bot","email":"alex.potsides+ipfs-npm-publisher-bot@protocol.ai"},{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"}],"_nodeVersion":"16.17.1","dependencies":{"dlv":"^1.1.3","ipns":"^4.0.0","pako":"^2.0.4","it-map":"^2.0.0","it-tar":"^6.0.0","libp2p":"^0.40.0","hashlru":"^2.3.0","is-ipfs":"^7.0.0","it-last":"^2.0.0","it-pipe":"^2.0.3","mortice":"^3.0.0","dag-jose":"^3.0.1","err-code":"^3.0.1","it-drain":"^2.0.0","it-first":"^2.0.0","it-merge":"^2.0.0","@ipld/car":"^5.0.0","ipfs-repo":"^16.0.0","it-filter":"^2.0.0","any-signal":"^3.0.0","ipfs-utils":"^9.0.6","ipfs-unixfs":"^8.0.0","it-parallel":"^3.0.0","it-peekable":"^2.0.0","it-pushable":"^3.0.0","uint8arrays":"^4.0.2","@ipld/dag-pb":"^3.0.0","ipfs-bitswap":"^13.0.0","it-to-buffer":"^3.0.0","multiformats":"^10.0.0","@libp2p/mplex":"^7.0.0","array-shuffle":"^3.0.0","hamt-sharding":"^3.0.0","just-safe-set":"^4.0.2","merge-options":"^3.0.4","@ipld/dag-cbor":"^8.0.0","@ipld/dag-json":"^9.0.0","@libp2p/crypto":"^1.0.0","@libp2p/logger":"^2.0.2","@libp2p/record":"^2.0.3","datastore-core":"^8.0.1","is-domain-name":"^1.0.1","parse-duration":"^1.0.0","@libp2p/kad-dht":"^5.0.1","@libp2p/peer-id":"^1.1.16","blockstore-core":"^2.0.1","ipfs-core-types":"^0.13.1-a77e40cc.0","ipfs-core-utils":"^0.17.1-a77e40cc.0","datastore-pubsub":"^6.0.0","ipfs-core-config":"^0.6.1-a77e40cc.0","ipfs-http-client":"^59.0.1-a77e40cc.0","@libp2p/bootstrap":"^5.0.0","@libp2p/interfaces":"^3.0.3","@libp2p/websockets":"^5.0.0","@multiformats/mafmt":"^11.0.2","interface-datastore":"^7.0.0","interface-blockstore":"^3.0.0","ipfs-unixfs-exporter":"^9.0.0","ipfs-unixfs-importer":"^11.0.0","@libp2p/interface-dht":"^1.0.2","@multiformats/murmur3":"^2.0.0","@libp2p/interface-keys":"^1.0.3","@chainsafe/libp2p-noise":"^10.0.0","@libp2p/peer-id-factory":"^1.0.19","@multiformats/multiaddr":"^11.0.0","timeout-abort-controller":"^3.0.0","@libp2p/interface-peer-id":"^1.0.5","@libp2p/interface-transport":"^2.0.0","@libp2p/delegated-peer-routing":"^3.0.0","@multiformats/multiaddr-to-uri":"^9.0.1","@libp2p/delegated-content-routing":"^3.0.0"},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"typesVersions":{"*":{"*":["*","dist/*","dist/src/*","dist/src/*/index"],"src/*":["*","dist/*","dist/src/*","dist/src/*/index"]}},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"aegir":"^37.0.11","delay":"^5.0.0","sinon":"^14.0.0","it-all":"^2.0.0","nanoid":"^4.0.0","rimraf":"^3.0.2","go-ipfs":"^0.12.0","iso-url":"^1.0.0","p-defer":"^4.0.0","ipfsd-ctl":"^12.0.3","@types/dlv":"^1.1.2","@types/pako":"^2.0.0","@types/rimraf":"^3.0.1","interface-ipfs-core":"^0.157.1-a77e40cc.0","interface-blockstore-tests":"^3.0.0","@chainsafe/libp2p-gossipsub":"^4.0.0","blockstore-datastore-adapter":"^4.0.0"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-core_0.17.1-a77e40cc.0_1666681890052_0.7504403363617396","host":"s3://npm-registry-packages"},"_id":"ipfs-core@0.17.1-a77e40cc.0","version":"0.17.1-a77e40cc.0"}
![\"IPFS](\"https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png\")
\n\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-core\")
\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