{"bin":{"ipfs":"bin/ipfs"},"bugs":{"url":"https://github.com/ipfs/npm-go-ipfs/issues"},"dist":{"shasum":"d2036357b463c4d622feb59fc582b96b99c0f13e","tarball":"https://registry.npmjs.org/go-ipfs/-/go-ipfs-0.12.0-rc1.tgz","fileCount":13,"integrity":"sha512-ZsWlKIrnJtaECsm6IETmIPEqmHxJZnlsRMbo4xBtKFRL9+jF91jQVUYia+qbMe5ZwRx2ov1rezBzMc18edqTsQ==","signatures":[{"sig":"MEQCIEkMVDs9T5tBuMEPfXVDqDKuvwZbDVnoBTEhQxtGBJ5UAiApPI64p0vwiC+/Od/5QoL1lHqa7WfSwD+hQX/cT2B4QA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":19639,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJht/nTCRA9TVsSAnZWagAAxzEP/RsobEWOT6vUOm4LcL74\nj9jKNy/MlTi0AJONaxr9+qXnXu1lvVOG6JEP2VauKbEaofXRlyB+WJ2lkcY5\nQRKEbGLAsuq2LXKxUWqcuyEzVnQS6ZdGor4SQYadWfn6Ej+jjrj74hPu82JJ\nhlNEIgi2MpvSaA8jrw5oop4z+omP2enwaaj3Owqq0JmWU4dhEoq3SXn0NIlQ\nVKnOwglAdFvQm36kwodFmUBUUfJlL27dWhMFbFQb0K65FqNgkPJe0/AsVD8y\n8aDDJAEddRjyFJikAUs3Z4qUyoFB9tUmNPJQKbVnIs9EeM8v+Ym3yuiY20fy\nSkJri/ZS8Gi23rbiQQeNBA0CHNGeYWZlDV6jww7ahyektBzCfIQvsWeXgr8T\nfZm24yMupB+D+FRSJWbxKCmWlye4LnojfdlIenidilGGQioe7frkwmU2QRhz\nSvSNEytFpDsE/D7UTCJjEaY7IphSW2rSQfT7kQvDSccc0ns59K3omM6RcrnP\nF37Rv1HxTnbzOa4XLGaz5T20JgcUCYeaxuWPT4V3r7++Dx8krAD9mYZQK68k\nZZsl70hXvxleTazEFSjqaYI1aTvXBWLdoVhNFJ8+UXLzT+BaGDp+VWQoTJ1+\nRmSctPqzmYOAwGb/TX5R3f74StiphBbm85Pl+VTaWqBN0enq7m6hBpqWCfA/\nC7+j\r\n=1knH\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/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![Dependency Status](https://david-dm.org/ipfs/npm-go-ipfs.svg?style=flat-square)](https://david-dm.org/ipfs/npm-go-ipfs)\n\n> install 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 [go-ipfs](https://github.com/ipfs/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 `go-ipfs` binaries from https://dist.ipfs.io 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/go-ipfs\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":"269d83acb6429c3d10ad26c38d111dde3322e1e0","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":"ipfsbot","email":"infra-accounts@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.15","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":"stebalien","email":"steven@stebalien.com"},{"name":"ipfsbot","email":"infra-accounts@protocol.ai"}],"_nodeVersion":"14.18.2","dependencies":{"got":"^11.7.0","hasha":"^5.2.2","tar-fs":"^2.1.0","cachedir":"^2.3.0","pkg-conf":"^3.1.0","go-platform":"^1.0.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.12.0-rc1_1639446995022_0.42454031588956465","host":"s3://npm-registry-packages"},"_id":"go-ipfs@0.12.0-rc1","version":"0.12.0-rc1"}