\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## Getting Started\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-examples/js-ipfs-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- 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## Want to hack on IPFS?\n\n[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n\nThis 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\nFind out about chat channels, the IPFS newsletter, the IPFS blog, and more in the [IPFS community space](https://docs.ipfs.io/community/).\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","browser":{"go-ipfs":false,"./src/cli.js":false,"./src/path.js":"./src/path.browser.js"},"engines":{"npm":">=7.0.0","node":">=16.0.0"},"exports":{".":{"types":"./dist/src/index.d.ts","import":"./src/index.js"},"./path":{"types":"./src/path.d.ts","import":"./src/path.js","browser":"./src/path.browser.js"}},"gitHead":"81311d5fcc6a5512ed3414aa592bdc9e6c481b03","license":"Apache-2.0 OR MIT","scripts":{"lint":"aegir lint","build":"aegir build","clean":"aegir clean","dep-check":"aegir dep-check -i ipfs-core-types -i @types/*","test:interop":"cross-env DEBUG=$DEBUG IPFS_LOGGING=$IPFS_LOGGING IPFS_JS_EXEC=$PWD/src/cli.js KUBO_RPC_MODULE=$PWD/../ipfs-http-client/src/index.js LIBP2P_TCP_REUSEPORT=false ipfs-interop","test:external":"aegir test-dependant","prepublishOnly":"node scripts/update-version.js","test:interface:core":"aegir test -f test/interface-core.js","test:interface:client":"aegir test -f test/interface-client.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":"npm-service-account-ipfs","email":"npm-service-account+ipfs@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/6.0.3/node@v18.12.0+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":"hugomrdias@gmail.com"},{"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":"18.12.0","dependencies":{"wrtc":"^0.4.6","semver":"^7.3.2","ipfs-cli":"^0.15.1-6be59068.0","ipfs-core":"^0.17.1-6be59068.0","@libp2p/logger":"^2.0.0","electron-webrtc":"^0.3.0","update-notifier":"^6.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":{"url":"^0.11.0","aegir":"^37.0.11","go-ipfs":"^0.12.0","iso-url":"^1.0.0","cross-env":"^7.0.0","ipfsd-ctl":"^12.0.3","ipfs-utils":"^9.0.6","ipfs-client":"^0.9.3-6be59068.0","ipfs-interop":"github:ipfs/interop#deps/update-multiformats","@types/semver":"^7.3.4","merge-options":"^3.0.4","ipfs-core-types":"^0.13.1-6be59068.0","kubo-rpc-client":"^1.0.1","ipfs-http-client":"^59.0.1-6be59068.0","@libp2p/websockets":"^5.0.0","interface-ipfs-core":"^0.157.1-6be59068.0","@types/update-notifier":"^6.0.1","mock-ipfs-pinning-service":"^0.4.2","@libp2p/webrtc-star-signalling-server":"^2.0.1"},"optionalDependencies":{"wrtc":"^0.4.6","electron-webrtc":"^0.3.0"},"_npmOperationalInternal":{"tmp":"tmp/ipfs_0.65.1-6be59068.0_1668714491743_0.8380502472099665","host":"s3://npm-registry-packages"},"_id":"ipfs@0.65.1-6be59068.0","version":"0.65.1-6be59068.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\")
\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