UNPKG

heroku

Version:

CLI to interact with Heroku

1,842 lines 425 kB
{ "commands": { "console": { "aliases": [], "args": {}, "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "size": { "char": "s", "description": "dyno size", "name": "size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "char": "e", "description": "environment variables to set (use ';' to split multiple vars)", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "console", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "lib", "commands", "console.js" ] }, "dashboard": { "aliases": [], "args": {}, "description": "display information about favorite apps", "flags": {}, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "dashboard", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "dashboard", "isESM": false, "relativePath": [ "lib", "commands", "dashboard.js" ] }, "logs": { "aliases": [], "args": {}, "description": "display recent log output\ndisable colors with --no-color, HEROKU_LOGS_COLOR=0, or HEROKU_COLOR=0\n", "examples": [ "heroku logs --app=my-app", "heroku logs --num=50 --app=my-app", "heroku logs --dyno-name=web-123-456 --app=my-app", "heroku logs --process-type=web --app=my-app", "heroku logs --app=my-app --tail" ], "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dyno-name": { "aliases": [ "dyno" ], "char": "d", "description": "only show output from this dyno (such as \"web-123-456\" or \"worker.2\")", "name": "dyno-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-colors": { "description": "force use of colors (even on non-tty output)", "name": "force-colors", "allowNo": false, "type": "boolean" }, "no-color": { "hidden": true, "name": "no-color", "relationships": [ { "type": "none", "flags": [ "force-colors" ] } ], "allowNo": false, "type": "boolean" }, "num": { "char": "n", "description": "number of lines to display (ignored for Fir generation apps)", "name": "num", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ps": { "char": "p", "description": "hidden alias for type", "hidden": true, "name": "ps", "relationships": [ { "type": "none", "flags": [ "dyno-name" ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source": { "char": "s", "description": "only show output from this source (such as \"app\" or \"heroku\")", "name": "source", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tail": { "char": "t", "description": "continually stream logs (always enabled for Fir-generation apps)", "name": "tail", "allowNo": false, "type": "boolean" }, "process-type": { "char": "p", "description": "only show output from this process type (such as \"web\" or \"worker\")", "name": "process-type", "relationships": [ { "type": "none", "flags": [ "dyno-name", "ps" ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "logs", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "lib", "commands", "logs.js" ] }, "rake": { "aliases": [], "args": {}, "flags": { "app": { "char": "a", "description": "parent app used by review apps", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "size": { "char": "s", "description": "dyno size", "name": "size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exit-code": { "char": "x", "description": "passthrough the exit code of the remote command", "name": "exit-code", "allowNo": false, "type": "boolean" }, "env": { "char": "e", "description": "environment variables to set (use ';' to split multiple vars)", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-tty": { "description": "force the command to not run in a tty", "name": "no-tty", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "rake", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": false, "isESM": false, "relativePath": [ "lib", "commands", "rake.js" ] }, "regions": { "aliases": [], "args": {}, "description": "list available regions for deployment", "flags": { "json": { "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" }, "private": { "description": "show regions for private spaces", "name": "private", "allowNo": false, "type": "boolean" }, "common": { "description": "show regions for common runtime", "name": "common", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "regions", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "regions", "isESM": false, "relativePath": [ "lib", "commands", "regions.js" ] }, "status": { "aliases": [], "args": {}, "description": "display current status of the Heroku platform", "flags": { "json": { "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "status", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "lib", "commands", "status.js" ] }, "access:add": { "aliases": [], "args": { "email": { "description": "email address of the team member", "name": "email", "required": true } }, "description": "add new users to your app", "examples": [ "$ heroku access:add user@email.com --app APP # add a collaborator to your app", "$ heroku access:add user@email.com --app APP --permissions deploy,manage,operate # permissions must be comma separated" ], "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "permissions": { "char": "p", "description": "list of permissions comma separated", "name": "permissions", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "access:add", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "lib", "commands", "access", "add.js" ] }, "access": { "aliases": [], "args": {}, "description": "list who has access to an app", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "access", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "access", "isESM": false, "relativePath": [ "lib", "commands", "access", "index.js" ] }, "access:remove": { "aliases": [], "args": {}, "description": "remove users from a team app", "examples": "$ heroku access:remove user@email.com --app APP", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "access:remove", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": false, "example": "$ heroku access:remove user@email.com --app APP", "topic": "access", "isESM": false, "relativePath": [ "lib", "commands", "access", "remove.js" ] }, "access:update": { "aliases": [], "args": { "email": { "description": "email address of the team member", "name": "email", "required": true } }, "description": "update existing collaborators on an team app", "flags": { "permissions": { "char": "p", "description": "comma-delimited list of permissions to update (deploy,manage,operate)", "name": "permissions", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "access:update", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "access", "isESM": false, "relativePath": [ "lib", "commands", "access", "update.js" ] }, "accounts:add": { "aliases": [], "args": { "name": { "description": "name of Heroku account to add", "name": "name", "required": true } }, "description": "add a Heroku account to your cache", "examples": "heroku accounts:add my-account", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts:add", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "example": "heroku accounts:add my-account", "isESM": false, "relativePath": [ "lib", "commands", "accounts", "add.js" ] }, "accounts:current": { "aliases": [], "args": {}, "description": "display the current Heroku account", "examples": "heroku accounts:current", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts:current", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "example": "heroku accounts:current", "isESM": false, "relativePath": [ "lib", "commands", "accounts", "current.js" ] }, "accounts": { "aliases": [], "args": {}, "description": "list the Heroku accounts in your cache", "examples": "heroku accounts", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "example": "heroku accounts", "isESM": false, "relativePath": [ "lib", "commands", "accounts", "index.js" ] }, "accounts:remove": { "aliases": [], "args": { "name": { "description": "name of Heroku account to remove", "name": "name", "required": true } }, "description": "remove a Heroku account from your cache", "examples": "heroku accounts:remove my-account", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts:remove", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "example": "heroku accounts:remove my-account", "isESM": false, "relativePath": [ "lib", "commands", "accounts", "remove.js" ] }, "accounts:set": { "aliases": [], "args": { "name": { "description": "name of account to set", "name": "name", "required": true } }, "description": "set the current Heroku account from your cache", "examples": "heroku accounts:set my-account", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts:set", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "example": "heroku accounts:set my-account", "isESM": false, "relativePath": [ "lib", "commands", "accounts", "set.js" ] }, "addons:attach": { "aliases": [], "args": { "addon_name": { "description": "unique identifier or globally unique name of the add-on", "name": "addon_name", "required": true } }, "description": "attach an existing add-on resource to an app", "flags": { "as": { "description": "name for add-on attachment", "name": "as", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential": { "description": "credential name for scoped access to Heroku Postgres", "name": "credential", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "confirm": { "description": "overwrite existing add-on attachment with same name", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:attach", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "attach.js" ] }, "addons:create": { "aliases": [], "args": { "service:plan": { "description": "unique identifier or unique name of the add-on service plan", "name": "service:plan", "required": true } }, "description": "Create a new add-on resource.\n\nIn order to add additional config items, please place them at the end of the command after a double-dash (--).\n", "examples": "Create an add-on resource:\n$heroku addons:create heroku-redis --app my-app\n\nCreate an add-on resource with additional config items:\n$heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE\n", "flags": { "name": { "description": "name for the add-on resource", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "as": { "description": "name for the initial add-on attachment", "name": "as", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "confirm": { "description": "overwrite existing config vars or existing add-on attachments", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "description": "watch add-on creation status and exit when complete", "name": "wait", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "addons:add" ], "id": "addons:create", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": false, "topic": "addons", "example": "Create an add-on resource:\n$heroku addons:create heroku-redis --app my-app\n\nCreate an add-on resource with additional config items:\n$heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE\n", "isESM": false, "relativePath": [ "lib", "commands", "addons", "create.js" ] }, "addons:destroy": { "aliases": [], "args": { "addonName": { "description": "unique identifier or globally unique name of the add-on", "name": "addonName", "required": true } }, "description": "permanently destroy an add-on resource", "examples": [ "addons:destroy [ADDON]... [flags]" ], "flags": { "force": { "char": "f", "description": "allow destruction even if connected to other apps", "name": "force", "allowNo": false, "type": "boolean" }, "confirm": { "char": "c", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "description": "watch add-on destruction status and exit when complete", "name": "wait", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "addons:remove" ], "id": "addons:destroy", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": false, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "destroy.js" ] }, "addons:detach": { "aliases": [], "args": { "attachment_name": { "description": "unique identifier of the add-on attachment", "name": "attachment_name", "required": true } }, "description": "detach an existing add-on resource from an app", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:detach", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "detach.js" ] }, "addons:docs": { "aliases": [], "args": { "addon": { "description": "unique identifier or globally unique name of the add-on", "name": "addon", "required": true } }, "description": "open an add-on's Dev Center documentation in your browser", "flags": { "show-url": { "description": "show URL, do not open browser", "name": "show-url", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:docs", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "docs.js" ] }, "addons": { "aliases": [], "args": {}, "description": "Lists your add-ons and attachments.\n\n The default filter applied depends on whether you are in a Heroku app\n directory. If so, the --app flag is implied. If not, the default of --all\n is implied. Explicitly providing either flag overrides the default\n behavior.\n ", "examples": [ "$ heroku addons --all", "$ heroku addons --app acme-inc-www" ], "flags": { "all": { "char": "A", "description": "show add-ons and attachments for all accessible apps", "name": "all", "allowNo": false, "type": "boolean" }, "json": { "description": "return add-ons in json format", "name": "json", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "usage": "addons [--all|--app APP]", "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "index.js" ] }, "addons:info": { "aliases": [], "args": { "addon": { "description": "unique identifier or globally unique name of the add-on", "name": "addon", "required": true } }, "description": "show detailed add-on resource and attachment information", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:info", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "usage": "addons:info ADDON", "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "info.js" ] }, "addons:open": { "aliases": [], "args": { "addon": { "description": "unique identifier or globally unique name of the add-on", "name": "addon", "required": true } }, "description": "open an add-on's dashboard in your browser", "flags": { "show-url": { "description": "show URL, do not open browser", "name": "show-url", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:open", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "open.js" ] }, "addons:plans": { "aliases": [], "args": { "service": { "description": "unique identifier or globally unique name of the add-on", "name": "service", "required": true } }, "description": "list all available plans for an add-on service", "flags": { "json": { "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:plans", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "plans.js" ] }, "addons:rename": { "aliases": [], "args": { "addon_name": { "description": "unique identifier or globally unique name of the add-on", "name": "addon_name", "required": true }, "new_name": { "description": "new globally unique name of the add-on", "name": "new_name", "required": true } }, "description": "rename an add-on", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:rename", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "rename.js" ] }, "addons:services": { "aliases": [], "args": {}, "description": "list all available add-on services", "flags": { "json": { "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:services", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "services.js" ] }, "addons:upgrade": { "aliases": [ "addons:downgrade" ], "args": { "addon": { "description": "unique identifier or globally unique name of the add-on", "name": "addon", "required": true }, "plan": { "description": "unique identifier or name of the plan", "name": "plan" } }, "description": "change add-on plan.\n See available plans with `heroku addons:plans SERVICE`.\n\n Note that `heroku addons:upgrade` and `heroku addons:downgrade` are the same. Either one can be used to change an add-on plan up or down.\n\n https://devcenter.heroku.com/articles/managing-add-ons\n ", "examples": [ "Upgrade an add-on by service name:\n$ heroku addons:upgrade heroku-redis:premium-2\n\nUpgrade a specific add-on:\n$ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2" ], "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:upgrade", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "upgrade.js" ] }, "addons:wait": { "aliases": [], "args": { "addon": { "description": "unique identifier or globally unique name of the add-on", "name": "addon" } }, "description": "show provisioning status of the add-ons on the app", "flags": { "wait-interval": { "description": "how frequently to poll in seconds", "name": "wait-interval", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "addons:wait", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "addons", "isESM": false, "relativePath": [ "lib", "commands", "addons", "wait.js" ] }, "apps:create": { "aliases": [], "args": { "app": { "description": "name of app to create", "name": "app", "required": false } }, "description": "creates a new app", "examples": [ "$ heroku apps:create\nCreating app... done, stack is heroku-24\nhttps://floating-dragon-42.heroku.com/ | https://git.heroku.com/floating-dragon-42.git\n\n# or just\n$ heroku create\n\n# use a heroku.yml manifest file\n$ heroku apps:create --manifest\n\n# specify a buildpack\n$ heroku apps:create --buildpack https://github.com/some/buildpack.git\n\n# specify a name\n$ heroku apps:create example\n\n# create a staging app\n$ heroku apps:create example-staging --remote staging\n\n# create an app in the eu region\n$ heroku apps:create --region eu" ], "flags": { "app": { "hidden": true, "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "addons": { "description": "comma-delimited list of addons to install", "name": "addons", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "buildpack": { "char": "b", "description": "buildpack url to use for this app", "name": "buildpack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "manifest": { "char": "m", "description": "use heroku.yml settings for this app", "hidden": true, "name": "manifest", "allowNo": false, "type": "boolean" }, "no-remote": { "char": "n", "description": "do not create a git remote", "name": "no-remote", "allowNo": false, "type": "boolean" }, "remote": { "char": "r", "description": "the git remote to create, default \"heroku\"", "name": "remote", "default": "heroku", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stack": { "char": "s", "description": "the stack to create the app on", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "description": "the private space to create the app in", "name": "space", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "region": { "description": "specify region for the app to run in", "name": "region", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "internal-routing": { "description": "private space-only. create as an Internal Web App that is only routable in the local network.", "hidden": true, "name": "internal-routing", "allowNo": false, "type": "boolean" }, "features": { "hidden": true, "name": "features", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "kernel": { "hidden": true, "name": "kernel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "locked": { "hidden": true, "name": "locked", "allowNo": false, "type": "boolean" }, "json": { "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" }, "team": { "char": "t", "description": "team to use", "name": "team", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "create" ], "id": "apps:create", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "lib", "commands", "apps", "create.js" ] }, "apps:destroy": { "aliases": [], "args": { "app": { "hidden": true, "name": "app" } }, "description": "permanently destroy an app", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "confirm": { "char": "c", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "destroy", "apps:delete" ], "id": "apps:destroy", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "help": "This will also destroy all add-ons on the app.", "isESM": false, "relativePath": [ "lib", "commands", "apps", "destroy.js" ] }, "apps:errors": { "aliases": [], "args": {}, "description": "view app errors", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" }, "hours": { "description": "number of hours to look back (default 24)", "name": "hours", "default": "24", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "router": { "description": "show only router errors", "name": "router", "allowNo": false, "type": "boolean" }, "dyno": { "description": "show only dyno errors", "name": "dyno", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "apps:errors", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "isESM": false, "relativePath": [ "lib", "commands", "apps", "errors.js" ] }, "apps": { "aliases": [], "args": {}, "description": "list your apps", "examples": [ "$ heroku apps" ], "flags": { "all": { "char": "A", "description": "include apps in all teams", "name": "all", "allowNo": false, "type": "boolean" }, "json": { "char": "j", "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" }, "space": { "char": "s", "description": "filter by space", "name": "space", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "personal": { "char": "p", "description": "list apps in personal account when a default team is set", "name": "personal", "allowNo": false, "type": "boolean" }, "internal-routing": { "char": "i", "description": "filter to Internal Web Apps", "hidden": true, "name": "internal-routing", "allowNo": false, "type": "boolean" }, "team": { "char": "t", "description": "team to use", "name": "team", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ "list", "apps:list" ], "id": "apps", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "apps", "isESM": false, "relativePath": [ "lib", "commands", "apps", "index.js" ] }, "apps:info": { "aliases": [], "args": { "app": { "hidden": true, "name": "app" } }, "description": "show detailed app information", "examples": [ "$ heroku apps:info", "$ heroku apps:info --shell" ], "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shell": { "char": "s", "description": "output more shell friendly key/value pairs", "name": "shell", "allowNo": false, "type": "boolean" }, "extended": { "char": "x", "hidden": true, "name": "extended", "allowNo": false, "type": "boolean" }, "json": { "char": "j", "description": "output in json format", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ "info" ], "id": "apps:info", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "apps", "help": "$ heroku apps:info\n=== example\nGit URL: https://git.heroku.com/example.git\nRepo Size: 5M\n...\n\n$ heroku apps:info --shell\ngit_url=https://git.heroku.com/example.git\nrepo_size=5000000\n...", "isESM": false, "relativePath": [ "lib", "commands", "apps", "info.js" ] }, "apps:join": { "aliases": [ "join" ], "args": {}, "description": "add yourself to a team app", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "apps:join", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "apps", "isESM": false, "relativePath": [ "lib", "commands", "apps", "join.js" ] }, "apps:leave": { "aliases": [ "leave" ], "args": {}, "description": "remove yourself from a team app", "examples": "heroku apps:leave -a APP", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "apps:leave", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "apps", "example": "heroku apps:leave -a APP", "isESM": false, "relativePath": [ "lib", "commands", "apps", "leave.js" ] }, "apps:lock": { "aliases": [ "lock" ], "args": {}, "description": "prevent team members from joining an app", "flags": { "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "apps:lock", "pluginAlias": "heroku", "pluginName": "heroku", "pluginType": "core", "strict": true, "topic": "apps", "isESM": false, "relativePath": [ "lib", "commands", "apps", "lock.js"