{"_id":"@apib2/me","_rev":"2-9403063f92d3c3a0072fa0eb66916f4a","name":"@apib2/me","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@apib2/me","version":"1.0.0","description":"API Blueprint Fetcher and Publisher","license":"MIT","dependencies":{"apib-include-directive":"^0.1.0","nopt":"^4.0.1","request":"^2.87.0"},"bin":{"apib2me":"./bin/apib2me.js"},"repository":{"type":"git","url":"git+git@github.jci.com:jchrisco/apib2.git"},"_id":"@apib2/me@1.0.0","_npmVersion":"5.6.0","_nodeVersion":"8.11.3","_npmUser":{"name":"jchrisco","email":"connor.christie@jci.com"},"dist":{"integrity":"sha512-ij8bi7ScINsAveGHo36t34YUTFZq3/HX1azcJCATFXv9qF1ogc8dtGcZR+Wq8W+46jzC5aM+yWRDMES/267KSA==","shasum":"4c3d0b21d251d9cab1f3fdb5189a0458cecbf5ff","tarball":"https://registry.npmjs.org/@apib2/me/-/me-1.0.0.tgz","fileCount":9,"unpackedSize":152955,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbYyYQCRA9TVsSAnZWagAAinIP/30C1LDzVpnH06Y2FUBN\ni0AePk5OAB8BHTBxgCXAhSevY7sZSDCqViPd7ZARH4fYSa2zs75HtNSO4oq4\nHhQQVc2FoPjkIyEsexlAzJyrs1uNUxqgqShotn7cxAJ72rNtxFND4zgKGa4J\nRKy4yh2zOl88pyIBknU9SvQ3TTFUaj8F3azc4NcV2F5Oro30V1zng4JfM9Ru\nMdsRORGSBl3vg9GyfsWAsHYEmC0Tb9PBYTHdarFJaEqzjtscHmvKtk6UBU0O\nqJK3cAXEvSadUzEL76ewbM/wOyMoRmsnMYoYvmfd5QU0DS3Vaz5C7KoSapC2\nuO1Y90jM4BTFrt2dZUlmqlnCH8e469Mm6IawQudYhaEGWPx3XnjIely+N4M5\nevJQO56MhE0/hZLu/VbX75/71OcdjAx/iUX01528Y4zOe+vgzSvph/NBm4W4\nnQ0f2oI/sAZjvR9/sAQYPcCvimt3j8oN5c3VIYTVtUaeEdTvtQT3OpaqgugL\nG0LewMFkYnm0mA2+92pDjS01pSU5/bapNGrKSZqusFZuymTM5DRNXS+eZg41\nh23v5JtmqTu/0rQULP+crckbv+qBbt/9uOvWuOnJF7wKYVF2+j8umlSmEg95\na9joL1FpnTk0akN1sOjlw7zN/4jjpzc6muRUh0U1hwVtX70QTPSpWMLJozIu\njjWD\r\n=ogRB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAfRzty60bPhZ9jlfZXC88uaW6Gtx8L7LDaCe+xKO8uLAiB2mLl9gkCYloVkW+e1b/+jOZ4AfOKWB1QEWwQYdA7CTA=="}]},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/me_1.0.0_1533224464350_0.9044254016975248"},"_hasShrinkwrap":false},"1.0.1":{"name":"@apib2/me","version":"1.0.1","description":"API Blueprint Fetcher and Publisher","license":"MIT","main":"src/index.js","dependencies":{"apib-include-directive":"^0.1.0","concat-stream":"^1.6.2","nopt":"^4.0.1","request":"^2.87.0","string-to-stream":"^1.1.1","through2":"^2.0.3"},"bin":{"apib2me":"./bin/apib2me.js"},"repository":{"type":"git","url":"git+git@github.jci.com:jchrisco/apib2.git"},"_id":"@apib2/me@1.0.1","_npmVersion":"5.6.0","_nodeVersion":"8.11.3","_npmUser":{"name":"jchrisco","email":"connor.christie@jci.com"},"dist":{"integrity":"sha512-MWkuSpTukIXocwXiRZzVmRA+Or0BZ5kJDEMIBSYA19Lv5DrZoxhbzYoyAwuXh/m6hywEB9NK+V3xu2yOpPDL0g==","shasum":"ae9adbbe665e15ad1e2a1a1d1e10c00f42f4688c","tarball":"https://registry.npmjs.org/@apib2/me/-/me-1.0.1.tgz","fileCount":9,"unpackedSize":157775,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbZIBgCRA9TVsSAnZWagAA6E8P/AxCw3xsrxJHLeEkuEAz\nL0Uuz/EBOUfoyM5cZo4aFOvqrHrLhTqDJqQ/l2WILBs2LfcuRug8sivt8goF\nwtKrRIQWkZiKA6sEZx+3isHGOMHoE/iZx0a3RKNmHU1VDO0mpl7AOpk/AtuF\nUoIDC8N9moP3VBHEU+DgDvP3piHGQErs7zqYfXSJczsWP2KNMt/Tl4r2dUqw\n+J3OQCZJ/7ZdcGUZfoU+I2fcbmEXXEi3zwelYEG8y77gRAgbgnSU7yZBBQkq\nwebWxSkz8R0ACS78DVshM9LaPkCp0qVcuq5lqEF4HE3cghEFzR9Dz1sDmRto\n+ZdAP0OuCFwy0Fg+P8FMRNzx05rWTYzien5vKY5FE5pTUEftoXG5k2lKTpTb\nDj2AyzTmHDWxYgIRmS46gT6h/lI4KYfcnNDGMpN2vPJbL8s75sEwzWb5Dc4f\nqSWYEtAodTnYIALIen/sppGaY8OIfUiMAdoAcynWqG8Y0xbtl12TlHMhI96v\nG9Bas1D1egAxJFfxVdSpZgucLxOlsl8+fV4tNyh3o+ehNGw/QerFj1xAkUfJ\nQqw71NAf4tUgMvKxYVKiltlklC1ktaCVt8IzuKeAuJ+YJVPcaaKk7XUnmhon\nZ1WlNJIxwOu/KMx7JDrIfcc0L+11jFei8wMJ0gQj9DpvrLW/+rmRr/tAEgZ/\nTegH\r\n=Fftn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHlCD1M4GkFHJFkBRS9INdhztTdNu4Nublu6T9scTkM8AiEAh42HZ7j/rYEnsLldnoAzkR31AzRsqt7edE6lEgXlMGw="}]},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/me_1.0.1_1533313120361_0.7242474955017486"},"_hasShrinkwrap":false}},"time":{"created":"2018-08-02T15:41:04.166Z","1.0.0":"2018-08-02T15:41:04.450Z","modified":"2022-04-04T14:34:51.791Z","1.0.1":"2018-08-03T16:18:40.464Z"},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"description":"API Blueprint Fetcher and Publisher","repository":{"type":"git","url":"git+git@github.jci.com:jchrisco/apib2.git"},"license":"MIT","readme":"# API Blueprint to Me\r\nProcesses API Blueprints both locally and remotely. Useful for pre-processing blueprints which have includes in them and then publishing them to Apiary for example.\r\n\r\n## Quick Start\r\n1. Install the package globally\r\n ```\r\n npm i -g @apib2/me\r\n ```\r\n\r\n## Command Line Options\r\n```\r\napib2me [options]\r\n\r\nor\r\n\r\nnode ./bin/apib2me.js [options]\r\n```\r\n\r\n* ``\r\n\r\n - Possible values:\r\n\r\n | Name | Description | Parameters |\r\n | ---- | ----------- | ---------- |\r\n | file | Describes a local file source | Input: `-i `, Output: `-o ` |\r\n | apiary | Remote Apiary.io source | API Name: `-a `, Access Token: `-k ` |\r\n\r\n - The `source` is where the API Blueprint is obtained from.\r\n - The `destination` is where the processed blueprint is saved.\r\n\r\n* `-i `, `--input `\r\n\r\n Specify a file to obtain the input blueprint from.\r\n\r\n* `-o `, `--output `\r\n\r\n Default `stdout`\r\n\r\n Specify a file for where the processed output will be saved.\r\n\r\n* `-a `, `--apiName `\r\n\r\n Specify the Apiary api name for your project.\r\n\r\n Also known as the API Domain, e.x. api-name.docs.apiary.io\r\n\r\n* `-k `, `--apiaryToken `\r\n\r\n Specify the Apiary token which has access to read and write to your API.\r\n\r\n Can be obtained from your API settings within Apiary.\r\n\r\n### Example Commands\r\n\r\n#### Processing a blueprint locally and saving to a new file\r\nWithout specifying both an input and destination, the source will be interpreted as both being the same source.\r\n```\r\napib2me file -i input-blueprint.md -o output.md\r\n```\r\n\r\n#### Saving a blueprint from Apiary\r\n```\r\napib2me apiary:file -a apiname -k apiarytoken -o output-file.apib\r\n```\r\n\r\n#### Publishing a blueprint to Apiary\r\n```\r\napib2me file:apiary -a apiname -k apiarytoken -i api-blueprint.apib\r\n```\r\n","readmeFilename":"README.md"}