{"_id":"cid-tool","_rev":"4634838","name":"cid-tool","description":"Convert and discover properties of CIDs","dist-tags":{"latest":"3.0.0"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"time":{"modified":"2026-04-10T19:11:23.000Z","created":"2018-09-12T16:07:26.819Z","3.0.0":"2021-04-08T11:25:51.823Z","2.0.0":"2021-04-08T11:19:50.561Z","1.0.0":"2020-08-19T10:33:52.432Z","0.4.1":"2020-05-07T09:04:56.712Z","0.4.0":"2019-11-25T16:19:16.805Z","0.3.0":"2019-05-09T15:47:43.198Z","0.2.0":"2018-11-22T16:17:45.039Z","0.1.0":"2018-09-13T15:35:01.353Z","0.0.1":"2018-09-12T16:07:26.819Z"},"users":{},"author":{"name":"Alan Shaw"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"versions":{"3.0.0":{"name":"cid-tool","version":"3.0.0","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test","build":"aegir build","lint":"aegir lint && aegir ts --check","release":"aegir release","release-minor":"aegir release --type minor","release-major":"aegir release --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"^1.0.0","explain-error":"^1.0.4","multibase":"^4.0.2","multihashes":"^4.0.2","split2":"^3.1.1","uint8arrays":"^2.1.3","yargs":"^16.2.0"},"devDependencies":{"@types/split2":"^2.1.6","aegir":"^33.0.0","execa":"^5.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Hugo Dias","email":"hugomrdias@gmail.com"},{"name":"achingbrain","email":"alex@achingbrain.net"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"homepage":"https://github.com/multiformats/js-cid-tool#readme","gitHead":"cec14f7db4d4914d1db1111284be7594ae75da89","_id":"cid-tool@3.0.0","_nodeVersion":"15.12.0","_npmVersion":"7.6.3","dist":{"shasum":"557540c5896d204503ef0ece848b88bbb350b90a","size":21901,"noattachment":false,"key":"/cid-tool/-/cid-tool-3.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-3.0.0.tgz"},"_npmUser":{"name":"alanshaw","email":"alan138@gmail.com"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_3.0.0_1617881151652_0.7114483248267816"},"_hasShrinkwrap":false,"publish_time":1617881151823,"_cnpm_publish_time":1617881151823,"_cnpmcore_publish_time":"2021-12-16T19:09:40.105Z"},"2.0.0":{"name":"cid-tool","version":"2.0.0","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test","build":"aegir build","lint":"aegir lint && aegir ts --check","release":"aegir release","release-minor":"aegir release --type minor","release-major":"aegir release --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"^1.0.0","explain-error":"^1.0.4","multibase":"^4.0.2","multihashes":"^4.0.2","split2":"^3.1.1","uint8arrays":"^2.1.3","yargs":"^16.2.0"},"devDependencies":{"@types/split2":"^2.1.6","aegir":"^33.0.0","execa":"^5.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Hugo Dias","email":"hugomrdias@gmail.com"},{"name":"Alex Potsides","email":"alex@achingbrain.net"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"homepage":"https://github.com/multiformats/js-cid-tool#readme","gitHead":"d72431bc55395f0539c77edb8cbbd38eca4e941d","_id":"cid-tool@2.0.0","_nodeVersion":"15.13.0","_npmVersion":"7.7.6","dist":{"shasum":"cce6c92c31924f985af3b2d0ce7fa14c0c71c58d","size":21664,"noattachment":false,"key":"/cid-tool/-/cid-tool-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-2.0.0.tgz"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_2.0.0_1617880790456_0.08127324679832237"},"_hasShrinkwrap":false,"publish_time":1617880790561,"_cnpm_publish_time":1617880790561,"_cnpmcore_publish_time":"2021-12-16T19:09:40.315Z"},"1.0.0":{"name":"cid-tool","version":"1.0.0","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test -t node","build":"aegir build","lint":"aegir lint","release":"aegir release -t node","release-minor":"aegir release -t node --type minor","release-major":"aegir release -t node --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"^1.0.0","explain-error":"^1.0.4","multibase":"^3.0.0","multihashes":"^3.0.1","split2":"^3.1.1","uint8arrays":"^1.1.0","yargs":"^15.0.2"},"devDependencies":{"aegir":"^25.1.0","execa":"^4.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Hugo Dias","email":"hugomrdias@gmail.com"},{"name":"achingbrain","email":"alex@achingbrain.net"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"homepage":"https://github.com/multiformats/js-cid-tool#readme","gitHead":"6774b447d49a14afc36acab0417ad4126f064847","_id":"cid-tool@1.0.0","_nodeVersion":"14.8.0","_npmVersion":"6.14.7","dist":{"shasum":"3d123c20f1dc9322331db86a0e4db8850e561649","size":27654,"noattachment":false,"key":"/cid-tool/-/cid-tool-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-1.0.0.tgz"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"_npmUser":{"name":"alanshaw","email":"alan138@gmail.com"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_1.0.0_1597833232295_0.8038105300316694"},"_hasShrinkwrap":false,"publish_time":1597833232432,"_cnpm_publish_time":1597833232432,"_cnpmcore_publish_time":"2021-12-16T19:09:40.564Z"},"0.4.1":{"name":"cid-tool","version":"0.4.1","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test -t node","build":"aegir build","lint":"aegir lint","release":"aegir release -t node","release-minor":"aegir release -t node --type minor","release-major":"aegir release -t node --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"~0.8.0","explain-error":"^1.0.4","multibase":"~0.7.0","multihashes":"~0.4.14","split2":"^3.1.1","yargs":"^15.0.2"},"devDependencies":{"aegir":"^21.10.2","chai":"^4.1.2","dirty-chai":"^2.0.1","execa":"^4.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Hugo Dias","email":"hugomrdias@gmail.com"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"homepage":"https://github.com/multiformats/js-cid-tool#readme","gitHead":"2df918dc8128ae443f7dff018ea4daf512cfc1ff","_id":"cid-tool@0.4.1","_nodeVersion":"12.16.2","_npmVersion":"6.14.4","dist":{"shasum":"90266766b73db6d08e332e30e47897e690ed733f","size":148259,"noattachment":false,"key":"/cid-tool/-/cid-tool-0.4.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-0.4.1.tgz"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"_npmUser":{"name":"hugomrdias","email":"mail@hugodias.me"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_0.4.1_1588842296558_0.9071584823326735"},"_hasShrinkwrap":false,"publish_time":1588842296712,"_cnpm_publish_time":1588842296712,"_cnpmcore_publish_time":"2021-12-16T19:09:41.445Z"},"0.4.0":{"name":"cid-tool","version":"0.4.0","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test -t node","build":"aegir build","lint":"aegir lint","release":"aegir release -t node","release-minor":"aegir release -t node --type minor","release-major":"aegir release -t node --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"~0.7.0","explain-error":"^1.0.4","multibase":"~0.6.0","multihashes":"~0.4.14","split2":"^3.1.1","yargs":"^15.0.2"},"devDependencies":{"aegir":"^20.4.1","chai":"^4.1.2","dirty-chai":"^2.0.1","execa":"^3.4.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Alan Shaw","email":"alan@tableflip.io"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"homepage":"https://github.com/multiformats/js-cid-tool#readme","gitHead":"56355393c673f32ea96d9175234765c9079a6c38","_id":"cid-tool@0.4.0","_nodeVersion":"12.13.1","_npmVersion":"6.12.1","_npmUser":{"name":"alanshaw","email":"alan138@gmail.com"},"dist":{"shasum":"99205b46db1e526b8333137c449a4e0c686b0c05","size":178332,"noattachment":false,"key":"/cid-tool/-/cid-tool-0.4.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-0.4.0.tgz"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_0.4.0_1574698756646_0.554713516735813"},"_hasShrinkwrap":false,"publish_time":1574698756805,"_cnpm_publish_time":1574698756805,"_cnpmcore_publish_time":"2021-12-16T19:09:41.957Z"},"0.3.0":{"name":"cid-tool","version":"0.3.0","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test -t node","build":"aegir build","lint":"aegir lint","release":"aegir release -t node","release-minor":"aegir release -t node --type minor","release-major":"aegir release -t node --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"~0.7.0","explain-error":"^1.0.4","multibase":"~0.6.0","multihashes":"~0.4.14","yargs":"^13.2.2"},"devDependencies":{"aegir":"^18.2.2","chai":"^4.1.2","dirty-chai":"^2.0.1","execa":"^1.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Alan Shaw","email":"alan@tableflip.io"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"homepage":"https://github.com/multiformats/js-cid-tool#readme","gitHead":"cbdc459499395a6b01167caf9e625d8966090058","_id":"cid-tool@0.3.0","_nodeVersion":"11.15.0","_npmVersion":"6.7.0","_npmUser":{"name":"alanshaw","email":"alan138@gmail.com"},"dist":{"shasum":"d785ea8bd971ff0822a2a34fa55dc069504344c3","size":183503,"noattachment":false,"key":"/cid-tool/-/cid-tool-0.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-0.3.0.tgz"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_0.3.0_1557416863041_0.47324728535321836"},"_hasShrinkwrap":false,"publish_time":1557416863198,"_cnpm_publish_time":1557416863198,"_cnpmcore_publish_time":"2021-12-16T19:09:43.025Z"},"0.2.0":{"name":"cid-tool","version":"0.2.0","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test -t node","build":"aegir build","lint":"aegir lint","release":"aegir release -t node","release-minor":"aegir release -t node --type minor","release-major":"aegir release -t node --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"~0.5.6","explain-error":"^1.0.4","multibase":"~0.6.0","multihashes":"~0.4.14","yargs":"^12.0.2"},"devDependencies":{"aegir":"^15.1.0","chai":"^4.1.2","dirty-chai":"^2.0.1","execa":"^1.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Alan Shaw","email":"alan@tableflip.io"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/multiformats/js-cid-tool.git"},"bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"homepage":"https://github.com/multiformats/js-cid-tool#readme","gitHead":"a3e4a5f4024073d1e832d9771b80307db7e14add","_id":"cid-tool@0.2.0","_npmVersion":"6.4.1","_nodeVersion":"11.1.0","_npmUser":{"name":"alanshaw","email":"alan138@gmail.com"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"dist":{"shasum":"cf1d2506f68c1da1a9d214760cc1fd5d0c2ddfc9","size":8827,"noattachment":false,"key":"/cid-tool/-/cid-tool-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-0.2.0.tgz"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_0.2.0_1542903464942_0.14590876969136524"},"_hasShrinkwrap":false,"publish_time":1542903465039,"_cnpm_publish_time":1542903465039,"_cnpmcore_publish_time":"2021-12-16T19:09:43.292Z"},"0.1.0":{"name":"cid-tool","version":"0.1.0","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test -t node","build":"aegir build","lint":"aegir lint","release":"aegir release -t node","release-minor":"aegir release -t node --type minor","release-major":"aegir release -t node --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"~0.5.3","explain-error":"^1.0.4","multibase":"~0.5.0","multihashes":"~0.4.14","yargs":"^12.0.2"},"devDependencies":{"aegir":"^15.1.0","chai":"^4.1.2","dirty-chai":"^2.0.1","execa":"^1.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan.shaw@protocol.ai"},{"name":"Alan Shaw","email":"alan@tableflip.io"}],"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/ipfs-shipyard/js-cid-tool.git"},"bugs":{"url":"https://github.com/ipfs-shipyard/js-cid-tool/issues"},"homepage":"https://github.com/ipfs-shipyard/js-cid-tool#readme","gitHead":"fb9d9302abcb65b26352e2a04ab614198dc224c2","_id":"cid-tool@0.1.0","_npmVersion":"6.4.1","_nodeVersion":"10.10.0","_npmUser":{"name":"alanshaw","email":"alan138@gmail.com"},"dist":{"shasum":"759728519efb52dac6d7ebe034bdac866787e2ce","size":8807,"noattachment":false,"key":"/cid-tool/-/cid-tool-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-0.1.0.tgz"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_0.1.0_1536852901197_0.2785857259260236"},"_hasShrinkwrap":false,"publish_time":1536852901353,"_cnpm_publish_time":1536852901353,"_cnpmcore_publish_time":"2021-12-16T19:09:43.531Z"},"0.0.1":{"name":"cid-tool","version":"0.0.1","description":"Convert and discover properties of CIDs","main":"src/index.js","bin":{"cid":"src/cli/bin.js"},"scripts":{"start":"node src/cli/bin.js","test":"aegir test -t node","build":"aegir build","lint":"aegir lint","release":"aegir release","release-minor":"aegir release --type minor","release-major":"aegir release --type major","coverage":"aegir coverage"},"keywords":["CID","multibase","multicodec","multihash","codec","util","tool"],"author":{"name":"Alan Shaw"},"license":"MIT","dependencies":{"cids":"~0.5.3","explain-error":"^1.0.4","multibase":"~0.5.0","multihashes":"~0.4.14","yargs":"^12.0.2"},"devDependencies":{"aegir":"^15.1.0","chai":"^4.1.2","dirty-chai":"^2.0.1","execa":"^1.0.0"},"contributors":[{"name":"Alan Shaw","email":"alan@tableflip.io"}],"gitHead":"3a08d6d33fa51fb8d54666b9087858754b55a391","_id":"cid-tool@0.0.1","_npmVersion":"6.4.1","_nodeVersion":"10.10.0","_npmUser":{"name":"alanshaw","email":"alan138@gmail.com"},"dist":{"shasum":"7a84194f339992d450385c3aaf25b5a29df3ffd3","size":92296,"noattachment":false,"key":"/cid-tool/-/cid-tool-0.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/cid-tool/download/cid-tool-0.0.1.tgz"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"alanshaw","email":""},{"name":"hugomrdias","email":"mail@hugodias.me"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cid-tool_0.0.1_1536768446703_0.21589349604217012"},"_hasShrinkwrap":false,"publish_time":1536768446819,"_cnpm_publish_time":1536768446819,"_cnpmcore_publish_time":"2021-12-16T19:09:43.881Z"}},"readme":"# CID Tool\n\n[![Build Status](https://travis-ci.org/multiformats/js-cid-tool.svg?branch=master)](https://travis-ci.org/multiformats/js-cid-tool) [![dependencies Status](https://status.david-dm.org/gh/multiformats/js-cid-tool.svg)](https://david-dm.org/multiformats/js-cid-tool) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n> A module and command line tool for converting, formatting and discovering properties of CIDs\n\n## Install\n\n* Install Node.js 8+\n\n```sh\nnpm install -g cid-tool # for command line usage\n# or\nnpm install cid-tool    # for programmatic usage\n```\n\n## Usage\n\n### CLI\n\n```console\n$ cid --help\ncid <command>\n\nCommands:\n  cid base32 [cids...]  Convert CIDs to base 32 CID version 1.\n  cid bases             List available multibase encoding names.\n  cid codecs            List available CID codec names.\n  cid format [cids...]  Format and convert a CID in various useful ways.\n  cid hashes            List available multihash hashing algorithm names.\n\nOptions:\n  --version  Show version number                                     [boolean]\n  --help     Show help                                               [boolean]\n```\n\n**Note**: help is also available for each command e.g. `cid format --help`\n\n#### Example\n\n```console\n$ cid base32 QmdnJHe9XKk6atRSqAq1SdCu12MMSKxSPC93EWngEDoypj\nbafybeihfofifyyrirgqad3de7nkyldbleo3awwv4ghbba4ipjqthk2nhaa\n\n$ cid bases --prefix\n0 base1\n1 base2\n7 base8\n9 base10\nf base16\nb base32\nc base32pad\nv base32hex\nt base32hexpad\nh base32z\nZ base58flickr\nz base58btc\nm base64\nM base64pad\nu base64url\nU base64urlpad\n\n$ cid codecs\nraw\nbase1\nbase2\nbase8\nbase10\ncbor\nprotobuf\n# ...\n\n$ cid format mAXASIOVxUFxiKImgAexk+1WFjCsjtgtavDHCEHEPTCZ1aacA -f \"%b CIDv%V %h\"\nbase64 CIDv1 sha2-256\n\n$ cid hashes\nid\nsha1\nsha2-256\nsha2-512\ndbl-sha2-256\nsha3-224\nsha3-256\nsha3-384\nsha3-512\nshake-128\nshake-256\nkeccak-224\n# ...\n```\n\n### Module\n\n```js\nconst CIDTool = require('cid-tool')\n// Then see API docs below...\n```\n\n## API\n\n### `CIDTool.base32(cid)`\n\nConvert the passed CID to base 32 CID version 1.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| cid | [`CID`](https://github.com/ipld/js-cid/)\\|`String`\\|`Uint8Array` | CID to convert. |\n\n#### Returns\n\n| Type | Description |\n|------|-------------|\n| `String` | Base 32 encoded version 1 CID |\n\n#### Example\n\n```js\n> CIDTool.base32('QmdnJHe9XKk6atRSqAq1SdCu12MMSKxSPC93EWngEDoypj')\n'bafybeihfofifyyrirgqad3de7nkyldbleo3awwv4ghbba4ipjqthk2nhaa'\n```\n\n### `CIDTool.bases()`\n\nList available [multibase encoding name and code pairs](https://github.com/multiformats/multibase/blob/master/multibase.csv).\n\n#### Returns\n\n| Type | Description |\n|------|-------------|\n| `Array<{name<String>, code<String>}>` | Multibase encoding name and code pairs |\n\n#### Example\n\n```js\n> CIDTool.bases()\n[ { name: 'base1', code: '0' },\n  { name: 'base2', code: '1' },\n  { name: 'base8', code: '7' },\n  { name: 'base10', code: '9' },\n  { name: 'base16', code: 'f' },\n  { name: 'base32', code: 'b' },\n  { name: 'base32pad', code: 'c' },\n  { name: 'base32hex', code: 'v' },\n  { name: 'base32hexpad', code: 't' },\n  { name: 'base32z', code: 'h' },\n  { name: 'base58flickr', code: 'Z' },\n  { name: 'base58btc', code: 'z' },\n  { name: 'base64', code: 'm' },\n  { name: 'base64pad', code: 'M' },\n  { name: 'base64url', code: 'u' },\n  { name: 'base64urlpad', code: 'U' } ]\n```\n\n### `CIDTool.codecs()`\n\nList available [CID codec name and code pairs](https://github.com/multiformats/multicodec/blob/master/table.csv).\n\n#### Returns\n\n| Type | Description |\n|------|-------------|\n| `Array<{name<String>, code<Number>}>` | CID codec name and code pairs |\n\n#### Example\n\n```js\n> CIDTool.codecs()\n[ { name: 'raw', code: 85 },\n  { name: 'base1', code: 1 },\n  { name: 'base2', code: 0 },\n  { name: 'base8', code: 7 },\n  { name: 'base10', code: 9 },\n  { name: 'cbor', code: 81 },\n  { name: 'protobuf', code: 80 },\n  /* ... */ ]\n```\n\n### `CIDTool.format(cid, [options])`\n\nFormat and convert a CID in various useful ways.\n\n#### Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| cid | [`CID`](https://github.com/ipld/js-cid/)\\|`String`\\|`Uint8Array` | CID to format |\n| options | `Object` | (optional) options for formatting |\n| options.format | `String` | Format string to use, default \"%s\" |\n| options.base | `String` | Multibase name or code to use for output |\n| options.cidVersion | `Number` | Convert the CID to the given version if possible |\n\nAvailable format specifiers:\n\n* %% literal %\n* %b multibase name\n* %B multibase code\n* %v version string\n* %V version number\n* %c codec name\n* %C codec code\n* %h multihash name\n* %H multihash code\n* %L hash digest length\n* %m multihash encoded in base %b (with multibase prefix)\n* %M multihash encoded in base %b without multibase prefix\n* %d hash digest encoded in base %b (with multibase prefix)\n* %D hash digest encoded in base %b without multibase prefix\n* %s cid string encoded in base %b (1)\n* %S cid string encoded in base %b without multibase prefix\n* %P cid prefix: %v-%c-%h-%L\n\n(1) For CID version 0 the multibase must be base58btc and no prefix is used. For Cid version 1 the multibase prefix is included.\n\n#### Returns\n\n| Type | Description |\n|------|-------------|\n| `String` | Formatted string |\n\n#### Example\n\n```js\n> CIDTool.format('QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn', { format: '%b-%v-%c-%h-%L' })\n'base58btc-cidv0-dag-pb-sha2-256-32'\n\n> CIDTool.format('QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn', { cidVersion: 1 })\n'zdj7WbTaiJT1fgatdet9Ei9iDB5hdCxkbVyhyh8YTUnXMiwYi'\n\n> CIDTool.format('zdj7WksYf5DNoDhTbjNZundK13TdEYo9sNaFWYZuKBM3fNszf', { base: 'base64' })\n'mAXASIOVxUFxiKImgAexk+1WFjCsjtgtavDHCEHEPTCZ1aacA'\n```\n\n### `CIDTool.hashes()`\n\nList available [multihash hashing algorithm name and code pairs](https://github.com/multiformats/multihash/blob/master/hashtable.csv).\n\n#### Returns\n\n| Type | Description |\n|------|-------------|\n| `Array<{name<String>, code<Number>}>` | Multihash hashing algorithm name and code pairs |\n\n#### Example\n\n```js\n> CIDTool.hashes()\n[ { name: 'id', code: 0 },\n  { name: 'sha1', code: 17 },\n  { name: 'sha2-256', code: 18 },\n  { name: 'sha2-512', code: 19 },\n  { name: 'dbl-sha2-256', code: 86 },\n  { name: 'sha3-224', code: 23 },\n  { name: 'sha3-256', code: 22 },\n  /* ... */ ]\n```\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/multiformats/cid-tool/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\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\nCopyright (c) Protocol Labs, Inc. under the **MIT License**. See [LICENSE](./LICENSE) for details.\n","_attachments":{},"homepage":"https://github.com/multiformats/js-cid-tool#readme","bugs":{"url":"https://github.com/multiformats/js-cid-tool/issues"},"license":"MIT"}