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# ipfs-core \n\n> The IPFS Core API\n\n`ipfs-core` is the implementation of the IPFS Core API. 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## Lead Maintainer \n\n[Alex Potsides](http://github.com/achingbrain)\n\n## Table of Contents \n\n- [Getting Started](#getting-started)\n- [Next Steps](#next-steps)\n - [Browser CDN](#browser-cdn)\n - [Browser bundle](#browser-bundle)\n- [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\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\nconst IPFS = require('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 [examples](/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* 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### 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- **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\na. speed the project along\nb. ensure quality, and\nc. 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":{"./src/runtime/dns-nodejs.js":"./src/runtime/dns-browser.js","./src/runtime/repo-nodejs.js":"./src/runtime/repo-browser.js","./src/runtime/config-nodejs.js":"./src/runtime/config-browser.js","./src/runtime/libp2p-nodejs.js":"./src/runtime/libp2p-browser.js","./src/runtime/preload-nodejs.js":"./src/runtime/preload-browser.js","ipfs-utils/src/files/glob-source":false,"./test/utils/create-repo-nodejs.js":"./test/utils/create-repo-browser.js","./src/runtime/init-assets-nodejs.js":"./src/runtime/init-assets-browser.js","./src/runtime/libp2p-pubsub-routers-nodejs.js":"./src/runtime/libp2p-pubsub-routers-browser.js"},"gitHead":"4921e9aaa627c6fd03562c26cb7dcb201d6af936","license":"(Apache-2.0 OR MIT)","scripts":{"lint":"aegir lint","test":"aegir test","build":"npm run build:js && npm run build:types","clean":"rm -rf ./dist","build:js":"aegir build","coverage":"nyc --reporter=text --reporter=lcov npm run test:node","dep-check":"aegir dep-check -i typescript -i interface-ipfs-core","test:node":"aegir test -t node","build:types":"tsc --build","test:browser":"aegir test -t browser","test:webworker":"aegir test -t webworker -- --timeout 10000","test:bootstrapers":"IPFS_TEST=bootstrapers aegir test -t browser -f test/bootstrapers.js","test:electron-main":"aegir test -t electron-main","test:electron-renderer":"aegir test -t electron-renderer"},"_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.0+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"}],"_nodeVersion":"14.15.0","dependencies":{"dlv":"^1.1.3","cbor":"^5.1.0","cids":"^1.0.0","ipld":"^0.28.0","ipns":"^0.8.0","debug":"^4.1.1","mafmt":"^8.0.0","it-all":"^1.0.4","libp2p":"^0.29.3","hashlru":"^2.3.0","is-ipfs":"^2.0.0","it-last":"^1.0.4","it-pipe":"^1.1.0","mortice":"^2.0.0","p-defer":"^3.0.0","p-queue":"^6.6.1","peer-id":"^0.14.1","class-is":"^1.1.0","err-code":"^2.0.3","ipld-raw":"^6.0.0","it-first":"^1.0.4","ipfs-repo":"^7.0.0","multiaddr":"^8.0.0","multibase":"^3.0.0","any-signal":"^2.0.0","ipfs-utils":"^5.0.0","ipld-block":"^0.11.0","libp2p-tcp":"^0.15.1","multicodec":"^2.0.1","ipfs-unixfs":"^2.0.3","ipld-dag-pb":"^0.20.0","libp2p-mdns":"^0.15.0","uint8arrays":"^1.1.0","bignumber.js":"^9.0.0","ipfs-bitswap":"^4.0.0","libp2p-mplex":"^0.10.0","libp2p-noise":"^2.0.1","array-shuffle":"^1.0.1","hamt-sharding":"^1.0.0","ipld-dag-cbor":"^0.17.0","libp2p-crypto":"^0.18.0","libp2p-record":"^0.9.0","merge-options":"^2.0.0","dag-cbor-links":"^2.0.0","datastore-core":"^2.0.0","is-domain-name":"^1.0.1","libp2p-kad-dht":"^0.20.1","parse-duration":"^0.4.4","ipfs-core-utils":"^0.5.2-rc.8+4921e9aa","libp2p-floodsub":"^0.23.1","datastore-pubsub":"^0.4.1","libp2p-bootstrap":"^0.12.1","libp2p-gossipsub":"^0.6.1","multiaddr-to-uri":"^6.0.0","libp2p-websockets":"^0.14.0","ipfs-block-service":"^0.18.0","libp2p-webrtc-star":"^0.20.1","multihashing-async":"^2.0.1","interface-datastore":"^2.0.0","streaming-iterables":"^5.0.2","ipfs-unixfs-exporter":"^3.0.4","ipfs-unixfs-importer":"^4.0.0","native-abort-controller":"~0.0.3","timeout-abort-controller":"^1.1.1"},"typesVersions":{"*":{"*":["dist/*","dist/*/index"]}},"_hasShrinkwrap":false,"leadMaintainer":"Alex Potsides ","readmeFilename":"README.md","devDependencies":{"aegir":"^28.2.0","delay":"^4.4.0","sinon":"^9.0.3","nanoid":"^3.1.12","rimraf":"^3.0.2","go-ipfs":"^0.7.0","iso-url":"^1.0.0","ipld-git":"^0.6.1","ipfsd-ctl":"^7.0.2","typescript":"^4.0.3","interface-ipfs-core":"^0.142.1-rc.8+4921e9aa"},"_npmOperationalInternal":{"tmp":"tmp/ipfs-core_0.2.1-rc.8_1605523073150_0.014506582462224582","host":"s3://npm-registry-packages"},"_id":"ipfs-core@0.2.1-rc.8","version":"0.2.1-rc.8"}
![\"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