{"bin":{"ipfs":"bin/ipfs"},"bugs":{"url":"https://github.com/ipfs/npm-go-ipfs/issues"},"dist":{"shasum":"8f1816ff79cefa029d582257cf02046ab7079cfa","tarball":"https://registry.npmjs.org/go-ipfs/-/go-ipfs-0.17.0-rc1.tgz","fileCount":14,"integrity":"sha512-MIFnIfduAhKP4ajxc+tdOQK5EYah7KtHO3pQ/vJQmI+s8GYOoed/szNI/RhddPReE5QCmi7BHYHRm6a/FhYk5g==","signatures":[{"sig":"MEUCIHcFdfczXTZkXW0Qk/gguW/8wHuQkKFfIZk7UEWgXe8sAiEA7NLA45ik3ofkQiwkLZAEVdNqV0NSH6W8ujgtlPDm7Rk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":19783,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjbX3sACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq04Q/7Bf4mhtsWDJ4UiL1S78oqE2A6ARRpzic7q2y842kuKOd7rcBP\r\nwi/4O3sJ+KGkzVmntMuQAUGfhY+8tW8QENt3dAAShBBFGqwiMi1F+cniVdK6\r\n7vMT0ms/QjXTjxgp3CZRusH8JSmJom+0RD1Dr8yIIWTCkEsxsDbINyrk98d8\r\nScmnSJuqriX3W+pYwLHS62UbW2NhjV47vluzqa1OVs7DAQpAqn0zmRRIB4KD\r\nSBtsGztzk5pA1EkpG5TtxINTeDakK/cGTVul4OZ1MUbq8h9iI48Eh6G3lTzq\r\noff1IhHLPr+2AxVlJNOVNBKrl2ePYpL3ZM1V6Jk5+ZHjCKbkdDa/D7dxUQX9\r\nTQ9AcnCRIQrCVKb/e7SnKJgvvOEk7eJaDh9AKnK6W7KcyxUII0epPrkzxM77\r\nYf29Da5eKHZIrUDFFePI76Np0BrblrTdreMEn+ZFhUMEutVyW5yMOoBtzd3N\r\nYCen1DeSSvjZ6ESPwXJ7pZbbZt0Nhaks26igplVzEz3vcgq5oget4AE4coiA\r\nIrJuD2IogzFsOFlMnrRBDETvaYIGF7HL3h3XdxPghyffRIgIKddN0bG+y4Ax\r\nUEOvi6AR/iEI/1EkmeAhfx74hcudbpen7CKdMQt59KWYncGCPfvCT+Um4E5H\r\nUpIUhNNNwIKPGYwl6yiKazn4JlR8zgGFMco=\r\n=E8QV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"src/index.js","name":"go-ipfs","types":"./dist/src/types.d.ts","author":{"name":"Protocol Labs, Inc."},"readme":"# npm-go-ipfs\n\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n\n> install [Kubo](https://github.com/ipfs/kubo) (previously known as \"go-ipfs\") from npm\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Development](#development)\n - [Publish a new version](#publish-a-new-version)\n- [Contribute](#contribute)\n- [License](#license)\n\n## Install\n\nInstall the latest [Kubo](https://github.com/ipfs/kubo/) (go-ipfs) binary:\n\n```sh\n# Install globally\n> npm install -g go-ipfs\n> ipfs version\nipfs version v0.7.0\n\n# Install locally\n> npm install go-ipfs\n> ./node_modules/.bin/ipfs\nipfs version v0.7.0\n```\n\n## Usage\n\nThis module downloads Kubo (go-ipfs) binaries from https://dist.ipfs.tech into your project.\n\nIt will download the go-ipfs version that matches the npm version of this module. So depending on `go-ipfs@0.7.0` will install `go-ipfs v0.7.0` for your current system architecture, in to your project at `node_modules/go-ipfs/go-ipfs/ipfs` and additional symlink to it at `node_modules/go-ipfs/bin/ipfs`.\n\nAfter downloading you can find out the path of the installed binary by calling the `path` function exported by this module:\n\n```javascript\nconst { path } = require('go-ipfs')\n\nconsole.info('go-ipfs is installed at', path())\n```\n\nAn error will be thrown if the path to the binary cannot be resolved.\n\n### Caching\n\nDownloaded archives are placed in OS-specific cache directory which can be customized by setting `NPM_GO_IPFS_CACHE` in env.\n\n## Development\n\n**Warning**: the file `bin/ipfs` is a placeholder, when downloading stuff, it gets replaced. so if you run `node install.js` it will then be dirty in the git repo. **Do not commit this file**, as then you would be commiting a big binary and publishing it to npm. A pre-commit hook exists and should protect against this, but better safe than sorry.\n\n### Publish a new version\n\nYou should be able to just run `./publish.sh` for example:\n\n```sh\n> ./publish.sh\nusage ./publish.sh \npublish a version of go-ipfs to npm\n\n> ./publish.sh 0.3.11\n```\n\nThis will:\n\n- check the version is indeed a tag in https://github.com/ipfs/kubo\n- check the size of `bin/ipfs` is right (must be the checked in file)\n- update the version numbers in `package.json` and `README.md`\n- `git commit` the changes\n- push to https://github.com/ipfs/npm-go-ipfs\n- publish to `go-ipfs@$version` to https://npmjs.com/package/go-ipfs\n\nOpen an issue in the repo if you run into trouble.\n\n### Publish a new version of this module with exact same go-ipfs version\n\nIf some problem happens, and you need to publish a new version of this module targetting _the same_ go-ipfs version, then please follow this convention:\n\n1. **Clean up bad stuff:** unpublish all modules with this exact same ``\n2. **Add a \"hacky\" version suffix:** use version: `-hacky`\n3. **Publish version:** publish the module. Since it's the only one with the go-ipfs version, then it should be installed.\n\n> Why do this?\n\nWell, if you previously published npm module `go-ipfs@0.4.0` and there was a problem, we now must publish a different version, but we want to keep the version number the same. so the strategy is to publish as `go-ipfs@0.4.0-hacky1`, and unpublish `go-ipfs@0.4.0`.\n\n> Why `-hacky`?\n\nBecause it is unlikely to be a legitimate go-ipfs version, and we want to support go-ipfs versions like `floodsub-1` etc.\n\n> Do i have to say `-hacky` or can i just use `-`?\n\n`-` won't work, as [link-ipfs.js](./link-ipfs.js) expects `-hacky`. If you want to\nchange the convention, go for it, and update this readme accordingly.\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/npm-go-ipfs/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)\n\n## License\n\n[MIT](LICENSE)\n","gitHead":"494605dfa4fef9d9d7e6532c19a3ac7cdfc8573a","license":"MIT","scripts":{"lint":"tsc --noEmit && standard","test":"tape test/*.js | tap-spec","postinstall":"node src/post-install.js","restore-bin":"git reset -- bin/ipfs && git checkout -- bin/ipfs","prepublishOnly":"tsc"},"_npmUser":{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"},"homepage":"https://github.com/ipfs/npm-go-ipfs","keywords":["ipfs","install"],"deprecated":"'go-ipfs' name has been deprecated. Please switch your dependency to 'kubo' - https://www.npmjs.com/package/kubo","pre-commit":"restore-bin","repository":{"url":"git+https://github.com/ipfs/npm-go-ipfs.git","type":"git"},"_npmVersion":"6.14.17","description":"Install the latest go-ipfs binary","directories":{},"maintainers":[{"name":"daviddias","email":"mail@daviddias.me"},{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":"alan138@gmail.com"},{"name":"olizilla","email":"oli@tableflip.io"},{"name":"lidel","email":"lidel@lidel.org"},{"name":"stebalien","email":"steven@stebalien.com"},{"name":"ipfsbot","email":"infra-accounts@protocol.ai"},{"name":"npm-service-account-ipfs","email":"npm-service-account+ipfs@protocol.ai"}],"_nodeVersion":"14.20.1","dependencies":{"got":"^11.7.0","hasha":"^5.2.2","tar-fs":"^2.1.0","cachedir":"^2.3.0","pkg-conf":"^3.1.0","gunzip-maybe":"^1.4.2","unzip-stream":"^0.3.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"tape":"^4.13.2","execa":"^4.0.1","fs-extra":"^9.0.0","standard":"^13.1.0","tap-spec":"^5.0.0","@types/got":"^9.6.12","pre-commit":"^1.2.2","typescript":"^4.3.5","tape-promise":"^4.0.0","@types/tar-fs":"^2.0.1","@types/gunzip-maybe":"^1.4.0","@types/unzip-stream":"^0.3.1"},"_npmOperationalInternal":{"tmp":"tmp/go-ipfs_0.17.0-rc1_1668120044525_0.4630824730806993","host":"s3://npm-registry-packages"},"_id":"go-ipfs@0.17.0-rc1","version":"0.17.0-rc1"}