{"_id":"@airondev/paystack-cli","_rev":"2-dd0bd4833f0c778c7f4af8b3aebc1b07","name":"@airondev/paystack-cli","description":"Set up, test, and manage your paystackcli integration directly from the terminal.","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@airondev/paystack-cli","version":"1.0.0","keywords":["paystackcli","oclif"],"author":{"name":"Lukman Bello @lukman-paystack"},"license":"MIT","_id":"@airondev/paystack-cli@1.0.0","homepage":"https://github.com/airondev/paystack-cli","bugs":{"url":"https://github.com/airondev/paystack-cli/issues"},"bin":{"paystackcli":"bin/run"},"dist":{"shasum":"70f1c92f3e31110b63450d4f59c01b7d940b5f6f","tarball":"https://registry.npmjs.org/@airondev/paystack-cli/-/paystack-cli-1.0.0.tgz","fileCount":38,"integrity":"sha512-dNz/+T3jqEgLAqbrYRrq54S1T9PYdZBoheVwMnlZGrcaZWfJxqyPCUSNyKuuOIqXFVZtDetK7Nk23ceYuVgS5g==","signatures":[{"sig":"MEQCIAk7jB0V5WkTDval/UJwuKnxF55WdMFBxUsp3/6C2dKtAiARNl1f8u8HeT+f2MiCdYtRmuBDRxg/moATNxGRrnur1g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":160298},"main":"src/index.js","oclif":{"bin":"paystackcli","macos":{"identifier":"com.paystackcli.cli"},"plugins":["@oclif/plugin-help","@oclif/plugin-update","@oclif/plugin-not-found","@oclif/plugin-autocomplete","@oclif/plugin-version"],"commands":"./src/commands","topicSeparator":" ","additionalHelpFlags":["-h"],"additionalVersionFlags":["-v"]},"engines":{"node":">=8.0.0"},"gitHead":"54f2d686d0bdd20940cb76e30a3160b4dc92dbbb","scripts":{"test":"echo NO TESTS","prepack":"oclif-dev manifest","version":"oclif-dev readme && git add README.md","postpack":"rm -f oclif.manifest.json","posttest":"eslint ."},"_npmUser":{"name":"airondev","email":"airondev@gmail.com"},"repository":{"url":"git+https://github.com/airondev/paystack-cli.git","type":"git"},"_npmVersion":"10.2.4","description":"Set up, test, and manage your paystackcli integration directly from the terminal.","directories":{},"_nodeVersion":"20.11.0","dependencies":{"axios":"^0.21.4","lowdb":"^1.0.0","ngrok":"^5.0.0-beta.2","shelljs":"^0.8.4","platform":"^1.3.6","readline":"^1.3.0","pusher-js":"^7.0.3","node-fetch":"^3.3.2","@oclif/core":"^1","@oclif/config":"^1.17.0","readline-sync":"^1.4.10","@oclif/command":"^1.8.0","@oclif/plugin-help":"^5","@oclif/plugin-update":"^3.0.0","@oclif/plugin-plugins":"^2.0.1","@oclif/plugin-version":"^1","@oclif/plugin-not-found":"^2.3.1","@oclif/plugin-autocomplete":"^0.3.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.9.0","globby":"^10.0.2","@oclif/dev-cli":"^1.26.0","eslint-config-oclif":"^3.1.0"},"_npmOperationalInternal":{"tmp":"tmp/paystack-cli_1.0.0_1719586594659_0.2779600993462463","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@airondev/paystack-cli","version":"1.0.1","keywords":["paystackcli","oclif"],"author":{"name":"Lukman Bello @lukman-paystack"},"license":"MIT","_id":"@airondev/paystack-cli@1.0.1","homepage":"https://github.com/airondev/paystack-cli","bugs":{"url":"https://github.com/airondev/paystack-cli/issues"},"bin":{"paystackcli":"bin/run"},"dist":{"shasum":"8978c18c74ade1c9cfb8fa21209b55e884b1476e","tarball":"https://registry.npmjs.org/@airondev/paystack-cli/-/paystack-cli-1.0.1.tgz","fileCount":39,"integrity":"sha512-3Zt636pP7ptgnY0RxZOaAkKabx2brRGe2bhCtQ4v4tt4N9UftWD8MKKuPKDOXbaK88Q/puHr5HvqgykuLS3LdA==","signatures":[{"sig":"MEQCICoPXtPI1gLT8drwtJBEEDGW6i4+CzFTRzC32B+pjJIjAiAxC0jLnNl3GNbUhZWtzywUrFUo97rOBev3KxdviEz+1w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":161207},"main":"src/index.js","oclif":{"bin":"paystackcli","macos":{"identifier":"com.paystackcli.cli"},"plugins":["@oclif/plugin-help","@oclif/plugin-update","@oclif/plugin-not-found","@oclif/plugin-autocomplete","@oclif/plugin-version"],"commands":"./src/commands","topicSeparator":" ","additionalHelpFlags":["-h"],"additionalVersionFlags":["-v"]},"engines":{"node":">=8.0.0"},"gitHead":"54f2d686d0bdd20940cb76e30a3160b4dc92dbbb","scripts":{"test":"echo NO TESTS","prepack":"oclif-dev manifest","version":"oclif-dev readme && git add README.md","postpack":"rm -f oclif.manifest.json","posttest":"eslint ."},"_npmUser":{"name":"airondev","email":"airondev@gmail.com"},"repository":{"url":"git+https://github.com/airondev/paystack-cli.git","type":"git"},"_npmVersion":"10.2.4","description":"Set up, test, and manage your paystackcli integration directly from the terminal.","directories":{},"_nodeVersion":"20.11.0","dependencies":{"axios":"^0.21.4","lowdb":"^1.0.0","ngrok":"^5.0.0-beta.2","shelljs":"^0.8.4","platform":"^1.3.6","readline":"^1.3.0","pusher-js":"^7.0.3","node-fetch":"^3.3.2","@oclif/core":"^1","@oclif/config":"^1.17.0","readline-sync":"^1.4.10","@oclif/command":"^1.8.0","@oclif/plugin-help":"^5","@oclif/plugin-update":"^3.0.0","@oclif/plugin-plugins":"^2.0.1","@oclif/plugin-version":"^1","@oclif/plugin-not-found":"^2.3.1","@oclif/plugin-autocomplete":"^0.3.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.9.0","globby":"^10.0.2","@oclif/dev-cli":"^1.26.0","eslint-config-oclif":"^3.1.0"},"_npmOperationalInternal":{"tmp":"tmp/paystack-cli_1.0.1_1719602795830_0.8840826895012353","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@airondev/paystack-cli","description":"Set up, test, and manage your paystackcli integration directly from the terminal.","version":"1.0.2","author":{"name":"Lukman Bello @lukman-paystack"},"bin":{"paystackcli":"bin/run"},"bugs":{"url":"https://github.com/airondev/paystack-cli/issues"},"dependencies":{"@oclif/command":"^1.8.0","@oclif/config":"^1.17.0","@oclif/core":"^1","@oclif/plugin-autocomplete":"^0.3.0","@oclif/plugin-help":"^5","@oclif/plugin-not-found":"^2.3.1","@oclif/plugin-plugins":"^2.0.1","@oclif/plugin-update":"^3.0.0","@oclif/plugin-version":"^1","axios":"^0.21.4","lowdb":"^1.0.0","ngrok":"^5.0.0-beta.2","node-fetch":"^3.3.2","platform":"^1.3.6","pusher-js":"^7.0.3","readline":"^1.3.0","readline-sync":"^1.4.10","shelljs":"^0.8.4"},"devDependencies":{"@oclif/dev-cli":"^1.26.0","eslint":"^8.9.0","eslint-config-oclif":"^3.1.0","globby":"^10.0.2"},"engines":{"node":">=8.0.0"},"homepage":"https://github.com/airondev/paystack-cli","keywords":["paystackcli","oclif"],"license":"MIT","main":"src/index.js","oclif":{"macos":{"identifier":"com.paystackcli.cli"},"commands":"./src/commands","topicSeparator":" ","additionalHelpFlags":["-h"],"additionalVersionFlags":["-v"],"bin":"paystackcli","plugins":["@oclif/plugin-help","@oclif/plugin-update","@oclif/plugin-not-found","@oclif/plugin-autocomplete","@oclif/plugin-version"]},"repository":{"type":"git","url":"git+https://github.com/airondev/paystack-cli.git"},"scripts":{"postpack":"rm -f oclif.manifest.json","posttest":"eslint .","prepack":"oclif-dev manifest","test":"echo NO TESTS","version":"oclif-dev readme && git add README.md"},"_id":"@airondev/paystack-cli@1.0.2","gitHead":"9bddd03ecb6e20ee6fd419e2fb695066a56ea342","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-aWIkQ/hMiH55f5YGsXN/F6SeG9de/z7t/XQ7rJHnPmMKW+p55TkzRtm/ae9RvXIomQquduSbc+DEQUOuJ/zxKQ==","shasum":"35099cb6c979d40bc32385d3fd7f6f4f971b3ccf","tarball":"https://registry.npmjs.org/@airondev/paystack-cli/-/paystack-cli-1.0.2.tgz","fileCount":39,"unpackedSize":161306,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDh/LKsFt2EIdOcJRmDh40JjroK5c6dWLbu+HUjU6bGAQIgO0pKAkJVZaE/MUR0jrsH3AD+w48sr4Gw9a4nBtyGmtY="}]},"_npmUser":{"name":"airondev","email":"airondev@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/paystack-cli_1.0.2_1719604240687_0.03312014411957298"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-28T14:56:34.559Z","modified":"2024-06-28T19:50:41.050Z","1.0.0":"2024-06-28T14:56:34.877Z","1.0.1":"2024-06-28T19:26:36.010Z","1.0.2":"2024-06-28T19:50:40.866Z"},"maintainers":[{"name":"airondev","email":"airondev@gmail.com"}],"author":{"name":"Lukman Bello @lukman-paystack"},"repository":{"type":"git","url":"git+https://github.com/airondev/paystack-cli.git"},"keywords":["paystackcli","oclif"],"license":"MIT","homepage":"https://github.com/airondev/paystack-cli","bugs":{"url":"https://github.com/airondev/paystack-cli/issues"},"readme":"\n# dev-cli\n\n\n[![Paystack Logo](https://res.cloudinary.com/drps6uoe4/image/upload/c_scale,w_200/v1584835701/Paystack-CeruleanBlue-StackBlue-HL_2_neik7g.png)](https://paystack.com)\n\n\nThe Paystack CLI helps you build, test, and manage your Paystack integration right from the terminal.\n\nWith the Paystack CLI, you can:\n\nSecurely test webhooks without relying on third-party tunneling software\nTrigger webhook events to easily test your integration\nCreate, retrieve, update, and delete API objects\nClone real life sample applications with fully integrated payment channels.\n\n\nAnd of course the Paystack CLI is open source with a [public repository](https://github.com/lukman-paystack/paystack-cli)\n on GitHub. Contributions, features, sample apps from developers are encouraged.\n\n## Installation\n\nPaystack requires [Node.js](https://nodejs.org/) v12+ to run.\n\nInstall the dependencies and devDependencies and start the instance.\n\n```sh\n$ npm install -g @airondev/paystack-cli\n$ paystackcli\n$ login\n```\n\n\n## Get started\n\n### API\n\nPaystack CLI allows you to make API calls to the Paystack API right from the terminal, for example to initialize a transaction, run \n\n```sh\n$ transaction initialize --amount 1000 --email customer@email.com\n```\nThe terminal's output would look like this \n\n```sh\nauthorization_url - - - -- - -- - - - - - -  - - - -  - https://checkout.paystack.com/9wvzhxlk66uylzp\naccess_code - - - -- - -- - - - - - -  - - - -  - 9wvzhxlk66uylzp\nreference - - - -- - -- - - - - - -  - - - -  - se8b1ty80b\n```\n\n#### Another example\n\n```sh\n$ transaction verify --reference T394541625653843 --domain live\n```\n\n#### output\n```sh\nid - - - -- - -- - - - - - -  - - - -  - 521587687\ndomain - - - -- - -- - - - - - -  - - - -  - live\nstatus - - - -- - -- - - - - - -  - - - -  - success\nreference - - - -- - -- - - - - - -  - - - -  - T394541625653843\namount - - - -- - -- - - - - - -  - - - -  - 100000\ngateway_response - - - -- - -- - - - - - -  - - - -  - Approved\npaid_at - - - -- - -- - - - - - -  - - - -  - 2020-02-27T17:28:14.000Z\ncreated_at - - - -- - -- - - - - - -  - - - -  - 2020-02-27T17:27:31.000Z\nchannel - - - -- - -- - - - - - -  - - - -  - card\ncurrency - - - -- - -- - - - - - -  - - - -  - NGN\nip_address - - - -- - -- - - - - - -  - - - -  - 102.67.15.8\nfees - - - -- - -- - - - - - -  - - - -  - 1500\nplan - - - -- - -- - - - - - -  - - - -  - PLN_q34mm97ac7pnqj1\npaidAt - - - -- - -- - - - - - -  - - - -  - 2020-02-27T17:28:14.000Z\ncreatedAt - - - -- - -- - - - - - -  - - - -  - 2020-02-27T17:27:31.000Z\nrequested_amount - - - -- - -- - - - - - -  - - - -  - 100000\ntransaction_date - - - -- - -- - - - - - -  - - - -  - 2020-02-27T17:27:31.000Z\n\n```\n\n\n### Webhook\nYou can tunnel Paystack webhook events directly to your localhost without any third party software directly from your terminal\n\n```\n $ webhook listen localhost:8995/pay/pstk-webhook?country=ng\n```\n\n#### output\n\n```sh\n> Tunelling webhook events to localhost:8995/pay/pstk-webhook?country=ng\n> Webhook events would now be received at localhost:8995/pay/pstk-webhook?country=ng\n```\nNOTE - This command is only avalaible in test mode, and by using this command, the CLI would automatically make changes to the Test Webhook URL set on your Paystack dashboard.\n\nYou can also run an health check on your live/test webhook endpoint from your terminal\n\n```sh\n$ webhook ping --domain live\n```\n\n#### output\n```sh\n-  - - - - - - -  - - -  - - - -   - - - --  -- - - - - - - \nSending sample charge.success event payload to https://paycash.pstk.xyz/pay/pstk-webhook?country=ng\n401 - - Unauthorized\nUnauthorized\n\n```\n\n\n### Sample Apps\nWe have built different sample apps and embedded them in the CLI, you can setup a sample project in your terminal by running\n\n```sh\n$ sample sample-react \"~/Desktop/Work\"\n```\n\n\n\nBy default, all commands are run in test mode, to switch to live, append the flag *\"--domain live\"* at the end of your command\n\n\n\n\nLicense\n----\n\nMIT\n","readmeFilename":"README.md"}