{"_id":"@apib/2me","_rev":"3-f3f79627d88d768e1f41ba6083eae785","name":"@apib/2me","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.1":{"name":"@apib/2me","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/apib-2me.git"},"gitHead":"f30cc2348c6ea7743527d103fcbb315e4d66dbae","_id":"@apib/2me@1.0.1","_npmVersion":"6.2.0","_nodeVersion":"10.8.0","_npmUser":{"name":"jchrisco","email":"connor.christie@jci.com"},"dist":{"integrity":"sha512-TwCT0pgJnhgATXFeMtfUXCn0lYlE3U6iGYHJeBGJFSadv0hNc+J9MXe+NeK+q1esvTwH38zsb5b9LiMEBuewww==","shasum":"18b584276a76b6070fe82e21caed2f95dd14b8a4","tarball":"https://registry.npmjs.org/@apib/2me/-/2me-1.0.1.tgz","fileCount":7,"unpackedSize":7769,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbbKk1CRA9TVsSAnZWagAAPSkP/3Onqvg4H00bcPlmtpvv\nBs0+2yotnmbz/7jzFBnroJm7aB6hH3tCFbbWxvdkGC+mCJ8TKjOE6fBlml11\nReVCCi6mKejxmDv5AU5pJhKgIHU946YFzfQ5Hk9GOH16onXhvw1OsFMSH2Xg\nS2slkPbjVGeXiG+ohyjE8IgVnEF86ne6qPaxQOJsfFIqCdMr4QLs672F60ig\nbRJHhroQ/8CxGJXP9k734z/T/Y1571YPPG5VfuVyg7VoeqOy0hQLOtkChlUp\nPQNk7aZ6Si5Es+t4DcOUm0+fiZUKF85cDKrfkoqFjU6e7xpCiaLFggdb5iyH\n0xkStJSWpcfyfjZCWxLW5TYNVQJaUvZSmRCCt3pY60BCqjjiKL30AOjuFP1l\nvI32pzHsgOcOqrVhBaRkk5DUYAKttjzgjcX3lkpw5HbiQ4L4Qje/QSTKyJ50\nIcQfTAFGAVOeonx5jCBisNvSD1rUjHfbT76rumRRzdq/0gct/E6o4UsOfw6V\nFvGSTHKb7Q3t/DRlT0xpsqrYwEiADUlF+LP8uqajwEi+07w+9BuKgAru6A8R\nS2auKctNOYE5cYP5HnoCK2dXm2oB3scwHD8V39xOFPwFoDIuggf3uvSIvYsf\nw38okqMmSTzW5InerUeUIzaeNPOA/MUC4aK6qOvIvj/d2Ggad/R0Y9jeAjK5\nEPzz\r\n=/grL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCjiTaArb1189csmrENOQIedQeeTIy1SR5vMO8B9s4vCQIhAOityWFnbjyYuUuPVQcqvEbD+TNhfSbIiOdReAptzdDB"}]},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/2me_1.0.1_1533847860957_0.4640757616888054"},"_hasShrinkwrap":false},"1.0.2":{"name":"@apib/2me","version":"1.0.2","description":"API Blueprint Fetcher and Publisher","author":{"name":"Johnson Controls, Plc."},"license":"MIT","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/apib-2me.git"},"gitHead":"22aec0bc2e08bb84ef00610921ba4ca564838cbe","_id":"@apib/2me@1.0.2","_npmVersion":"6.2.0","_nodeVersion":"10.8.0","_npmUser":{"name":"jchrisco","email":"connor.christie@jci.com"},"dist":{"integrity":"sha512-PLf03QjMPyZ9wd+YY+sWx45nZl9EzVdFwTlqBvkY8nHYAMw2qrrx/vhd0Z1wtiLUvhnT3Vu5a3kLFZkq+XMwhw==","shasum":"110715793eaccc13acd2df059f2ffc6000ca5690","tarball":"https://registry.npmjs.org/@apib/2me/-/2me-1.0.2.tgz","fileCount":7,"unpackedSize":7837,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbbKzyCRA9TVsSAnZWagAADN4P/ilOcOuguzCcxZu7nE4C\n6UxyOVdbQ5Hr1rIu0/S+ypni/3VKzJ+PevFIsV8Qw5AqGL7MORXVisOvp6Qr\nbvFFo9iDjDK+YKfpNMQhYYlQNb7/q2YOdzZyi/5V5ccE0qZkwRKnxcrXkX/i\nu7NnjA47CNPy8lGfkvK3iCFuf58jls6OAELrE3JegX3r0YOqk9EN7+RCWNE/\nr7iKGPgI22f050S7g15swW5yBeutOv81thGI+ccoldZa1Nw3R+xqJgn1PvY0\nQ1ZIqV4TUc0/bg8c98EINafAiWXTTTpmR0GBjgSt+O++JR05M9NqT+TlAI2Q\nje4KZqvP3xptJWQ+MEMPUa0G+N3SMC9trOvol0eu5Uql4NuZByvPMk7KAiL+\nK5C5pwbZiPcgJ48dPRK9NpLnkbYURlCEdEIDEBWkv4+jSQ6rMULHeWWrQQi1\nDkiNEQnqR346G6+4W9/oGiqWZpxi991jjrxLD49blQqb2wkCL7vBmEvz1yO4\nSJPRTLqRS4jdZfrsGnEdA6qa1lzWf8j+N6njXo7fJ3Ihbyof8O9EVpCKEJVX\nsF9MaCXukxomfD3BlY8FjZ/HWsd5c04lwqxuZ51HS5UwBSPUmMesoqAwVUOQ\nBz1KFluER74n1rZLmpLlTyQQpQ01Kz5GWnWD3IAp8xkvVmIusBENwghyTLij\nwfdN\r\n=85EM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGogwbju7v7iqThPcWxVTK/3hkjigUxeezcGhL9V9XFGAiBZp5jOh3ZT6jqaf8oXd2Ay7eTFNQjJXtaHx26QkFoBXA=="}]},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/2me_1.0.2_1533848814901_0.07057601742355457"},"_hasShrinkwrap":false},"1.0.3":{"name":"@apib/2me","version":"1.0.3","description":"API Blueprint Fetcher and Publisher","author":{"name":"Johnson Controls, Plc."},"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/apib-2me.git"},"gitHead":"22aec0bc2e08bb84ef00610921ba4ca564838cbe","_id":"@apib/2me@1.0.3","_npmVersion":"6.2.0","_nodeVersion":"10.8.0","_npmUser":{"name":"jchrisco","email":"connor.christie@jci.com"},"dist":{"integrity":"sha512-W+vdDCVGCEgpi/bZZaGZzG7fBpsoNSlFsD0RWafl9P+ArLrnDXyrA+AqKMvek40EoVxTEtvY37ztREpSPhTCxw==","shasum":"9276ef7e6f3a48da474b7eb131dd488d70535ff0","tarball":"https://registry.npmjs.org/@apib/2me/-/2me-1.0.3.tgz","fileCount":7,"unpackedSize":7863,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbbLLoCRA9TVsSAnZWagAAyUEQAJsSz5e8FgRq/uMMaij5\nWM9yCsS9+hSMZ/WKMnHszqlDUYVqyqiA7Orn7xeAJYVXqpP7px53y9Ug0Hf9\nhkZrhFgM091jpKZSvkEsE4gS0zl+dGf+wpTqIeAXy7l689jm3R+/KQF8h0pB\n/b4uoOl5QA9ZoqH7SQaXFqJth0EdMFcm538YDRj6hrQih50TPw48EIAmOV1f\nYMTjaQaZrfCcn/F6cpj8mpd6lNDEhXUM27ssXeVwWpBlMW6Ji75TcXMU0u3f\n27MSFC4DOHrWxnA4O34CFesQ6tx5ijzR8NEBCqbQRXqahJChWGaofF1oTcCM\ngRUUhaRA+0c4xj/7J8HZHxzluaX1Yxd0vFypweWIBrm61n9IxZ3C3kpoYicL\nyaY/X+Zl0yydu7aubqkbXgCA2Y3knn39YqSaqzyHVSpPp+Ybg66FXK7bR+6T\n3ugtI04wD5c68Q/oC9SpPIChhbK1Do5klnhsjBd6nOBR2Fpe/YBRuXvi0bxO\nGjppvFZ2LulelSsV2fC2LsKqVFX2Y/etXhzX3XcRYaMFS0K0bp5kGNMYjKyv\ndDJ1xeuPev1FgrD3170/gvy1bNbUl/Dx8lZOP/Xs9jsEFhBk0flwddJpHVdj\njUhxzf1IPUjoKZOuOW2pvAErYsvZoqg0nJNBzKN0yWCxoJIs7QL5+Ydf7tzW\nT9YE\r\n=U5Ds\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA3ttWIi9jZXkikKh+DyA9sOjJmx6BJj/F9qBlqFT17xAiBk0JnGvWmPQNT/QXCgJGat/AYWfeGHANmsSRvt7hXj0A=="}]},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/2me_1.0.3_1533850344413_0.34393691883912614"},"_hasShrinkwrap":false}},"time":{"created":"2018-08-09T20:51:00.813Z","1.0.1":"2018-08-09T20:51:01.020Z","modified":"2022-04-04T14:34:50.069Z","1.0.2":"2018-08-09T21:06:55.403Z","1.0.3":"2018-08-09T21:32:24.499Z"},"maintainers":[{"name":"jchrisco","email":"connor.christie@jci.com"}],"description":"API Blueprint Fetcher and Publisher","repository":{"type":"git","url":"git+git@github.jci.com:jchrisco/apib-2me.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## Quickstart\r\n1. Install the package globally\r\n    ```\r\n    npm i -g @apib/2me\r\n    ```\r\n\r\n2. Obtain a collection of [API blueprint](https://apiblueprint.org/) files which has includes and references other blueprint files. These includes may be specified using the following syntax:\r\n    ```markdown\r\n    <!-- include(other/file.apib) -->\r\n    ```\r\n\r\n    _Yes, you read correctly, it's just a comment with the word \"include\" inside!_\r\n\r\n3. Run the command to render a full api blueprint\r\n    ```\r\n    apib2me file -i index.md -o full-blueprint.apib\r\n    ```\r\n\r\n## Command Line Options\r\n```\r\napib2me <source:destination> [options]\r\n```\r\n\r\n* `<source:destination>`\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 <file-name>`, Output: `-o <file-name>` |\r\n      | apiary | Remote Apiary.io source | API Name: `-a <api-name>`, Access Token: `-k <token>` |\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>`, `--input <input>`\r\n\r\n    Specify a file to obtain the input blueprint from.\r\n\r\n* `-o <output>`, `--output <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 <api-name>`, `--apiName <api-name>`\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 <apiary-token>`, `--apiaryToken <apiary-token>`\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","author":{"name":"Johnson Controls, Plc."}}