heroku

{ "version": "8.3.0", "commands": { "console": { "id": "console", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "hidden": true, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "size": { "name": "size", "type": "option", "char": "s", "description": "dyno size", "multiple": false }, "env": { "name": "env", "type": "option", "char": "e", "description": "environment variables to set (use ';' to split multiple vars)", "multiple": false } }, "args": {} }, "logs": { "id": "logs", "description": "display recent log output\ndisable colors with --no-color, HEROKU_LOGS_COLOR=0, or HEROKU_COLOR=0", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku logs --app=my-app", "$ heroku logs --num=50", "$ heroku logs --dyno=web --app=my-app", "$ heroku logs --app=my-app --tail" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "num": { "name": "num", "type": "option", "char": "n", "description": "number of lines to display", "multiple": false }, "ps": { "name": "ps", "type": "option", "char": "p", "description": "hidden alias for dyno", "hidden": true, "multiple": false }, "dyno": { "name": "dyno", "type": "option", "char": "d", "description": "only show output from this dyno type (such as \"web\" or \"worker\")", "multiple": false }, "source": { "name": "source", "type": "option", "char": "s", "description": "only show output from this source (such as \"app\" or \"heroku\")", "multiple": false }, "tail": { "name": "tail", "type": "boolean", "char": "t", "description": "continually stream logs", "allowNo": false }, "force-colors": { "name": "force-colors", "type": "boolean", "description": "force use of colors (even on non-tty output)", "allowNo": false } }, "args": {} }, "rake": { "id": "rake", "strict": false, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "hidden": true, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "parent app used by review apps", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "size": { "name": "size", "type": "option", "char": "s", "description": "dyno size", "multiple": false }, "exit-code": { "name": "exit-code", "type": "boolean", "char": "x", "description": "passthrough the exit code of the remote command", "allowNo": false }, "env": { "name": "env", "type": "option", "char": "e", "description": "environment variables to set (use ';' to split multiple vars)", "multiple": false }, "no-tty": { "name": "no-tty", "type": "boolean", "description": "force the command to not run in a tty", "allowNo": false } }, "args": {} }, "regions": { "id": "regions", "description": "list available regions for deployment", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "json": { "name": "json", "type": "boolean", "description": "output in json format", "allowNo": false }, "private": { "name": "private", "type": "boolean", "description": "show regions for private spaces", "allowNo": false }, "common": { "name": "common", "type": "boolean", "description": "show regions for common runtime", "allowNo": false } }, "args": {}, "topic": "regions" }, "status": { "id": "status", "description": "display current status of the Heroku platform", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "json": { "name": "json", "type": "boolean", "description": "output in json format", "allowNo": false } }, "args": {} }, "auth:login": { "id": "auth:login", "description": "login with your Heroku credentials", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [ "login" ], "flags": { "browser": { "name": "browser", "type": "option", "description": "browser to open SSO with (example: \"firefox\", \"safari\")", "multiple": false }, "sso": { "name": "sso", "type": "boolean", "char": "s", "description": "login for enterprise users under SSO", "hidden": true, "allowNo": false }, "interactive": { "name": "interactive", "type": "boolean", "char": "i", "description": "login with username/password", "allowNo": false }, "expires-in": { "name": "expires-in", "type": "option", "char": "e", "description": "duration of token in seconds (default 30 days)", "multiple": false } }, "args": {} }, "auth:logout": { "id": "auth:logout", "description": "clears local login credentials and invalidates API session", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [ "logout" ], "flags": {}, "args": {} }, "auth:token": { "id": "auth:token", "description": "outputs current CLI authentication token.\nBy default, the CLI auth token is only valid for 1 year. To generate a long-lived token, use heroku authorizations:create", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false } }, "args": {} }, "auth:whoami": { "id": "auth:whoami", "description": "display the current logged in user", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [ "whoami" ], "flags": {}, "args": {} }, "authorizations:create": { "id": "authorizations:create", "description": "create a new OAuth authorization", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku authorizations:create --description \"For use with Anvil\"" ], "flags": { "description": { "name": "description", "type": "option", "char": "d", "description": "set a custom authorization", "multiple": false }, "short": { "name": "short", "type": "boolean", "char": "S", "description": "only output token", "allowNo": false }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false }, "scope": { "name": "scope", "type": "option", "char": "s", "description": "set custom OAuth scopes", "multiple": false }, "expires-in": { "name": "expires-in", "type": "option", "char": "e", "description": "set expiration in seconds (default no expiration)", "multiple": false } }, "args": {} }, "authorizations": { "id": "authorizations", "description": "list OAuth authorizations", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku authorizations" ], "flags": { "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false } }, "args": {} }, "authorizations:info": { "id": "authorizations:info", "description": "show an existing OAuth authorization", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false } }, "args": { "id": { "name": "id", "required": true } } }, "authorizations:revoke": { "id": "authorizations:revoke", "description": "revoke OAuth authorization", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [ "authorizations:revoke", "authorizations:destroy" ], "examples": [ "$ heroku authorizations:revoke 105a7bfa-34c3-476e-873a-b1ac3fdc12fb" ], "flags": {}, "args": { "id": { "name": "id", "required": true } } }, "authorizations:rotate": { "id": "authorizations:rotate", "description": "updates an OAuth authorization token", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": {}, "args": { "id": { "name": "id", "required": true } } }, "authorizations:update": { "id": "authorizations:update", "description": "updates an OAuth authorization", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "description": { "name": "description", "type": "option", "char": "d", "description": "set a custom authorization description", "multiple": false }, "client-id": { "name": "client-id", "type": "option", "description": "identifier of OAuth client to set", "multiple": false, "dependsOn": [ "client-secret" ] }, "client-secret": { "name": "client-secret", "type": "option", "description": "secret of OAuth client to set", "multiple": false, "dependsOn": [ "client-id" ] } }, "args": { "id": { "name": "id", "required": true } } }, "autocomplete:create": { "id": "autocomplete:create", "description": "create autocomplete setup scripts and completion functions", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "hidden": true, "aliases": [], "flags": {}, "args": {} }, "autocomplete:doctor": { "id": "autocomplete:doctor", "description": "autocomplete diagnostic", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "hidden": true, "aliases": [], "flags": { "verbose": { "name": "verbose", "type": "boolean", "description": "list completable commands", "allowNo": false } }, "args": { "shell": { "name": "shell", "description": "shell type", "required": false } } }, "autocomplete": { "id": "autocomplete", "description": "display autocomplete installation instructions", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku autocomplete", "$ heroku autocomplete bash", "$ heroku autocomplete zsh", "$ heroku autocomplete --refresh-cache" ], "flags": { "refresh-cache": { "name": "refresh-cache", "type": "boolean", "char": "r", "description": "refresh cache only (ignores displaying instructions)", "allowNo": false } }, "args": { "shell": { "name": "shell", "description": "shell type", "required": false } } }, "autocomplete:options": { "id": "autocomplete:options", "description": "display arg or flag completion options (used internally by completion functions)", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "hidden": true, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "hidden": true, "required": false, "multiple": false } }, "args": { "completion": { "name": "completion" } } }, "autocomplete:script": { "id": "autocomplete:script", "description": "display autocomplete setup script for shell", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "hidden": true, "aliases": [], "flags": {}, "args": { "shell": { "name": "shell", "description": "shell type", "required": false } } }, "buildpacks:add": { "id": "buildpacks:add", "description": "add new app buildpack, inserting into list of buildpacks if necessary", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "index": { "name": "index", "type": "option", "char": "i", "description": "the 1-based index of the URL in the list of URLs", "multiple": false } }, "args": { "buildpack": { "name": "buildpack", "description": "namespace/name of the buildpack", "required": true } } }, "buildpacks:clear": { "id": "buildpacks:clear", "description": "clear all buildpacks set on the app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": {} }, "buildpacks": { "id": "buildpacks", "description": "display the buildpacks for an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": {} }, "buildpacks:info": { "id": "buildpacks:info", "description": "fetch info about a buildpack", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": {}, "args": { "buildpack": { "name": "buildpack", "description": "namespace/name of the buildpack", "required": true } } }, "buildpacks:remove": { "id": "buildpacks:remove", "description": "remove a buildpack set on the app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "index": { "name": "index", "type": "option", "char": "i", "description": "the 1-based index of the URL to remove from the list of URLs", "multiple": false } }, "args": { "buildpack": { "name": "buildpack", "description": "namespace/name of the buildpack" } } }, "buildpacks:search": { "id": "buildpacks:search", "description": "search for buildpacks", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "namespace": { "name": "namespace", "type": "option", "description": "buildpack namespaces to filter on using a comma separated list", "multiple": false }, "name": { "name": "name", "type": "option", "description": "buildpack names to filter on using a comma separated list ", "multiple": false }, "description": { "name": "description", "type": "option", "description": "buildpack description to filter on", "multiple": false } }, "args": { "term": { "name": "term", "description": "search term that searches across name, namespace, and description" } } }, "buildpacks:set": { "id": "buildpacks:set", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "index": { "name": "index", "type": "option", "char": "i", "description": "the 1-based index of the URL in the list of URLs", "multiple": false } }, "args": { "buildpack": { "name": "buildpack", "description": "namespace/name of the buildpack", "required": true } } }, "buildpacks:versions": { "id": "buildpacks:versions", "description": "list versions of a buildpack", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": {}, "args": { "buildpack": { "name": "buildpack", "description": "namespace/name of the buildpack", "required": true } } }, "ci": { "id": "ci", "description": "display the most recent CI runs for the given pipeline", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku ci --app murmuring-headland-14719\n" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app name", "multiple": false }, "watch": { "name": "watch", "type": "boolean", "description": "keep running and watch for new and update tests", "required": false, "allowNo": false }, "pipeline": { "name": "pipeline", "type": "option", "char": "p", "description": "name of pipeline", "required": false, "multiple": false }, "json": { "name": "json", "type": "boolean", "description": "output in json format", "required": false, "allowNo": false } }, "args": {} }, "ci:info": { "id": "ci:info", "description": "show the status of a specific test run", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku ci:info 1288 --app murmuring-headland-14719\n" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app name", "multiple": false }, "node": { "name": "node", "type": "option", "description": "the node number to show its setup and output", "required": false, "multiple": false }, "pipeline": { "name": "pipeline", "type": "option", "char": "p", "description": "name of pipeline", "required": false, "multiple": false } }, "args": { "test-run": { "name": "test-run", "required": true } } }, "ci:last": { "id": "ci:last", "description": "looks for the most recent run and returns the output of that run", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku ci:last --pipeline=my-pipeline --node 100\n" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app name", "multiple": false }, "node": { "name": "node", "type": "option", "description": "the node number to show its setup and output", "required": false, "multiple": false }, "pipeline": { "name": "pipeline", "type": "option", "char": "p", "description": "name of pipeline", "required": false, "multiple": false } }, "args": {} }, "ci:rerun": { "id": "ci:rerun", "description": "rerun tests against current directory", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku ci:rerun 985 --app murmuring-headland-14719\n" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app name", "multiple": false }, "pipeline": { "name": "pipeline", "type": "option", "char": "p", "description": "name of pipeline", "required": false, "multiple": false } }, "args": { "number": { "name": "number", "required": false } } }, "ci:run": { "id": "ci:run", "description": "run tests against current directory", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku ci:run --app murmuring-headland-14719\n" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app name", "multiple": false }, "pipeline": { "name": "pipeline", "type": "option", "char": "p", "description": "name of pipeline", "required": false, "multiple": false } }, "args": {} }, "clients:create": { "id": "clients:create", "description": "create a new OAuth client", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku clients:create \"Amazing\" https://amazing-client.herokuapp.com/auth/heroku/callback" ], "flags": { "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false }, "shell": { "name": "shell", "type": "boolean", "char": "s", "description": "output in shell format", "allowNo": false } }, "args": { "name": { "name": "name", "required": true }, "redirect_uri": { "name": "redirect_uri", "required": true } } }, "clients:destroy": { "id": "clients:destroy", "description": "delete client by ID", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": {}, "args": { "id": { "name": "id", "required": true } } }, "clients": { "id": "clients", "description": "list your OAuth clients", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false } }, "args": {} }, "clients:info": { "id": "clients:info", "description": "show details of an oauth client", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku clients:info 36120128-fee7-455e-8b7f-807aee130946" ], "flags": { "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false }, "shell": { "name": "shell", "type": "boolean", "char": "s", "description": "output in shell format", "allowNo": false } }, "args": { "id": { "name": "id", "required": true } } }, "clients:rotate": { "id": "clients:rotate", "description": "rotate OAuth client secret", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false }, "shell": { "name": "shell", "type": "boolean", "char": "s", "description": "output in shell format", "allowNo": false } }, "args": { "id": { "name": "id", "required": true } } }, "clients:update": { "id": "clients:update", "description": "update OAuth client", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku clients:update 3e304bda-d376-4278-bdea-6d6c08aa1359 --url https://amazing-client.herokuapp.com/auth/heroku/callback" ], "flags": { "name": { "name": "name", "type": "option", "char": "n", "description": "change the client name", "multiple": false }, "url": { "name": "url", "type": "option", "description": "change the client redirect URL", "multiple": false } }, "args": { "id": { "name": "id", "required": true } } }, "config:edit": { "id": "config:edit", "description": "interactively edit config vars\nThis command opens the app config in a text editor set by $VISUAL or $EDITOR.\nAny variables added/removed/changed will be updated on the app after saving and closing the file.", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "# edit with vim\n$ EDITOR=\"vim\" heroku config:edit", "# edit with emacs\n$ EDITOR=\"emacs\" heroku config:edit", "# edit with pico\n$ EDITOR=\"pico\" heroku config:edit", "# edit with atom editor\n$ VISUAL=\"atom --wait\" heroku config:edit" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": { "key": { "name": "key", "description": "edit a single key" } } }, "config:get": { "id": "config:get", "description": "display a single config value for an app", "strict": false, "usage": "config:get KEY...", "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": "$ heroku config:get RAILS_ENV\nproduction", "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "shell": { "name": "shell", "type": "boolean", "char": "s", "description": "output config vars in shell format", "allowNo": false } }, "args": { "KEY": { "name": "KEY", "required": true } }, "example": "$ heroku config:get RAILS_ENV\nproduction" }, "config": { "id": "config", "description": "display the config vars for an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "shell": { "name": "shell", "type": "boolean", "char": "s", "description": "output config vars in shell format", "allowNo": false }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output config vars in json format", "allowNo": false } }, "args": {} }, "config:unset": { "id": "config:unset", "description": "unset one or more config vars", "strict": false, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [ "config:remove" ], "examples": [ "$ heroku config:unset RAILS_ENV\nUnsetting RAILS_ENV and restarting example... done, v10", "$ heroku config:unset RAILS_ENV RACK_ENV\nUnsetting RAILS_ENV, RACK_ENV and restarting example... done, v10" ], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": {} }, "domains:add": { "id": "domains:add", "description": "add a domain to an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "heroku domains:add www.example.com" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "cert": { "name": "cert", "type": "option", "char": "c", "description": "the name of the SSL cert you want to use for this domain", "multiple": false }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false }, "wait": { "name": "wait", "type": "boolean", "allowNo": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": { "hostname": { "name": "hostname", "required": true } } }, "domains:clear": { "id": "domains:clear", "description": "remove all domains from an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "heroku domains:clear" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": {} }, "domains": { "id": "domains", "description": "list domains for an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku domains\n=== example Heroku Domain\nexample-xxxxxxxxxxxx.herokuapp.com\n\n=== example Custom Domains\nDomain Name DNS Record Type DNS Target\nwww.example.com CNAME www.example.herokudns.com\n", "$ heroku domains --filter 'Domain Name=www.example.com'" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output in json format", "allowNo": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "domains:info": { "id": "domains:info", "description": "show detailed information for a domain on an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "$ heroku domains:info www.example.com" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": { "hostname": { "name": "hostname", "required": true } } }, "domains:remove": { "id": "domains:remove", "description": "remove a domain from an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "heroku domains:remove www.example.com" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": { "hostname": { "name": "hostname", "required": true } } }, "domains:update": { "id": "domains:update", "description": "update a domain to use a different SSL certificate on an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": [ "heroku domains:update www.example.com --cert mycert" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "cert": { "name": "cert", "type": "option", "description": "the name or id of the certificate you want to use for this domain", "required": true, "multiple": false } }, "args": { "hostname": { "name": "hostname", "required": true } } }, "domains:wait": { "id": "domains:wait", "description": "wait for domain to be active for an app", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false } }, "args": { "hostname": { "name": "hostname" } } }, "git:clone": { "id": "git:clone", "description": "clones a heroku app to your local machine at DIRECTORY (defaults to app name)", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": "$ heroku git:clone -a example\nCloning into 'example'...\nremote: Counting objects: 42, done.\n...", "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "the Heroku app to use", "required": true, "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "the git remote to create, default \"heroku\"", "multiple": false } }, "args": { "DIRECTORY": { "name": "DIRECTORY", "description": "where to clone the app" } }, "example": "$ heroku git:clone -a example\nCloning into 'example'...\nremote: Counting objects: 42, done.\n..." }, "git:credentials": { "id": "git:credentials", "description": "internal command for git-credentials", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "hidden": true, "aliases": [], "flags": {}, "args": { "command": { "name": "command", "required": true } } }, "git:remote": { "id": "git:remote", "description": "adds a git remote to an app repo\nextra arguments will be passed to git remote add\n", "strict": false, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "examples": "# set git remote heroku to https://git.heroku.com/example.git\n $ heroku git:remote -a example\n\n # set git remote heroku-staging to https://git.heroku.com/example.git\n $ heroku git:remote --remote heroku-staging -a example", "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "the Heroku app to use", "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "the git remote to create", "multiple": false } }, "args": {}, "example": "# set git remote heroku to https://git.heroku.com/example.git\n $ heroku git:remote -a example\n\n # set git remote heroku-staging to https://git.heroku.com/example.git\n $ heroku git:remote --remote heroku-staging -a example" }, "labs:disable": { "id": "labs:disable", "description": "disables an experimental feature", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "multiple": false }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use", "multiple": false }, "confirm": { "name": "confirm", "type": "option", "required": false, "multiple": false } }, "args": { "feature": { "name": "feature", "required": true } } }, "local": { "id": "local", "description": "run heroku app locally\nStart the application specified by a Procfile (defaults to ./Procfile)", "strict": true, "pluginName": "heroku", "pluginAlias": "heroku", "pluginType": "core", "aliases": [ "local:start" ], "examples": [ "$ heroku local\n$ heroku local web\n$ heroku local web=2\n$ heroku local web=1,worker=2" ], "flags": { "procfil