UNPKG

12.8 kBJSONView Raw
1{"version":"7.19.3","commands":{"pipelines:add":{"id":"pipelines:add","description":"add this app to a pipeline\nThe app and pipeline names must be specified.\nThe stage of the app will be guessed based on its name if not specified.","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:add example -a example-admin -s production\nAdding example-admin to example pipeline as production... done","flags":{"stage":{"name":"stage","type":"option","char":"s","description":"stage of first app in pipeline","required":false},"app":{"name":"app","type":"option","char":"a","description":"app to run command against","required":true},"remote":{"name":"remote","type":"option","char":"r","description":"git remote of app to use"}},"args":[{"name":"pipeline","description":"name of pipeline","required":true}]},"pipelines:connect":{"id":"pipelines:connect","description":"connect a github repo to an existing pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:connect example -r githuborg/reponame\nConfiguring pipeline... done","flags":{"repo":{"name":"repo","type":"option","char":"r","description":"the GitHub repository to connect","required":true}},"args":[{"name":"name","description":"name of pipeline","required":false}]},"pipelines:create":{"id":"pipelines:create","description":"create a new pipeline\nAn existing app must be specified as the first app in the pipeline.\nThe pipeline name will be inferred from the app name if not specified.\nThe stage of the app will be guessed based on its name if not specified.\nThe pipeline owner will be the user creating the pipeline if not specified with -t for teams or -o for orgs.","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:create -a example-staging\n? Pipeline name: example\n? Stage of example-staging: staging\nCreating example pipeline... done\nAdding example-staging to example pipeline as staging... done","flags":{"stage":{"name":"stage","type":"option","char":"s","description":"stage of first app in pipeline","required":false},"team":{"name":"team","type":"option","char":"t","description":"team to use","hidden":false,"required":false},"app":{"name":"app","type":"option","char":"a","description":"app to run command against","required":true},"remote":{"name":"remote","type":"option","char":"r","description":"git remote of app to use"},"org":{"name":"org","type":"option","char":"o","description":"team to use","hidden":true}},"args":[{"name":"name","description":"name of pipeline, defaults to basename of app","required":false}]},"pipelines:destroy":{"id":"pipelines:destroy","description":"destroy a pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:destroy example\nDestroying example pipeline... done","flags":{},"args":[{"name":"pipeline","description":"name of pipeline","required":true}]},"pipelines:diff":{"id":"pipelines:diff","description":"compares the latest release of this app to its downstream app(s)\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:diff --app murmuring-headland-14719","flags":{"app":{"name":"app","type":"option","char":"a","description":"app to run command against","required":true},"remote":{"name":"remote","type":"option","char":"r","description":"git remote of app to use"}},"args":[]},"pipelines":{"id":"pipelines","description":"list pipelines you have access to\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines\n=== My Pipelines\nexample\nsushi","flags":{"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[]},"pipelines:list":{"id":"pipelines:list","description":"list pipelines you have access to\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines\n=== My Pipelines\nexample\nsushi","flags":{"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false}},"args":[]},"pipelines:info":{"id":"pipelines:info","description":"show list of apps in a pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:info example\n=== example\nowner: my-team (team)\n\napp name stage\n─────────────────────────── ──────────\n⬢ example-pr-16 review\n⬢ example-pr-19 review\n⬢ example-pr-23 review\n⬢ example-staging staging\n⬢ example-staging-2 staging\n⬢ example-production production","flags":{"json":{"name":"json","type":"boolean","description":"output in json format","required":false,"allowNo":false},"with-owners":{"name":"with-owners","type":"boolean","description":"shows owner of every app","hidden":true,"required":false,"allowNo":false}},"args":[{"name":"pipeline","description":"pipeline to show","required":true}]},"pipelines:open":{"id":"pipelines:open","description":"open a pipeline in dashboard\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:open example","flags":{},"args":[{"name":"pipeline","description":"name of pipeline","required":true}]},"pipelines:promote":{"id":"pipelines:promote","description":"promote the latest release of this app to its downstream app(s)\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:promote -a example-staging\nPromoting example-staging to example (production)... done, v23\nPromoting example-staging to example-admin (production)... done, v54\n\n$ heroku pipelines:promote -a example-staging --to my-production-app1,my-production-app2\nStarting promotion to apps: my-production-app1,my-production-app2... done\nWaiting for promotion to complete... done\nPromotion successful\nmy-production-app1: succeeded\nmy-production-app2: succeeded","flags":{"to":{"name":"to","type":"option","char":"t","description":"comma separated list of apps to promote to","required":false},"app":{"name":"app","type":"option","char":"a","description":"app to run command against","required":true},"remote":{"name":"remote","type":"option","char":"r","description":"git remote of app to use"}},"args":[]},"pipelines:remove":{"id":"pipelines:remove","description":"remove this app from its pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:remove -a example-admin\nRemoving example-admin... done","flags":{"app":{"name":"app","type":"option","char":"a","description":"app to run command against","required":true},"remote":{"name":"remote","type":"option","char":"r","description":"git remote of app to use"}},"args":[]},"pipelines:rename":{"id":"pipelines:rename","description":"rename a pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:rename example www\nRenaming example pipeline to www... done","flags":{},"args":[{"name":"pipeline","description":"current name of pipeline","required":true},{"name":"name","description":"new name of pipeline","required":true}]},"pipelines:setup":{"id":"pipelines:setup","description":"bootstrap a new pipeline with common settings and create a production and staging app (requires a fully formed app.json in the repo)\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:setup example githuborg/reponame -o example-org\n? Automatically deploy the master branch to staging? Yes\n? Wait for CI to pass before deploying the master branch to staging? Yes\n? Enable review apps? Yes\n? Automatically create review apps for every PR? Yes\n? Automatically destroy idle review apps after 5 days? Yes\n? Enable automatic Heroku CI test runs? Yes\nCreating pipeline... done\nLinking to repo... done\nCreating production and staging apps (⬢ example and ⬢ example-staging)\nConfiguring pipeline... done\nView your new pipeline by running `heroku pipelines:open e5a55ffa-de3f-11e6-a245-3c15c2e6bc1e`","flags":{"team":{"name":"team","type":"option","char":"t","description":"team to use","hidden":false,"required":false},"yes":{"name":"yes","type":"boolean","char":"y","description":"accept all default settings without prompting","required":false,"allowNo":false},"org":{"name":"org","type":"option","char":"o","description":"team to use","hidden":true}},"args":[{"name":"name","description":"name of pipeline","required":false},{"name":"repo","description":"a GitHub repository to connect the pipeline to","required":false}]},"pipelines:transfer":{"id":"pipelines:transfer","description":"transfer ownership of a pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku pipelines:transfer me@example.com -p example\n=== example\n\napp name stage\n──────────────────── ───────────\n⬢ example-dev development\n⬢ example-staging staging\n⬢ example-prod production\n\n ▸ This will transfer example and all of the listed apps to the me@example.com account\n ▸ to proceed, type example or re-run this command with --confirm example\n> example\nTransferring example pipeline to the me@example.com account... done\n\n$ heroku pipelines:transfer acme-widgets -p example\n=== example\n\napp name stage\n──────────────────── ───────────\n⬢ example-dev development\n⬢ example-staging staging\n⬢ example-prod production\n\n ▸ This will transfer example and all of the listed apps to the acme-widgets team\n ▸ to proceed, type example or re-run this command with --confirm example\n> example\n\nTransferring example pipeline to the acme-widgets team... done","flags":{"pipeline":{"name":"pipeline","type":"option","char":"p","description":"name of pipeline","required":true},"confirm":{"name":"confirm","type":"option","char":"c","required":false}},"args":[{"name":"owner","description":"the owner to transfer the pipeline to","required":true}]},"reviewapps:disable":{"id":"reviewapps:disable","description":"disable review apps or settings on an existing pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku reviewapps:disable -p mypipeline -a myapp --autodeploy\nDisabling auto deployment ...\nConfiguring pipeline... done","flags":{"pipeline":{"name":"pipeline","type":"option","char":"p","description":"name of pipeline","required":true},"app":{"name":"app","type":"option","char":"a","description":"parent app used by review apps","required":true},"remote":{"name":"remote","type":"option","char":"r","description":"git remote of parent app used by review apps","required":false},"autodeploy":{"name":"autodeploy","type":"boolean","description":"disable autodeployments","required":false,"allowNo":false},"autodestroy":{"name":"autodestroy","type":"boolean","description":"disable automatically destroying review apps","required":false,"allowNo":false}},"args":[]},"reviewapps:enable":{"id":"reviewapps:enable","description":"enable review apps and/or settings on an existing pipeline\n","pluginName":"@heroku-cli/plugin-pipelines-v5","pluginType":"core","hidden":false,"aliases":[],"examples":"$ heroku reviewapps:enable -p mypipeline --a myapp --autodeploy --autodestroy\nEnabling review apps ...\nEnabling auto deployment ...\nEnabling auto destroy ...\nConfiguring pipeline... done","flags":{"pipeline":{"name":"pipeline","type":"option","char":"p","description":"name of pipeline","required":true},"app":{"name":"app","type":"option","char":"a","description":"parent app used by review apps","required":true},"remote":{"name":"remote","type":"option","char":"r","description":"git remote of parent app used by review apps","required":false},"autodeploy":{"name":"autodeploy","type":"boolean","description":"autodeploy the review app","required":false,"allowNo":false},"autodestroy":{"name":"autodestroy","type":"boolean","description":"autodestroy the review app","required":false,"allowNo":false}},"args":[]}}}
\No newline at end of file