diff --git a/CHANGELOG.md b/CHANGELOG.md index 8277262cde..a2a71b15f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + ## [7.69.1](https://github.com/heroku/cli/compare/v7.69.0...v7.69.1) (2023-03-09) **Note:** Version bump only for package heroku diff --git a/docs/access.md b/docs/access.md index 4c6a267dcf..8ca80e0851 100644 --- a/docs/access.md +++ b/docs/access.md @@ -14,12 +14,15 @@ list who has access to an app ``` USAGE - $ heroku access + $ heroku access -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format + +DESCRIPTION + list who has access to an app ``` ## `heroku access:add EMAIL` @@ -28,15 +31,20 @@ add new users to your app ``` USAGE - $ heroku access:add EMAIL + $ heroku access:add EMAIL -a [-p ] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -p, --permissions= list of permissions comma separated + -r, --remote= git remote of app to use + +DESCRIPTION + add new users to your app -OPTIONS - -a, --app=app (required) app to run command against - -p, --permissions=permissions list of permissions comma separated - -r, --remote=remote git remote of app to use 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 ``` @@ -46,11 +54,15 @@ remove users from a team app ``` USAGE - $ heroku access:remove EMAIL + $ heroku access:remove EMAIL -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + remove users from a team app -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku access:remove user@email.com --app APP @@ -62,12 +74,16 @@ update existing collaborators on an team app ``` USAGE - $ heroku access:update EMAIL + $ heroku access:update EMAIL -a [-p ] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -p, --permissions= comma-delimited list of permissions to update (deploy,manage,operate) + -r, --remote= git remote of app to use + +DESCRIPTION + update existing collaborators on an team app -OPTIONS - -a, --app=app (required) app to run command against - -p, --permissions=permissions comma-delimited list of permissions to update (deploy,manage,operate) - -r, --remote=remote git remote of app to use EXAMPLES $ heroku access:update user@email.com --app APP --permissions deploy,manage,operate diff --git a/docs/addons.md b/docs/addons.md index 4c055f4c2c..e8cf09bf96 100644 --- a/docs/addons.md +++ b/docs/addons.md @@ -26,13 +26,14 @@ lists your add-ons and attachments USAGE $ heroku addons [--all|--app APP] -OPTIONS - -A, --all show add-ons and attachments for all accessible apps - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --json return add-ons in json format +FLAGS + -A, --all show add-ons and attachments for all accessible apps + -a, --app= app to run command against + -r, --remote= git remote of app to use + --json return add-ons in json format DESCRIPTION + lists your add-ons and attachments The default filter applied depends on whether you are in a Heroku app directory. If so, the --app flag is implied. If not, the default of --all is implied. Explicitly providing either flag overrides the default @@ -40,6 +41,7 @@ DESCRIPTION EXAMPLES $ heroku addons --all + $ heroku addons --app acme-inc-www ``` @@ -49,14 +51,18 @@ attach an existing add-on resource to an app ``` USAGE - $ heroku addons:attach ADDON_NAME + $ heroku addons:attach ADDON_NAME -a [--as ] [--credential ] [--confirm ] [-r + ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --as= name for add-on attachment + --confirm= overwrite existing add-on attachment with same name + --credential= credential name for scoped access to Heroku Postgres -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --as=as name for add-on attachment - --confirm=confirm overwrite existing add-on attachment with same name - --credential=credential credential name for scoped access to Heroku Postgres +DESCRIPTION + attach an existing add-on resource to an app ``` ## `heroku addons:create SERVICE:PLAN` @@ -65,15 +71,19 @@ create a new add-on resource ``` USAGE - $ heroku addons:create SERVICE:PLAN + $ heroku addons:create SERVICE:PLAN -a [--name ] [--as ] [--confirm ] [--wait] [-r + ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --as= name for the initial add-on attachment + --confirm= overwrite existing config vars or existing add-on attachments + --name= name for the add-on resource + --wait watch add-on creation status and exit when complete -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --as=as name for the initial add-on attachment - --confirm=confirm overwrite existing config vars or existing add-on attachments - --name=name name for the add-on resource - --wait watch add-on creation status and exit when complete +DESCRIPTION + create a new add-on resource ``` ## `heroku addons:destroy [ADDON]... [flags]` @@ -84,11 +94,14 @@ permanently destroy an add-on resource USAGE $ heroku addons:destroy [ADDON]... [flags] -OPTIONS - -a, --app=app app to run command against - -c, --confirm=confirm +FLAGS + -a, --app= app to run command against + -c, --confirm= -f, --force allow destruction even if connected to other apps - -r, --remote=remote git remote of app to use + -r, --remote= git remote of app to use + +DESCRIPTION + permanently destroy an add-on resource ``` ## `heroku addons:detach ATTACHMENT_NAME` @@ -97,11 +110,14 @@ detach an existing add-on resource from an app ``` USAGE - $ heroku addons:detach ATTACHMENT_NAME + $ heroku addons:detach ATTACHMENT_NAME -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + detach an existing add-on resource from an app ``` ## `heroku addons:docs ADDON` @@ -110,12 +126,15 @@ open an add-on's Dev Center documentation in your browser ``` USAGE - $ heroku addons:docs ADDON + $ heroku addons:docs ADDON [--show-url] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --show-url show URL, do not open browser +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --show-url show URL, do not open browser + +DESCRIPTION + open an add-on's Dev Center documentation in your browser ``` ## `heroku addons:downgrade ADDON [PLAN]` @@ -124,13 +143,14 @@ change add-on plan ``` USAGE - $ heroku addons:downgrade ADDON [PLAN] + $ heroku addons:downgrade ADDON [PLAN] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use DESCRIPTION + change add-on plan See available plans with `heroku addons:plans SERVICE`. Note that `heroku addons:upgrade` and `heroku addons:downgrade` are the same. @@ -138,10 +158,9 @@ DESCRIPTION https://devcenter.heroku.com/articles/managing-add-ons -EXAMPLE +EXAMPLES Upgrade an add-on by service name: $ heroku addons:upgrade heroku-redis:premium-2 - Upgrade a specific add-on: $ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2 ``` @@ -154,9 +173,12 @@ show detailed add-on resource and attachment information USAGE $ heroku addons:info ADDON -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + show detailed add-on resource and attachment information ``` ## `heroku addons:open ADDON` @@ -165,12 +187,15 @@ open an add-on's dashboard in your browser ``` USAGE - $ heroku addons:open ADDON + $ heroku addons:open ADDON [--show-url] [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --show-url show URL, do not open browser -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --show-url show URL, do not open browser +DESCRIPTION + open an add-on's dashboard in your browser ``` ## `heroku addons:plans SERVICE` @@ -179,10 +204,13 @@ list all available plans for an add-on services ``` USAGE - $ heroku addons:plans SERVICE + $ heroku addons:plans SERVICE [--json] -OPTIONS +FLAGS --json output in json format + +DESCRIPTION + list all available plans for an add-on services ``` ## `heroku addons:rename ADDON NEW_NAME` @@ -193,9 +221,12 @@ rename an add-on USAGE $ heroku addons:rename ADDON NEW_NAME -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + rename an add-on ``` ## `heroku addons:services` @@ -204,10 +235,13 @@ list all available add-on services ``` USAGE - $ heroku addons:services + $ heroku addons:services [--json] -OPTIONS +FLAGS --json output in json format + +DESCRIPTION + list all available add-on services ``` ## `heroku addons:upgrade ADDON [PLAN]` @@ -216,13 +250,14 @@ change add-on plan ``` USAGE - $ heroku addons:upgrade ADDON [PLAN] + $ heroku addons:upgrade ADDON [PLAN] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use DESCRIPTION + change add-on plan See available plans with `heroku addons:plans SERVICE`. Note that `heroku addons:upgrade` and `heroku addons:downgrade` are the same. @@ -230,10 +265,9 @@ DESCRIPTION https://devcenter.heroku.com/articles/managing-add-ons -EXAMPLE +EXAMPLES Upgrade an add-on by service name: $ heroku addons:upgrade heroku-redis:premium-2 - Upgrade a specific add-on: $ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2 ``` @@ -246,8 +280,11 @@ show provisioning status of the add-ons on the app USAGE $ heroku addons:wait ADDON -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --wait-interval=wait-interval how frequently to poll in seconds +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --wait-interval= how frequently to poll in seconds + +DESCRIPTION + show provisioning status of the add-ons on the app ``` diff --git a/docs/apps.md b/docs/apps.md index f9eb0b1d7a..554790eb8c 100644 --- a/docs/apps.md +++ b/docs/apps.md @@ -27,21 +27,24 @@ list your apps ``` USAGE - $ heroku apps + $ heroku apps [-A] [--json] [-s ] [-p] [-t ] + +FLAGS + -A, --all include apps in all teams + -p, --personal list apps in personal account when a default team is set + -s, --space= filter by space + -t, --team= team to use + --json output in json format + +DESCRIPTION + list your apps -OPTIONS - -A, --all include apps in all teams - -p, --personal list apps in personal account when a default team is set - -s, --space=space filter by space - -t, --team=team team to use - --json output in json format EXAMPLES $ heroku apps === My Apps example example2 - === Collaborated Apps theirapp other@owner.name ``` @@ -52,42 +55,41 @@ creates a new app ``` USAGE - $ heroku apps:create [APP] + $ heroku apps:create [APP] [--addons ] [-b ] [-n] [-r ] [-s ] [--space ] + [--region ] [--json] [-t ] ARGUMENTS APP name of app to create -OPTIONS - -b, --buildpack=buildpack buildpack url to use for this app - -n, --no-remote do not create a git remote - -r, --remote=remote the git remote to create, default "heroku" - -s, --stack=stack the stack to create the app on - -t, --team=team team to use - --addons=addons comma-delimited list of addons to install - --json output in json format - --region=region specify region for the app to run in - --space=space the private space to create the app in +FLAGS + -b, --buildpack= buildpack url to use for this app + -n, --no-remote do not create a git remote + -r, --remote= the git remote to create, default "heroku" + -s, --stack= the stack to create the app on + -t, --team= team to use + --addons= comma-delimited list of addons to install + --json output in json format + --region= specify region for the app to run in + --space= the private space to create the app in + +DESCRIPTION + creates a new app + EXAMPLES $ heroku apps:create Creating app... done, stack is heroku-22 https://floating-dragon-42.heroku.com/ | https://git.heroku.com/floating-dragon-42.git - # or just $ heroku create - # use a heroku.yml manifest file $ heroku apps:create --manifest - # specify a buildpack $ heroku apps:create --buildpack https://github.com/some/buildpack.git - # specify a name $ heroku apps:create example - # create a staging app $ heroku apps:create example-staging --remote staging - # create an app in the eu region $ heroku apps:create --region eu ``` @@ -98,14 +100,15 @@ permanently destroy an app ``` USAGE - $ heroku apps:destroy + $ heroku apps:destroy [APP] [-c ] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -c, --confirm= + -r, --remote= git remote of app to use DESCRIPTION + permanently destroy an app This will also destroy all add-ons on the app. ``` @@ -115,15 +118,18 @@ view app errors ``` USAGE - $ heroku apps:errors + $ heroku apps:errors -a [--json] [--hours ] [--router] [--dyno] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --dyno show only dyno errors - --hours=hours number of hours to look back (default 24) - --json output in json format - --router show only router errors +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --dyno show only dyno errors + --hours= number of hours to look back (default 24) + --json output in json format + --router show only router errors + +DESCRIPTION + view app errors ``` ## `heroku apps:favorites` @@ -132,10 +138,13 @@ list favorited apps ``` USAGE - $ heroku apps:favorites + $ heroku apps:favorites [--json] -OPTIONS +FLAGS --json output in json format + +DESCRIPTION + list favorited apps ``` ## `heroku apps:favorites:add` @@ -144,11 +153,14 @@ favorites an app ``` USAGE - $ heroku apps:favorites:add + $ heroku apps:favorites:add -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + favorites an app ``` ## `heroku apps:favorites:remove` @@ -157,11 +169,14 @@ unfavorites an app ``` USAGE - $ heroku apps:favorites:remove + $ heroku apps:favorites:remove -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + unfavorites an app ``` ## `heroku apps:info` @@ -170,15 +185,16 @@ show detailed app information ``` USAGE - $ heroku apps:info + $ heroku apps:info [APP] [-s] [-j] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against +FLAGS + -a, --app= app to run command against -j, --json - -r, --remote=remote git remote of app to use - -s, --shell output more shell friendly key/value pairs + -r, --remote= git remote of app to use + -s, --shell output more shell friendly key/value pairs DESCRIPTION + show detailed app information $ heroku apps:info === example Git URL: https://git.heroku.com/example.git @@ -197,11 +213,14 @@ add yourself to a team app ``` USAGE - $ heroku apps:join + $ heroku apps:join -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + add yourself to a team app ``` ## `heroku apps:leave` @@ -210,11 +229,14 @@ remove yourself from a team app ``` USAGE - $ heroku apps:leave + $ heroku apps:leave -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + remove yourself from a team app ``` ## `heroku apps:lock` @@ -223,11 +245,14 @@ prevent team members from joining an app ``` USAGE - $ heroku apps:lock + $ heroku apps:lock -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + prevent team members from joining an app ``` ## `heroku apps:open [PATH]` @@ -236,16 +261,19 @@ open the app in a web browser ``` USAGE - $ heroku apps:open [PATH] + $ heroku apps:open [PATH] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + open the app in a web browser -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku open -a myapp # opens https://myapp.herokuapp.com - $ heroku open -a myapp /foo # opens https://myapp.herokuapp.com/foo ``` @@ -256,13 +284,14 @@ rename an app ``` USAGE - $ heroku apps:rename NEWNAME + $ heroku apps:rename NEWNAME -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + rename an app This will locally update the git remote if it is set to the old app. EXAMPLES @@ -277,11 +306,14 @@ show the list of available stacks ``` USAGE - $ heroku apps:stacks + $ heroku apps:stacks -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + show the list of available stacks ``` ## `heroku apps:stacks:set STACK` @@ -290,11 +322,15 @@ set the stack of an app ``` USAGE - $ heroku apps:stacks:set STACK + $ heroku apps:stacks:set STACK -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + set the stack of an app -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku stack:set heroku-22 -a myapp @@ -309,24 +345,26 @@ transfer applications to another user or team ``` USAGE - $ heroku apps:transfer RECIPIENT + $ heroku apps:transfer RECIPIENT [-l] [--bulk] [-a ] [-r ] ARGUMENTS RECIPIENT user or team to transfer applications to -OPTIONS - -a, --app=app app to run command against - -l, --locked lock the app upon transfer - -r, --remote=remote git remote of app to use - --bulk transfer applications in bulk +FLAGS + -a, --app= app to run command against + -l, --locked lock the app upon transfer + -r, --remote= git remote of app to use + --bulk transfer applications in bulk + +DESCRIPTION + transfer applications to another user or team + EXAMPLES $ heroku apps:transfer collaborator@example.com Transferring example to collaborator@example.com... done - $ heroku apps:transfer acme-widgets Transferring example to acme-widgets... done - $ heroku apps:transfer --bulk acme-widgets ... ``` @@ -337,9 +375,12 @@ unlock an app so any team member can join ``` USAGE - $ heroku apps:unlock + $ heroku apps:unlock -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + unlock an app so any team member can join ``` diff --git a/docs/authorizations.md b/docs/authorizations.md index 27cad85412..a63888af9c 100644 --- a/docs/authorizations.md +++ b/docs/authorizations.md @@ -5,6 +5,7 @@ OAuth authorizations * [`heroku authorizations`](#heroku-authorizations) * [`heroku authorizations:create`](#heroku-authorizationscreate) +* [`heroku authorizations:destroy ID`](#heroku-authorizationsdestroy-id) * [`heroku authorizations:info ID`](#heroku-authorizationsinfo-id) * [`heroku authorizations:revoke ID`](#heroku-authorizationsrevoke-id) * [`heroku authorizations:rotate ID`](#heroku-authorizationsrotate-id) @@ -16,13 +17,14 @@ list OAuth authorizations ``` USAGE - $ heroku authorizations + $ heroku authorizations [-j] -OPTIONS +FLAGS -j, --json output in json format -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/index.js)_ +DESCRIPTION + list OAuth authorizations +``` ## `heroku authorizations:create` @@ -30,20 +32,36 @@ create a new OAuth authorization ``` USAGE - $ heroku authorizations:create + $ heroku authorizations:create [-d ] [-s ] [-e ] [-S] [-j] -OPTIONS - -S, --short only output token - -d, --description=description set a custom authorization description - -e, --expires-in=expires-in set expiration in seconds (default no expiration) - -j, --json output in json format - -s, --scope=scope set custom OAuth scopes +FLAGS + -S, --short only output token + -d, --description= set a custom authorization description + -e, --expires-in= set expiration in seconds (default no expiration) + -j, --json output in json format + -s, --scope= set custom OAuth scopes DESCRIPTION + create a new OAuth authorization This creates an authorization with access to your Heroku account. ``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/create.js)_ +## `heroku authorizations:destroy ID` + +revoke OAuth authorization + +``` +USAGE + $ heroku authorizations:destroy ID + +DESCRIPTION + revoke OAuth authorization + + +ALIASES + $ heroku authorizations:destroy + $ heroku authorizations:revoke +``` ## `heroku authorizations:info ID` @@ -51,13 +69,14 @@ show an existing OAuth authorization ``` USAGE - $ heroku authorizations:info ID + $ heroku authorizations:info ID [-j] -OPTIONS +FLAGS -j, --json output in json format -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/info.js)_ +DESCRIPTION + show an existing OAuth authorization +``` ## `heroku authorizations:revoke ID` @@ -67,12 +86,15 @@ revoke OAuth authorization USAGE $ heroku authorizations:revoke ID +DESCRIPTION + revoke OAuth authorization + + ALIASES $ heroku authorizations:destroy + $ heroku authorizations:revoke ``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/revoke.js)_ - ## `heroku authorizations:rotate ID` updates an OAuth authorization token @@ -80,9 +102,10 @@ updates an OAuth authorization token ``` USAGE $ heroku authorizations:rotate ID -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/rotate.js)_ +DESCRIPTION + updates an OAuth authorization token +``` ## `heroku authorizations:update ID` @@ -90,12 +113,13 @@ updates an OAuth authorization ``` USAGE - $ heroku authorizations:update ID + $ heroku authorizations:update ID [-d ] [--client-id ] [--client-secret ] -OPTIONS - -d, --description=description set a custom authorization description - --client-id=client-id identifier of OAuth client to set - --client-secret=client-secret secret of OAuth client to set -``` +FLAGS + -d, --description= set a custom authorization description + --client-id= identifier of OAuth client to set + --client-secret= secret of OAuth client to set -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/update.js)_ +DESCRIPTION + updates an OAuth authorization +``` diff --git a/docs/certs.md b/docs/certs.md index c53d9b5d5d..bd8ecb4d93 100644 --- a/docs/certs.md +++ b/docs/certs.md @@ -22,14 +22,15 @@ list SSL certificates for an app ``` USAGE - $ heroku certs + $ heroku certs -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/index.js)_ +DESCRIPTION + list SSL certificates for an app +``` ## `heroku certs:add CRT KEY` @@ -37,40 +38,39 @@ add an SSL certificate to an app ``` USAGE - $ heroku certs:add CRT KEY + $ heroku certs:add CRT KEY -a [--bypass] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --bypass bypass the trust chain completion step +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --bypass bypass the trust chain completion step DESCRIPTION + add an SSL certificate to an app Note: certificates with PEM encoding are also valid EXAMPLES $ heroku certs:add example.com.crt example.com.key - If you require intermediate certificates, refer to this article on merging certificates to get a complete chain: https://help.salesforce.com/s/articleView?id=000333504&type=1 ``` -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/add.js)_ - ## `heroku certs:auto` show ACM status for an app ``` USAGE - $ heroku certs:auto + $ heroku certs:auto -a [--wait] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --wait watch ACM status and display the status when complete -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --wait watch ACM status and display the status when complete -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/index.js)_ +DESCRIPTION + show ACM status for an app +``` ## `heroku certs:auto:disable` @@ -78,14 +78,15 @@ disable ACM for an app ``` USAGE - $ heroku certs:auto:disable + $ heroku certs:auto:disable -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/disable.js)_ +DESCRIPTION + disable ACM for an app +``` ## `heroku certs:auto:enable` @@ -93,15 +94,16 @@ enable ACM status for an app ``` USAGE - $ heroku certs:auto:enable + $ heroku certs:auto:enable -a [--wait] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --wait watch ACM status and exit when complete -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --wait watch ACM status and exit when complete -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/enable.js)_ +DESCRIPTION + enable ACM status for an app +``` ## `heroku certs:auto:refresh` @@ -109,14 +111,15 @@ refresh ACM for an app ``` USAGE - $ heroku certs:auto:refresh + $ heroku certs:auto:refresh -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/refresh.js)_ +DESCRIPTION + refresh ACM for an app +``` ## `heroku certs:chain` @@ -124,14 +127,15 @@ print an ordered & complete chain for a certificate ``` USAGE - $ heroku certs:chain + $ heroku certs:chain -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/chain.js)_ +DESCRIPTION + print an ordered & complete chain for a certificate +``` ## `heroku certs:generate DOMAIN` @@ -139,21 +143,23 @@ generate a key and a CSR or self-signed certificate ``` USAGE - $ heroku certs:generate DOMAIN - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --area=area sub-country area (state, province, etc.) of owner - --city=city city of owner - --country=country country of owner, as a two-letter ISO country code - --keysize=keysize RSA key size in bits (default: 2048) - --now do not prompt for any owner information - --owner=owner name of organization certificate belongs to - --selfsigned generate a self-signed certificate instead of a CSR - --subject=subject specify entire certificate subject + $ heroku certs:generate DOMAIN -a [--selfsigned] [--keysize ] [--owner ] [--country ] + [--area ] [--city ] [--subject ] [--now] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --area= sub-country area (state, province, etc.) of owner + --city= city of owner + --country= country of owner, as a two-letter ISO country code + --keysize= RSA key size in bits (default: 2048) + --now do not prompt for any owner information + --owner= name of organization certificate belongs to + --selfsigned generate a self-signed certificate instead of a CSR + --subject= specify entire certificate subject DESCRIPTION + generate a key and a CSR or self-signed certificate Generate a key and certificate signing request (or self-signed certificate) for an app. Prompts for information to put in the certificate unless --now is used, or at least one of the --subject, --owner, --country, --area, or @@ -163,25 +169,24 @@ EXAMPLES $ heroku certs:generate example.com ``` -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/generate.js)_ - ## `heroku certs:info` show certificate information for an SSL certificate ``` USAGE - $ heroku certs:info + $ heroku certs:info -a [--name ] [--endpoint ] [--show-domains] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --endpoint=endpoint endpoint to check info on - --name=name name to check info on - --show-domains show associated domains -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --endpoint= endpoint to check info on + --name= name to check info on + --show-domains show associated domains -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/info.js)_ +DESCRIPTION + show certificate information for an SSL certificate +``` ## `heroku certs:key` @@ -189,13 +194,14 @@ print the correct key for the given certificate ``` USAGE - $ heroku certs:key + $ heroku certs:key -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + print the correct key for the given certificate You must pass one single certificate, and one or more keys. The first key that signs the certificate will be printed back. @@ -203,24 +209,23 @@ EXAMPLES $ heroku certs:key example.com.crt example.com.key ``` -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/key.js)_ - ## `heroku certs:remove` remove an SSL certificate from an app ``` USAGE - $ heroku certs:remove + $ heroku certs:remove -a [--name ] [--endpoint ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --endpoint=endpoint endpoint to remove - --name=name name to remove -``` +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --endpoint= endpoint to remove + --name= name to remove -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/remove.js)_ +DESCRIPTION + remove an SSL certificate from an app +``` ## `heroku certs:update CRT KEY` @@ -228,23 +233,21 @@ update an SSL certificate on an app ``` USAGE - $ heroku certs:update CRT KEY + $ heroku certs:update CRT KEY -a [--bypass] [--name ] [--endpoint ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --bypass bypass the trust chain completion step - --endpoint=endpoint endpoint to update - --name=name name to update +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --bypass bypass the trust chain completion step + --endpoint= endpoint to update + --name= name to update DESCRIPTION + update an SSL certificate on an app Note: certificates with PEM encoding are also valid EXAMPLES $ heroku certs:update example.com.crt example.com.key - If you require intermediate certificates, refer to this article on merging certificates to get a complete chain: https://help.salesforce.com/s/articleView?id=000333504&type=1 ``` - -_See code: [@heroku-cli/plugin-certs-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/update.js)_ diff --git a/docs/ci.md b/docs/ci.md index 6c7f128634..f944d298e8 100644 --- a/docs/ci.md +++ b/docs/ci.md @@ -22,39 +22,41 @@ display the most recent CI runs for the given pipeline ``` USAGE - $ heroku ci + $ heroku ci [-a ] [--watch] [-p ] [--json] -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline - --json output in json format - --watch keep running and watch for new and update tests +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline + --json output in json format + --watch keep running and watch for new and update tests -EXAMPLE +DESCRIPTION + display the most recent CI runs for the given pipeline + +EXAMPLES $ heroku ci --app murmuring-headland-14719 ``` -_See code: [@heroku-cli/plugin-ci](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/index.ts)_ - ## `heroku ci:config` display CI config vars ``` USAGE - $ heroku ci:config + $ heroku ci:config [-s] [--json] [-p ] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -p, --pipeline=pipeline pipeline - -r, --remote=remote git remote of app to use - -s, --shell output config vars in shell format - --json output config vars in json format +FLAGS + -a, --app= app to run command against + -p, --pipeline= pipeline + -r, --remote= git remote of app to use + -s, --shell output config vars in shell format + --json output config vars in json format DESCRIPTION + display CI config vars Example: - $ heroku ci:config --app murmuring-headland-14719 --json + $ heroku ci:config --app murmuring-headland-14719 --json ``` ## `heroku ci:config:get KEY` @@ -63,19 +65,20 @@ get a CI config var ``` USAGE - $ heroku ci:config:get KEY + $ heroku ci:config:get KEY [-s] [-p ] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -p, --pipeline=pipeline pipeline - -r, --remote=remote git remote of app to use - -s, --shell output config var in shell format +FLAGS + -a, --app= app to run command against + -p, --pipeline= pipeline + -r, --remote= git remote of app to use + -s, --shell output config var in shell format DESCRIPTION + get a CI config var Examples: - $ heroku ci:config:get RAILS_ENV - test + $ heroku ci:config:get RAILS_ENV + test ``` ## `heroku ci:config:set` @@ -84,20 +87,21 @@ set CI config vars ``` USAGE - $ heroku ci:config:set + $ heroku ci:config:set [-p ] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -p, --pipeline=pipeline pipeline - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -p, --pipeline= pipeline + -r, --remote= git remote of app to use DESCRIPTION + set CI config vars Examples: - $ heroku ci:config:set RAILS_ENV=test - Setting test config vars... done + $ heroku ci:config:set RAILS_ENV=test + Setting test config vars... done - RAILS_ENV: test + RAILS_ENV: test ``` ## `heroku ci:config:unset` @@ -106,18 +110,19 @@ unset CI config vars ``` USAGE - $ heroku ci:config:unset + $ heroku ci:config:unset [-p ] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -p, --pipeline=pipeline pipeline - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -p, --pipeline= pipeline + -r, --remote= git remote of app to use DESCRIPTION + unset CI config vars Examples: - $ heroku ci:config:uset RAILS_ENV - Unsetting RAILS_ENV... done + $ heroku ci:config:uset RAILS_ENV + Unsetting RAILS_ENV... done ``` ## `heroku ci:debug` @@ -126,22 +131,23 @@ opens an interactive test debugging session with the contents of the current dir ``` USAGE - $ heroku ci:debug + $ heroku ci:debug [--no-setup] [-p ] [--no-cache] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -p, --pipeline=pipeline pipeline - -r, --remote=remote git remote of app to use - --no-cache start test run with an empty cache - --no-setup start test dyno without running test-setup +FLAGS + -a, --app= app to run command against + -p, --pipeline= pipeline + -r, --remote= git remote of app to use + --no-cache start test run with an empty cache + --no-setup start test dyno without running test-setup DESCRIPTION + opens an interactive test debugging session with the contents of the current directory Example: - $ heroku ci:debug - Preparing source... done - Creating test run... done - Running setup and attaching to test dyno... + $ heroku ci:debug + Preparing source... done + Creating test run... done + Running setup and attaching to test dyno... ~ $ ``` @@ -152,38 +158,40 @@ show the status of a specific test run ``` USAGE - $ heroku ci:info TEST-RUN + $ heroku ci:info TEST-RUN [-a ] [--node ] [-p ] -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline - --node=node the node number to show its setup and output +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline + --node= the node number to show its setup and output -EXAMPLE +DESCRIPTION + show the status of a specific test run + +EXAMPLES $ heroku ci:info 1288 --app murmuring-headland-14719 ``` -_See code: [@heroku-cli/plugin-ci](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/info.ts)_ - ## `heroku ci:last` looks for the most recent run and returns the output of that run ``` USAGE - $ heroku ci:last + $ heroku ci:last [-a ] [--node ] [-p ] -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline - --node=node the node number to show its setup and output +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline + --node= the node number to show its setup and output + +DESCRIPTION + looks for the most recent run and returns the output of that run -EXAMPLE +EXAMPLES $ heroku ci:last --pipeline=my-pipeline --node 100 ``` -_See code: [@heroku-cli/plugin-ci](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/last.ts)_ - ## `heroku ci:migrate-manifest` app-ci.json is deprecated. Run this command to migrate to app.json with an environments key. @@ -193,13 +201,14 @@ USAGE $ heroku ci:migrate-manifest DESCRIPTION + app-ci.json is deprecated. Run this command to migrate to app.json with an environments key. Example: - $ heroku ci:migrate-manifest - Writing app.json file... done - Deleting app-ci.json file... done - Please check the contents of your app.json before committing to your repo - You're all set! 🎉. + $ heroku ci:migrate-manifest + Writing app.json file... done + Deleting app-ci.json file... done + Please check the contents of your app.json before committing to your repo + You're all set! 🎉. ``` ## `heroku ci:open` @@ -208,19 +217,20 @@ open the Dashboard version of Heroku CI ``` USAGE - $ heroku ci:open + $ heroku ci:open [-p ] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -p, --pipeline=pipeline pipeline - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -p, --pipeline= pipeline + -r, --remote= git remote of app to use DESCRIPTION + open the Dashboard version of Heroku CI opens a browser to view the Dashboard version of Heroku CI - Example: + Example: - $ heroku ci:open --app murmuring-headland-14719 + $ heroku ci:open --app murmuring-headland-14719 ``` ## `heroku ci:rerun [NUMBER]` @@ -229,32 +239,34 @@ rerun tests against current directory ``` USAGE - $ heroku ci:rerun [NUMBER] + $ heroku ci:rerun [NUMBER] [-a ] [-p ] -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline + +DESCRIPTION + rerun tests against current directory -EXAMPLE +EXAMPLES $ heroku ci:rerun 985 --app murmuring-headland-14719 ``` -_See code: [@heroku-cli/plugin-ci](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/rerun.ts)_ - ## `heroku ci:run` run tests against current directory ``` USAGE - $ heroku ci:run + $ heroku ci:run [-a ] [-p ] + +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline +DESCRIPTION + run tests against current directory -EXAMPLE +EXAMPLES $ heroku ci:run --app murmuring-headland-14719 ``` - -_See code: [@heroku-cli/plugin-ci](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/run.ts)_ diff --git a/docs/clients.md b/docs/clients.md index 2e8617c9e4..3a381e41af 100644 --- a/docs/clients.md +++ b/docs/clients.md @@ -16,13 +16,14 @@ list your OAuth clients ``` USAGE - $ heroku clients + $ heroku clients [-j] -OPTIONS +FLAGS -j, --json output in json format -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/index.js)_ +DESCRIPTION + list your OAuth clients +``` ## `heroku clients:create NAME REDIRECT_URI` @@ -30,14 +31,15 @@ create a new OAuth client ``` USAGE - $ heroku clients:create NAME REDIRECT_URI + $ heroku clients:create NAME REDIRECT_URI [-s] [-j] -OPTIONS +FLAGS -j, --json output in json format -s, --shell output in shell format -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/create.js)_ +DESCRIPTION + create a new OAuth client +``` ## `heroku clients:destroy ID` @@ -46,9 +48,10 @@ delete client by ID ``` USAGE $ heroku clients:destroy ID -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/destroy.js)_ +DESCRIPTION + delete client by ID +``` ## `heroku clients:info ID` @@ -56,14 +59,15 @@ show details of an oauth client ``` USAGE - $ heroku clients:info ID + $ heroku clients:info ID [-j] [-s] -OPTIONS +FLAGS -j, --json output in json format -s, --shell output in shell format -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/info.js)_ +DESCRIPTION + show details of an oauth client +``` ## `heroku clients:rotate ID` @@ -71,14 +75,15 @@ rotate OAuth client secret ``` USAGE - $ heroku clients:rotate ID + $ heroku clients:rotate ID [-j] [-s] -OPTIONS +FLAGS -j, --json output in json format -s, --shell output in shell format -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/rotate.js)_ +DESCRIPTION + rotate OAuth client secret +``` ## `heroku clients:update ID` @@ -86,11 +91,12 @@ update OAuth client ``` USAGE - $ heroku clients:update ID + $ heroku clients:update ID [-n ] [--url ] -OPTIONS - -n, --name=name change the client name - --url=url change the client redirect URL -``` +FLAGS + -n, --name= change the client name + --url= change the client redirect URL -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/update.js)_ +DESCRIPTION + update OAuth client +``` diff --git a/docs/config.md b/docs/config.md index 69ccfd15cf..9604437cd1 100644 --- a/docs/config.md +++ b/docs/config.md @@ -3,124 +3,30 @@ environment variables of apps -* [`heroku config`](#heroku-config) -* [`heroku config:edit [KEY]`](#heroku-configedit-key) -* [`heroku config:get KEY...`](#heroku-configget-key) * [`heroku config:set`](#heroku-configset) -* [`heroku config:unset`](#heroku-configunset) -## `heroku config` - -display the config vars for an app - -``` -USAGE - $ heroku config - -OPTIONS - -a, --app=app (required) app to run command against - -j, --json output config vars in json format - -r, --remote=remote git remote of app to use - -s, --shell output config vars in shell format -``` - -_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/index.ts)_ - -## `heroku config:edit [KEY]` +## `heroku config:set` -interactively edit config vars +set one or more config vars ``` USAGE - $ heroku config:edit [KEY] - -ARGUMENTS - KEY edit a single key + $ heroku config:set -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION - This command opens the app config in a text editor set by $VISUAL or $EDITOR. - Any variables added/removed/changed will be updated on the app after saving and closing the file. - -EXAMPLES - # edit with vim - $ EDITOR="vim" heroku config:edit - # edit with emacs - $ EDITOR="emacs" heroku config:edit - # edit with pico - $ EDITOR="pico" heroku config:edit - # edit with atom editor - $ VISUAL="atom --wait" heroku config:edit -``` - -_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/edit.ts)_ - -## `heroku config:get KEY...` - -display a single config value for an app - -``` -USAGE - $ heroku config:get KEY... - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --shell output config vars in shell format - -EXAMPLES - $ heroku config:get RAILS_ENV - production -``` - -_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/get.ts)_ + set one or more config vars -## `heroku config:set` - -set one or more config vars - -``` -USAGE - $ heroku config:set - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku config:set RAILS_ENV=staging Setting config vars and restarting example... done, v10 RAILS_ENV: staging - $ heroku config:set RAILS_ENV=staging RACK_ENV=staging Setting config vars and restarting example... done, v11 RAILS_ENV: staging RACK_ENV: staging ``` - -## `heroku config:unset` - -unset one or more config vars - -``` -USAGE - $ heroku config:unset - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -ALIASES - $ heroku config:remove - -EXAMPLES - $ heroku config:unset RAILS_ENV - Unsetting RAILS_ENV and restarting example... done, v10 - $ heroku config:unset RAILS_ENV RACK_ENV - Unsetting RAILS_ENV, RACK_ENV and restarting example... done, v10 -``` - -_See code: [@heroku-cli/plugin-config](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/unset.ts)_ diff --git a/docs/container.md b/docs/container.md index f8e00fd9bf..8a3fe6da46 100644 --- a/docs/container.md +++ b/docs/container.md @@ -19,6 +19,9 @@ Use containers to build and deploy Heroku apps ``` USAGE $ heroku container + +DESCRIPTION + Use containers to build and deploy Heroku apps ``` ## `heroku container:login` @@ -27,14 +30,15 @@ log in to Heroku Container Registry ``` USAGE - $ heroku container:login + $ heroku container:login [-v] -OPTIONS +FLAGS -v, --verbose DESCRIPTION + log in to Heroku Container Registry Usage: - heroku container:login + heroku container:login ``` ## `heroku container:logout` @@ -43,10 +47,13 @@ log out from Heroku Container Registry ``` USAGE - $ heroku container:logout + $ heroku container:logout [-v] -OPTIONS +FLAGS -v, --verbose + +DESCRIPTION + log out from Heroku Container Registry ``` ## `heroku container:pull` @@ -55,18 +62,20 @@ pulls an image from an app's process type ``` USAGE - $ heroku container:pull + $ heroku container:pull -a [-v] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -v, --verbose DESCRIPTION + pulls an image from an app's process type + Usage: - heroku container:pull web # Pulls the web image from the app - heroku container:pull web worker # Pulls both the web and worker images from the app - heroku container:pull web:latest # Pulls the latest tag from the web image + heroku container:pull web # Pulls the web image from the app + heroku container:pull web worker # Pulls both the web and worker images from the app + heroku container:pull web:latest # Pulls the latest tag from the web image ``` ## `heroku container:push` @@ -75,22 +84,31 @@ builds, then pushes Docker images to deploy your Heroku app ``` USAGE - $ heroku container:push + $ heroku container:push -a [-v] [-R] [--arg ] [--context-path ] [-r ] -OPTIONS - -R, --recursive pushes Dockerfile. found in current and subdirectories - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -R, --recursive pushes Dockerfile. found in current and subdirectories + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -v, --verbose - --arg=arg set build-time variables - --context-path=context-path path to use as build context (defaults to Dockerfile dir) + --arg= set build-time variables + --context-path= path to use as build context (defaults to Dockerfile dir) + +DESCRIPTION + builds, then pushes Docker images to deploy your Heroku app + EXAMPLES heroku container:push web # Pushes Dockerfile to web process type + heroku container:push worker # Pushes Dockerfile to worker process type + heroku container:push web worker --recursive # Pushes Dockerfile.web and Dockerfile.worker + heroku container:push --recursive # Pushes Dockerfile.* + heroku container:push web --arg ENV=live,HTTPS=on # Build-time variables + heroku container:push --recursive --context-path . # Pushes Dockerfile.* using current dir as build context ``` @@ -100,17 +118,19 @@ Releases previously pushed Docker images to your Heroku app ``` USAGE - $ heroku container:release + $ heroku container:release -a [-v] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -v, --verbose DESCRIPTION + Releases previously pushed Docker images to your Heroku app + Usage: - heroku container:release web # Releases the previously pushed web process type - heroku container:release web worker # Releases the previously pushed web and worker process types + heroku container:release web # Releases the previously pushed web process type + heroku container:release web worker # Releases the previously pushed web and worker process types ``` ## `heroku container:rm` @@ -119,16 +139,18 @@ remove the process type from your app ``` USAGE - $ heroku container:rm + $ heroku container:rm -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + remove the process type from your app + Usage: - heroku container:rm web # Destroys the web container - heroku container:rm web worker # Destroys the web and worker containers + heroku container:rm web # Destroys the web container + heroku container:rm web worker # Destroys the web and worker containers ``` ## `heroku container:run` @@ -137,16 +159,18 @@ builds, then runs the docker image locally ``` USAGE - $ heroku container:run + $ heroku container:run -a [-p ] [-v] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -p, --port=port port the app will run on - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -p, --port= port the app will run on + -r, --remote= git remote of app to use -v, --verbose DESCRIPTION + builds, then runs the docker image locally + Usage: - heroku container:run web bash # Runs bash on the local web docker container - heroku container:run worker # Runs the container CMD on the local worker container + heroku container:run web bash # Runs bash on the local web docker container + heroku container:run worker # Runs the container CMD on the local worker container ``` diff --git a/docs/drains.md b/docs/drains.md index af3648e081..aa2f1b37dd 100644 --- a/docs/drains.md +++ b/docs/drains.md @@ -13,12 +13,15 @@ display the log drains of an app ``` USAGE - $ heroku drains + $ heroku drains -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format + +DESCRIPTION + display the log drains of an app ``` ## `heroku drains:add URL` @@ -27,11 +30,14 @@ adds a log drain to an app ``` USAGE - $ heroku drains:add URL + $ heroku drains:add URL -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + adds a log drain to an app ``` ## `heroku drains:remove [URL|TOKEN]` @@ -42,7 +48,10 @@ removes a log drain from an app USAGE $ heroku drains:remove [URL|TOKEN] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + removes a log drain from an app ``` diff --git a/docs/features.md b/docs/features.md index b8dfcb0fa5..0742af62e4 100644 --- a/docs/features.md +++ b/docs/features.md @@ -14,12 +14,15 @@ list available app features ``` USAGE - $ heroku features + $ heroku features -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format + +DESCRIPTION + list available app features ``` ## `heroku features:disable FEATURE` @@ -28,11 +31,14 @@ disables an app feature ``` USAGE - $ heroku features:disable FEATURE + $ heroku features:disable FEATURE -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + disables an app feature ``` ## `heroku features:enable FEATURE` @@ -41,11 +47,14 @@ enables an app feature ``` USAGE - $ heroku features:enable FEATURE + $ heroku features:enable FEATURE -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + enables an app feature ``` ## `heroku features:info FEATURE` @@ -54,10 +63,13 @@ display information about a feature ``` USAGE - $ heroku features:info FEATURE + $ heroku features:info FEATURE -a [--json] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +DESCRIPTION + display information about a feature ``` diff --git a/docs/help.md b/docs/help.md index f0d31cdaf1..6650b66cea 100644 --- a/docs/help.md +++ b/docs/help.md @@ -1,23 +1,24 @@ `heroku help` ============= -display help for heroku +Display help for heroku. -* [`heroku help [COMMAND]`](#heroku-help-command) +* [`heroku help [COMMANDS]`](#heroku-help-commands) -## `heroku help [COMMAND]` +## `heroku help [COMMANDS]` -display help for heroku +Display help for heroku. ``` USAGE - $ heroku help [COMMAND] + $ heroku help [COMMANDS] [-n] ARGUMENTS - COMMAND command to show help for + COMMANDS Command to show help for. -OPTIONS - --all see all commands in CLI -``` +FLAGS + -n, --nested-commands Include all nested commands in the output. -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.0/src/commands/help.ts)_ +DESCRIPTION + Display help for heroku. +``` diff --git a/docs/keys.md b/docs/keys.md index 66196609f5..c39ef633ab 100644 --- a/docs/keys.md +++ b/docs/keys.md @@ -14,11 +14,14 @@ display your SSH keys ``` USAGE - $ heroku keys + $ heroku keys [-l] [--json] -OPTIONS +FLAGS -l, --long display full SSH keys --json output in json format + +DESCRIPTION + display your SSH keys ``` ## `heroku keys:add [KEY]` @@ -27,12 +30,13 @@ add an SSH key for a user ``` USAGE - $ heroku keys:add [KEY] + $ heroku keys:add [KEY] [-y] -OPTIONS +FLAGS -y, --yes automatically answer yes for all prompts DESCRIPTION + add an SSH key for a user if no KEY is specified, will try to find ~/.ssh/id_rsa.pub EXAMPLES @@ -41,7 +45,6 @@ EXAMPLES Would you like to generate one? [Yn] y Generating new SSH public key. Uploading SSH public key /.ssh/id_rsa.pub... done - $ heroku keys:add /my/key.pub Uploading SSH public key /my/key.pub... done ``` @@ -53,6 +56,9 @@ remove all SSH keys for current user ``` USAGE $ heroku keys:clear + +DESCRIPTION + remove all SSH keys for current user ``` ## `heroku keys:remove KEY` @@ -63,6 +69,10 @@ remove an SSH key from the user USAGE $ heroku keys:remove KEY +DESCRIPTION + remove an SSH key from the user + + EXAMPLES $ heroku keys:remove email@example.com Removing email@example.com SSH key... done diff --git a/docs/labs.md b/docs/labs.md index 051a1598b5..4ccb86168c 100644 --- a/docs/labs.md +++ b/docs/labs.md @@ -4,7 +4,6 @@ add/remove experimental features * [`heroku labs`](#heroku-labs) -* [`heroku labs:disable [FEATURE]`](#heroku-labsdisable-feature) * [`heroku labs:enable FEATURE`](#heroku-labsenable-feature) * [`heroku labs:info FEATURE`](#heroku-labsinfo-feature) @@ -14,29 +13,16 @@ list experimental features ``` USAGE - $ heroku labs + $ heroku labs [--json] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --json display as json -``` - -## `heroku labs:disable [FEATURE]` - -disables an experimental feature +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --json display as json +DESCRIPTION + list experimental features ``` -USAGE - $ heroku labs:disable [FEATURE] - -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --confirm=confirm -``` - -_See code: [@heroku-cli/plugin-auth](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/labs/disable.ts)_ ## `heroku labs:enable FEATURE` @@ -44,11 +30,14 @@ enables an experimental feature ``` USAGE - $ heroku labs:enable FEATURE + $ heroku labs:enable FEATURE [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + enables an experimental feature ``` ## `heroku labs:info FEATURE` @@ -57,10 +46,13 @@ show feature info ``` USAGE - $ heroku labs:info FEATURE + $ heroku labs:info FEATURE [--json] [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --json display as json -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --json display as json +DESCRIPTION + show feature info ``` diff --git a/docs/local.md b/docs/local.md index f83a6d2608..325b9de4a2 100644 --- a/docs/local.md +++ b/docs/local.md @@ -5,6 +5,7 @@ run Heroku app locally * [`heroku local [PROCESSNAME]`](#heroku-local-processname) * [`heroku local:run`](#heroku-localrun) +* [`heroku local:start [PROCESSNAME]`](#heroku-localstart-processname) * [`heroku local:version`](#heroku-localversion) ## `heroku local [PROCESSNAME]` @@ -13,45 +14,72 @@ run heroku app locally ``` USAGE - $ heroku local [PROCESSNAME] + $ heroku local [PROCESSNAME] [-f ] [-e ] [-p ] -OPTIONS - -e, --env=env location of env file (defaults to .env) - -f, --procfile=procfile use a different Procfile - -p, --port=port port to listen on +FLAGS + -e, --env= location of env file (defaults to .env) + -f, --procfile= use a different Procfile + -p, --port= port to listen on DESCRIPTION + run heroku app locally Start the application specified by a Procfile (defaults to ./Procfile) ALIASES $ heroku local:start -EXAMPLE +EXAMPLES $ heroku local $ heroku local web $ heroku local web=2 $ heroku local web=1,worker=2 ``` -_See code: [@heroku-cli/plugin-local](https://github.com/heroku/cli/blob/v7.69.0/src/commands/local/index.ts)_ - ## `heroku local:run` run a one-off command ``` USAGE - $ heroku local:run + $ heroku local:run [-e ] [-p ] + +FLAGS + -e, --env= + -p, --port= [default: 5001] -OPTIONS - -e, --env=env - -p, --port=port [default: 5001] +DESCRIPTION + run a one-off command -EXAMPLE +EXAMPLES $ heroku local:run bin/migrate ``` -_See code: [@heroku-cli/plugin-local](https://github.com/heroku/cli/blob/v7.69.0/src/commands/local/run.ts)_ +## `heroku local:start [PROCESSNAME]` + +run heroku app locally + +``` +USAGE + $ heroku local:start [PROCESSNAME] [-f ] [-e ] [-p ] + +FLAGS + -e, --env= location of env file (defaults to .env) + -f, --procfile= use a different Procfile + -p, --port= port to listen on + +DESCRIPTION + run heroku app locally + Start the application specified by a Procfile (defaults to ./Procfile) + +ALIASES + $ heroku local:start + +EXAMPLES + $ heroku local + $ heroku local web + $ heroku local web=2 + $ heroku local web=1,worker=2 +``` ## `heroku local:version` @@ -60,6 +88,7 @@ display node-foreman version ``` USAGE $ heroku local:version -``` -_See code: [@heroku-cli/plugin-local](https://github.com/heroku/cli/blob/v7.69.0/src/commands/local/version.ts)_ +DESCRIPTION + display node-foreman version +``` diff --git a/docs/maintenance.md b/docs/maintenance.md index 5e0f6042e6..4279b81655 100644 --- a/docs/maintenance.md +++ b/docs/maintenance.md @@ -13,11 +13,14 @@ display the current maintenance status of app ``` USAGE - $ heroku maintenance + $ heroku maintenance -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + display the current maintenance status of app ``` ## `heroku maintenance:off` @@ -26,11 +29,14 @@ take the app out of maintenance mode ``` USAGE - $ heroku maintenance:off + $ heroku maintenance:off -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + take the app out of maintenance mode ``` ## `heroku maintenance:on` @@ -39,9 +45,12 @@ put the app into maintenance mode ``` USAGE - $ heroku maintenance:on + $ heroku maintenance:on -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + put the app into maintenance mode ``` diff --git a/docs/members.md b/docs/members.md index b04861ed45..a9e63c8e95 100644 --- a/docs/members.md +++ b/docs/members.md @@ -14,13 +14,16 @@ list members of a team ``` USAGE - $ heroku members + $ heroku members [-r ] [--pending] [--json] [-t ] -OPTIONS - -r, --role=role filter by role - -t, --team=team team to use - --json output in json format - --pending filter by pending team invitations +FLAGS + -r, --role= filter by role + -t, --team= team to use + --json output in json format + --pending filter by pending team invitations + +DESCRIPTION + list members of a team ``` ## `heroku members:add EMAIL` @@ -29,11 +32,14 @@ adds a user to a team ``` USAGE - $ heroku members:add EMAIL + $ heroku members:add EMAIL -r [-t ] + +FLAGS + -r, --role= (required) member role (admin, collaborator, member, owner) + -t, --team= team to use -OPTIONS - -r, --role=role (required) member role (admin, collaborator, member, owner) - -t, --team=team team to use +DESCRIPTION + adds a user to a team ``` ## `heroku members:remove EMAIL` @@ -42,10 +48,13 @@ removes a user from a team ``` USAGE - $ heroku members:remove EMAIL + $ heroku members:remove EMAIL [-t ] -OPTIONS - -t, --team=team team to use +FLAGS + -t, --team= team to use + +DESCRIPTION + removes a user from a team ``` ## `heroku members:set EMAIL` @@ -54,9 +63,12 @@ sets a members role in a team ``` USAGE - $ heroku members:set EMAIL + $ heroku members:set EMAIL -r [-t ] + +FLAGS + -r, --role= (required) member role (admin, collaborator, member, owner) + -t, --team= team to use -OPTIONS - -r, --role=role (required) member role (admin, collaborator, member, owner) - -t, --team=team team to use +DESCRIPTION + sets a members role in a team ``` diff --git a/docs/orgs.md b/docs/orgs.md index cd59ddecd4..06bd479990 100644 --- a/docs/orgs.md +++ b/docs/orgs.md @@ -12,11 +12,14 @@ list the teams that you are a member of ``` USAGE - $ heroku orgs + $ heroku orgs [--json] [--enterprise] -OPTIONS +FLAGS --enterprise filter by enterprise teams --json output in json format + +DESCRIPTION + list the teams that you are a member of ``` ## `heroku orgs:open` @@ -25,8 +28,11 @@ open the team interface in a browser window ``` USAGE - $ heroku orgs:open + $ heroku orgs:open [-t ] + +FLAGS + -t, --team= team to use -OPTIONS - -t, --team=team team to use +DESCRIPTION + open the team interface in a browser window ``` diff --git a/docs/pg.md b/docs/pg.md index 5dffb6b5d3..1ffadf3e97 100644 --- a/docs/pg.md +++ b/docs/pg.md @@ -59,11 +59,14 @@ show database information ``` USAGE - $ heroku pg [DATABASE] + $ heroku pg [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + show database information ``` ## `heroku pg:backups` @@ -72,11 +75,14 @@ list database backups ``` USAGE - $ heroku pg:backups + $ heroku pg:backups -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + list database backups ``` ## `heroku pg:backups:cancel [BACKUP_ID]` @@ -85,11 +91,14 @@ cancel an in-progress backup or restore (default newest) ``` USAGE - $ heroku pg:backups:cancel [BACKUP_ID] + $ heroku pg:backups:cancel [BACKUP_ID] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + cancel an in-progress backup or restore (default newest) ``` ## `heroku pg:backups:capture [DATABASE]` @@ -98,13 +107,16 @@ capture a new backup ``` USAGE - $ heroku pg:backups:capture [DATABASE] + $ heroku pg:backups:capture [DATABASE] -a [--wait-interval ] [-v] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -v, --verbose - --wait-interval=wait-interval + --wait-interval= + +DESCRIPTION + capture a new backup ``` ## `heroku pg:backups:delete BACKUP_ID` @@ -113,12 +125,15 @@ delete a backup ``` USAGE - $ heroku pg:backups:delete BACKUP_ID + $ heroku pg:backups:delete BACKUP_ID -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + +DESCRIPTION + delete a backup ``` ## `heroku pg:backups:download [BACKUP_ID]` @@ -127,12 +142,15 @@ downloads database backup ``` USAGE - $ heroku pg:backups:download [BACKUP_ID] + $ heroku pg:backups:download [BACKUP_ID] -a [-o ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -o, --output=output location to download to. Defaults to latest.dump - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -o, --output= location to download to. Defaults to latest.dump + -r, --remote= git remote of app to use + +DESCRIPTION + downloads database backup ``` ## `heroku pg:backups:info [BACKUP_ID]` @@ -141,11 +159,14 @@ get information about a specific backup ``` USAGE - $ heroku pg:backups:info [BACKUP_ID] + $ heroku pg:backups:info [BACKUP_ID] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + get information about a specific backup ``` ## `heroku pg:backups:restore [BACKUP] [DATABASE]` @@ -154,17 +175,19 @@ restore a backup (default latest) to a database ``` USAGE - $ heroku pg:backups:restore [BACKUP] [DATABASE] + $ heroku pg:backups:restore [BACKUP] [DATABASE] -a [--wait-interval ] [-e ] [-v] [-c ] + [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -e, --extensions=extensions comma-separated list of extensions to pre-install in the public schema - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -e, --extensions= comma-separated list of extensions to pre-install in the public schema + -r, --remote= git remote of app to use -v, --verbose - --wait-interval=wait-interval + --wait-interval= DESCRIPTION + restore a backup (default latest) to a database defaults to saving the latest database to DATABASE_URL ``` @@ -174,14 +197,16 @@ schedule daily backups for given database ``` USAGE - $ heroku pg:backups:schedule [DATABASE] + $ heroku pg:backups:schedule [DATABASE] --at -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --at= (required) at a specific (24h) hour in the given timezone. Defaults to UTC. --at '[HOUR]:00 + [TIMEZONE]' - --at=at (required) at a specific (24h) hour in the given timezone. Defaults to UTC. --at '[HOUR]:00 - [TIMEZONE]' +DESCRIPTION + schedule daily backups for given database ``` ## `heroku pg:backups:schedules` @@ -190,11 +215,14 @@ list backup schedule ``` USAGE - $ heroku pg:backups:schedules + $ heroku pg:backups:schedules -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + list backup schedule ``` ## `heroku pg:backups:unschedule [DATABASE]` @@ -203,11 +231,14 @@ stop daily backups ``` USAGE - $ heroku pg:backups:unschedule [DATABASE] + $ heroku pg:backups:unschedule [DATABASE] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + stop daily backups ``` ## `heroku pg:backups:url [BACKUP_ID]` @@ -216,11 +247,14 @@ get secret but publicly accessible URL of a backup ``` USAGE - $ heroku pg:backups:url [BACKUP_ID] + $ heroku pg:backups:url [BACKUP_ID] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + get secret but publicly accessible URL of a backup ``` ## `heroku pg:bloat [DATABASE]` @@ -229,11 +263,14 @@ show table and index bloat in your database ordered by most wasteful ``` USAGE - $ heroku pg:bloat [DATABASE] + $ heroku pg:bloat [DATABASE] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + show table and index bloat in your database ordered by most wasteful ``` ## `heroku pg:blocking [DATABASE]` @@ -242,11 +279,14 @@ display queries holding locks other queries are waiting to be released ``` USAGE - $ heroku pg:blocking [DATABASE] + $ heroku pg:blocking [DATABASE] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + display queries holding locks other queries are waiting to be released ``` ## `heroku pg:connection-pooling:attach [DATABASE]` @@ -255,17 +295,18 @@ add an attachment to a database using connection pooling ``` USAGE - $ heroku pg:connection-pooling:attach [DATABASE] + $ heroku pg:connection-pooling:attach [DATABASE] -a [--as ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --as=as name for add-on attachment +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --as= name for add-on attachment DESCRIPTION + add an attachment to a database using connection pooling Example: - heroku pg:connection-pooling:attach postgresql-something-12345 + heroku pg:connection-pooling:attach postgresql-something-12345 ``` ## `heroku pg:copy SOURCE TARGET` @@ -274,16 +315,18 @@ copy all data from source db to target ``` USAGE - $ heroku pg:copy SOURCE TARGET + $ heroku pg:copy SOURCE TARGET -a [--wait-interval ] [--verbose] [--confirm ] [-r + ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --confirm=confirm +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --confirm= --verbose - --wait-interval=wait-interval + --wait-interval= DESCRIPTION + copy all data from source db to target at least one of the databases must be a Heroku PostgreSQL DB ``` @@ -293,11 +336,14 @@ show information on credentials in the database ``` USAGE - $ heroku pg:credentials [DATABASE] + $ heroku pg:credentials [DATABASE] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + show information on credentials in the database ``` ## `heroku pg:credentials:create [DATABASE]` @@ -306,17 +352,18 @@ create credential within database ``` USAGE - $ heroku pg:credentials:create [DATABASE] + $ heroku pg:credentials:create [DATABASE] -n -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -n, --name=name (required) name of the new credential within the database - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -n, --name= (required) name of the new credential within the database + -r, --remote= git remote of app to use DESCRIPTION + create credential within database Example: - heroku pg:credentials:create postgresql-something-12345 --name new-cred-name + heroku pg:credentials:create postgresql-something-12345 --name new-cred-name ``` ## `heroku pg:credentials:destroy [DATABASE]` @@ -325,18 +372,19 @@ destroy credential within database ``` USAGE - $ heroku pg:credentials:destroy [DATABASE] + $ heroku pg:credentials:destroy [DATABASE] -n -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -n, --name=name (required) unique identifier for the credential - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -n, --name= (required) unique identifier for the credential + -r, --remote= git remote of app to use DESCRIPTION + destroy credential within database Example: - heroku pg:credentials:destroy postgresql-transparent-56874 --name cred-name -a woodstock-production + heroku pg:credentials:destroy postgresql-transparent-56874 --name cred-name -a woodstock-production ``` ## `heroku pg:credentials:repair-default [DATABASE]` @@ -345,17 +393,18 @@ repair the permissions of the default credential within database ``` USAGE - $ heroku pg:credentials:repair-default [DATABASE] + $ heroku pg:credentials:repair-default [DATABASE] -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use DESCRIPTION + repair the permissions of the default credential within database Example: - heroku pg:credentials:repair-default postgresql-something-12345 + heroku pg:credentials:repair-default postgresql-something-12345 ``` ## `heroku pg:credentials:rotate [DATABASE]` @@ -364,15 +413,18 @@ rotate the database credentials ``` USAGE - $ heroku pg:credentials:rotate [DATABASE] + $ heroku pg:credentials:rotate [DATABASE] -a [-n ] [--all] [-c ] [--force] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -n, --name=name which credential to rotate (default credentials if not specified) - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -n, --name= which credential to rotate (default credentials if not specified) + -r, --remote= git remote of app to use --all rotate all credentials --force forces rotating the targeted credentials + +DESCRIPTION + rotate the database credentials ``` ## `heroku pg:credentials:url [DATABASE]` @@ -381,12 +433,15 @@ show information on a database credential ``` USAGE - $ heroku pg:credentials:url [DATABASE] + $ heroku pg:credentials:url [DATABASE] -a [-n ] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -n, --name= which credential to show (default credentials if not specified) + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -n, --name=name which credential to show (default credentials if not specified) - -r, --remote=remote git remote of app to use +DESCRIPTION + show information on a database credential ``` ## `heroku pg:diagnose [DATABASE|REPORT_ID]` @@ -395,14 +450,16 @@ run or view diagnostics report ``` USAGE - $ heroku pg:diagnose [DATABASE|REPORT_ID] + $ heroku pg:diagnose [DATABASE|REPORT_ID] -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json format output as JSON +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json format output as JSON DESCRIPTION + run or view diagnostics report + defaults to DATABASE_URL database if no DATABASE is specified if REPORT_ID is specified instead, a previous report is displayed ``` @@ -413,11 +470,14 @@ show database information ``` USAGE - $ heroku pg:info [DATABASE] + $ heroku pg:info [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + show database information ``` ## `heroku pg:kill PID [DATABASE]` @@ -426,12 +486,15 @@ kill a query ``` USAGE - $ heroku pg:kill PID [DATABASE] + $ heroku pg:kill PID [DATABASE] -a [-f] [-r ] -OPTIONS - -a, --app=app (required) app to run command against +FLAGS + -a, --app= (required) app to run command against -f, --force - -r, --remote=remote git remote of app to use + -r, --remote= git remote of app to use + +DESCRIPTION + kill a query ``` ## `heroku pg:killall [DATABASE]` @@ -440,11 +503,14 @@ terminates all connections for all credentials ``` USAGE - $ heroku pg:killall [DATABASE] + $ heroku pg:killall [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + terminates all connections for all credentials ``` ## `heroku pg:links [DATABASE]` @@ -453,11 +519,14 @@ lists all databases and information on link ``` USAGE - $ heroku pg:links [DATABASE] + $ heroku pg:links [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + lists all databases and information on link ``` ## `heroku pg:links:create REMOTE DATABASE` @@ -466,17 +535,18 @@ create a link between data stores ``` USAGE - $ heroku pg:links:create REMOTE DATABASE + $ heroku pg:links:create REMOTE DATABASE -a [--as ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --as=as name of link to create +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --as= name of link to create DESCRIPTION + create a link between data stores Example: - heroku pg:links:create HEROKU_REDIS_RED HEROKU_POSTGRESQL_CERULEAN + heroku pg:links:create HEROKU_REDIS_RED HEROKU_POSTGRESQL_CERULEAN ``` ## `heroku pg:links:destroy DATABASE LINK` @@ -485,17 +555,18 @@ destroys a link between data stores ``` USAGE - $ heroku pg:links:destroy DATABASE LINK + $ heroku pg:links:destroy DATABASE LINK -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use DESCRIPTION + destroys a link between data stores Example: - heroku pg:links:destroy HEROKU_POSTGRESQL_CERULEAN redis-symmetrical-100 + heroku pg:links:destroy HEROKU_POSTGRESQL_CERULEAN redis-symmetrical-100 ``` ## `heroku pg:locks [DATABASE]` @@ -504,12 +575,15 @@ display queries with active locks ``` USAGE - $ heroku pg:locks [DATABASE] + $ heroku pg:locks [DATABASE] -a [-t] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -t, --truncate truncates queries to 40 charaters +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + -t, --truncate truncates queries to 40 charaters + +DESCRIPTION + display queries with active locks ``` ## `heroku pg:maintenance [DATABASE]` @@ -518,11 +592,14 @@ show current maintenance information ``` USAGE - $ heroku pg:maintenance [DATABASE] + $ heroku pg:maintenance [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + show current maintenance information ``` ## `heroku pg:maintenance:run [DATABASE]` @@ -531,12 +608,15 @@ start maintenance ``` USAGE - $ heroku pg:maintenance:run [DATABASE] + $ heroku pg:maintenance:run [DATABASE] -a [-f] [-r ] -OPTIONS - -a, --app=app (required) app to run command against +FLAGS + -a, --app= (required) app to run command against -f, --force - -r, --remote=remote git remote of app to use + -r, --remote= git remote of app to use + +DESCRIPTION + start maintenance ``` ## `heroku pg:maintenance:window DATABASE WINDOW` @@ -545,18 +625,19 @@ set weekly maintenance window ``` USAGE - $ heroku pg:maintenance:window DATABASE WINDOW + $ heroku pg:maintenance:window DATABASE WINDOW -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + set weekly maintenance window All times are in UTC. Example: - heroku pg:maintenance:window postgres-slippery-100 "Sunday 06:00" + heroku pg:maintenance:window postgres-slippery-100 "Sunday 06:00" ``` ## `heroku pg:outliers [DATABASE]` @@ -565,14 +646,17 @@ show 10 queries that have longest execution time in aggregate ``` USAGE - $ heroku pg:outliers [DATABASE] + $ heroku pg:outliers [DATABASE] -a [--reset] [-t] [-n ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -n, --num=num the number of queries to display (default: 10) - -r, --remote=remote git remote of app to use - -t, --truncate truncate queries to 40 characters - --reset resets statistics gathered by pg_stat_statements +FLAGS + -a, --app= (required) app to run command against + -n, --num= the number of queries to display (default: 10) + -r, --remote= git remote of app to use + -t, --truncate truncate queries to 40 characters + --reset resets statistics gathered by pg_stat_statements + +DESCRIPTION + show 10 queries that have longest execution time in aggregate ``` ## `heroku pg:promote DATABASE` @@ -581,12 +665,15 @@ sets DATABASE as your DATABASE_URL ``` USAGE - $ heroku pg:promote DATABASE + $ heroku pg:promote DATABASE -a [-f] [-r ] -OPTIONS - -a, --app=app (required) app to run command against +FLAGS + -a, --app= (required) app to run command against -f, --force - -r, --remote=remote git remote of app to use + -r, --remote= git remote of app to use + +DESCRIPTION + sets DATABASE as your DATABASE_URL ``` ## `heroku pg:ps [DATABASE]` @@ -595,12 +682,15 @@ view active queries with execution time ``` USAGE - $ heroku pg:ps [DATABASE] + $ heroku pg:ps [DATABASE] -a [-v] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -v, --verbose + +DESCRIPTION + view active queries with execution time ``` ## `heroku pg:psql [DATABASE]` @@ -609,14 +699,17 @@ open a psql shell to the database ``` USAGE - $ heroku pg:psql [DATABASE] + $ heroku pg:psql [DATABASE] -a [-c ] [-f ] [--credential ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --command=command SQL command to run - -f, --file=file SQL file to run - -r, --remote=remote git remote of app to use - --credential=credential credential to use +FLAGS + -a, --app= (required) app to run command against + -c, --command= SQL command to run + -f, --file= SQL file to run + -r, --remote= git remote of app to use + --credential= credential to use + +DESCRIPTION + open a psql shell to the database ``` ## `heroku pg:pull SOURCE TARGET` @@ -625,32 +718,33 @@ pull Heroku database into local or remote database ``` USAGE - $ heroku pg:pull SOURCE TARGET + $ heroku pg:pull SOURCE TARGET -a [--exclude-table-data ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --exclude-table-data=exclude-table-data tables for which data should be excluded (use ';' to split multiple names) +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --exclude-table-data= tables for which data should be excluded (use ';' to split multiple names) DESCRIPTION + pull Heroku database into local or remote database Pull from SOURCE into TARGET. TARGET must be one of: - * a database name (i.e. on a local PostgreSQL server) => TARGET must not exist and will be created - * a fully qualified URL to a local PostgreSQL server => TARGET must not exist and will be created - * a fully qualified URL to a remote PostgreSQL server => TARGET must exist and be empty + * a database name (i.e. on a local PostgreSQL server) => TARGET must not exist and will be created + * a fully qualified URL to a local PostgreSQL server => TARGET must not exist and will be created + * a fully qualified URL to a remote PostgreSQL server => TARGET must exist and be empty To delete a local database run `dropdb TARGET` - To create an empty remote database, run `createdb` with connection command-line options (run `createdb --help` for + To create an empty remote database, run `createdb` with connection command-line options (run `createdb --help` for details). Examples: - # pull Heroku DB named postgresql-swimmingly-100 into local DB mylocaldb that must not exist - $ heroku pg:pull postgresql-swimmingly-100 mylocaldb --app sushi + # pull Heroku DB named postgresql-swimmingly-100 into local DB mylocaldb that must not exist + $ heroku pg:pull postgresql-swimmingly-100 mylocaldb --app sushi - # pull Heroku DB named postgresql-swimmingly-100 into empty remote DB at postgres://myhost/mydb - $ heroku pg:pull postgresql-swimmingly-100 postgres://myhost/mydb --app sushi + # pull Heroku DB named postgresql-swimmingly-100 into empty remote DB at postgres://myhost/mydb + $ heroku pg:pull postgresql-swimmingly-100 postgres://myhost/mydb --app sushi ``` ## `heroku pg:push SOURCE TARGET` @@ -659,14 +753,15 @@ push local or remote into Heroku database ``` USAGE - $ heroku pg:push SOURCE TARGET + $ heroku pg:push SOURCE TARGET -a [--exclude-table-data ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --exclude-table-data=exclude-table-data tables for which data should be excluded (use ';' to split multiple names) +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --exclude-table-data= tables for which data should be excluded (use ';' to split multiple names) DESCRIPTION + push local or remote into Heroku database Push from SOURCE into TARGET. TARGET must be empty. To empty a Heroku database for push run `heroku pg:reset` @@ -676,11 +771,11 @@ DESCRIPTION Examples: - # push mylocaldb into a Heroku DB named postgresql-swimmingly-100 - $ heroku pg:push mylocaldb postgresql-swimmingly-100 + # push mylocaldb into a Heroku DB named postgresql-swimmingly-100 + $ heroku pg:push mylocaldb postgresql-swimmingly-100 - # push remote DB at postgres://myhost/mydb into a Heroku DB named postgresql-swimmingly-100 - $ heroku pg:push postgres://myhost/mydb postgresql-swimmingly-100 + # push remote DB at postgres://myhost/mydb into a Heroku DB named postgresql-swimmingly-100 + $ heroku pg:push postgres://myhost/mydb postgresql-swimmingly-100 ``` ## `heroku pg:reset [DATABASE]` @@ -689,13 +784,16 @@ delete all data in DATABASE ``` USAGE - $ heroku pg:reset [DATABASE] + $ heroku pg:reset [DATABASE] -a [-e ] [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -e, --extensions=extensions comma-separated list of extensions to pre-install in the public schema - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -e, --extensions= comma-separated list of extensions to pre-install in the public schema + -r, --remote= git remote of app to use + +DESCRIPTION + delete all data in DATABASE ``` ## `heroku pg:settings [DATABASE]` @@ -704,11 +802,14 @@ show your current database settings ``` USAGE - $ heroku pg:settings [DATABASE] + $ heroku pg:settings [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + show your current database settings ``` ## `heroku pg:settings:log-lock-waits [VALUE] [DATABASE]` @@ -717,16 +818,18 @@ Controls whether a log message is produced when a session waits longer than the ``` USAGE - $ heroku pg:settings:log-lock-waits [VALUE] [DATABASE] + $ heroku pg:settings:log-lock-waits [VALUE] [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION - Delays due to lock contention occur when multiple transactions are trying to access the same resource at the same + Controls whether a log message is produced when a session waits longer than the deadlock_timeout to acquire a lock. + deadlock_timeout is set to 1 second + Delays due to lock contention occur when multiple transactions are trying to access the same resource at the same time. - Applications and their query patterns should try to avoid changes to many different tables within the same + Applications and their query patterns should try to avoid changes to many different tables within the same transaction. ``` @@ -736,15 +839,16 @@ The duration of each completed statement will be logged if the statement complet ``` USAGE - $ heroku pg:settings:log-min-duration-statement [VALUE] [DATABASE] + $ heroku pg:settings:log-min-duration-statement [VALUE] [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + The duration of each completed statement will be logged if the statement completes after the time specified by VALUE. VALUE needs to specified as a whole number, in milliseconds. - Setting log_min_duration_statement to zero prints all statement durations and -1 will disable logging statement + Setting log_min_duration_statement to zero prints all statement durations and -1 will disable logging statement durations. ``` @@ -754,18 +858,19 @@ log_statement controls which SQL statements are logged. ``` USAGE - $ heroku pg:settings:log-statement [VALUE] [DATABASE] + $ heroku pg:settings:log-statement [VALUE] [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + log_statement controls which SQL statements are logged. Valid values for VALUE: none - No statements are logged ddl - All data definition statements, such as CREATE, ALTER and DROP will be logged mod - Includes all statements from ddl as well as data-modifying statements such as INSERT, UPDATE, DELETE, TRUNCATE, - COPY + COPY all - All statements are logged ``` @@ -775,17 +880,18 @@ track_functions controls tracking of function call counts and time used. Default ``` USAGE - $ heroku pg:settings:track-functions [VALUE] [DATABASE] + $ heroku pg:settings:track-functions [VALUE] [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + track_functions controls tracking of function call counts and time used. Default is none. Valid values for VALUE: none - No functions are tracked pl - Only procedural language functions are tracked - all - All functions, including SQL and C language functions, are tracked. Simple SQL-language that are inlined are + all - All functions, including SQL and C language functions, are tracked. Simple SQL-language that are inlined are not tracked ``` @@ -795,12 +901,15 @@ stop a replica from following and make it a writeable database ``` USAGE - $ heroku pg:unfollow DATABASE + $ heroku pg:unfollow DATABASE -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + +DESCRIPTION + stop a replica from following and make it a writeable database ``` ## `heroku pg:upgrade [DATABASE]` @@ -809,15 +918,16 @@ unfollow a database and upgrade it to the latest stable PostgreSQL version ``` USAGE - $ heroku pg:upgrade [DATABASE] + $ heroku pg:upgrade [DATABASE] -a [-c ] [-v ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use - -v, --version=version PostgreSQL version to upgrade to +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + -v, --version= PostgreSQL version to upgrade to DESCRIPTION + unfollow a database and upgrade it to the latest stable PostgreSQL version to upgrade to another PostgreSQL version, use pg:copy instead ``` @@ -827,11 +937,14 @@ show dead rows and whether an automatic vacuum is expected to be triggered ``` USAGE - $ heroku pg:vacuum-stats [DATABASE] + $ heroku pg:vacuum-stats [DATABASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + show dead rows and whether an automatic vacuum is expected to be triggered ``` ## `heroku pg:wait [DATABASE]` @@ -840,11 +953,14 @@ blocks until database is available ``` USAGE - $ heroku pg:wait [DATABASE] + $ heroku pg:wait [DATABASE] -a [--wait-interval ] [--no-notify] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --no-notify do not show OS notification - --wait-interval=wait-interval how frequently to poll in seconds (to avoid rate limiting) +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --no-notify do not show OS notification + --wait-interval= how frequently to poll in seconds (to avoid rate limiting) + +DESCRIPTION + blocks until database is available ``` diff --git a/docs/plugins.md b/docs/plugins.md index 71350c7635..f5609869f6 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -1,92 +1,137 @@ `heroku plugins` ================ -list installed plugins +List installed plugins. * [`heroku plugins`](#heroku-plugins) -* [`heroku plugins:inspect PLUGIN...`](#heroku-pluginsinspect-plugin) * [`heroku plugins:install PLUGIN...`](#heroku-pluginsinstall-plugin) +* [`heroku plugins:inspect PLUGIN...`](#heroku-pluginsinspect-plugin) +* [`heroku plugins:install PLUGIN...`](#heroku-pluginsinstall-plugin-1) * [`heroku plugins:link PLUGIN`](#heroku-pluginslink-plugin) * [`heroku plugins:uninstall PLUGIN...`](#heroku-pluginsuninstall-plugin) +* [`heroku plugins:uninstall PLUGIN...`](#heroku-pluginsuninstall-plugin-1) +* [`heroku plugins:uninstall PLUGIN...`](#heroku-pluginsuninstall-plugin-2) * [`heroku plugins:update`](#heroku-pluginsupdate) ## `heroku plugins` -list installed plugins +List installed plugins. ``` USAGE - $ heroku plugins + $ heroku plugins [--core] -OPTIONS - --core show core plugins +FLAGS + --core Show core plugins. -EXAMPLE +DESCRIPTION + List installed plugins. + +EXAMPLES $ heroku plugins ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/index.ts)_ +## `heroku plugins:install PLUGIN...` + +Installs a plugin into the CLI. + +``` +USAGE + $ heroku plugins:install PLUGIN... + +ARGUMENTS + PLUGIN Plugin to install. + +FLAGS + -f, --force Run yarn install with force flag. + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Installs a plugin into the CLI. + Can be installed from npm or a git url. + + Installation of a user-installed plugin will override a core plugin. + + e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command + will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in + the CLI without the need to patch and update the whole CLI. + + +ALIASES + $ heroku plugins:add + +EXAMPLES + $ heroku plugins:install myplugin + + $ heroku plugins:install https://github.com/someuser/someplugin + + $ heroku plugins:install someuser/someplugin +``` ## `heroku plugins:inspect PLUGIN...` -displays installation properties of a plugin +Displays installation properties of a plugin. ``` USAGE $ heroku plugins:inspect PLUGIN... ARGUMENTS - PLUGIN [default: .] plugin to inspect + PLUGIN [default: .] Plugin to inspect. -OPTIONS - -h, --help show CLI help +FLAGS + -h, --help Show CLI help. -v, --verbose -EXAMPLE +DESCRIPTION + Displays installation properties of a plugin. + +EXAMPLES $ heroku plugins:inspect myplugin ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/inspect.ts)_ - ## `heroku plugins:install PLUGIN...` -installs a plugin into the CLI +Installs a plugin into the CLI. ``` USAGE $ heroku plugins:install PLUGIN... ARGUMENTS - PLUGIN plugin to install + PLUGIN Plugin to install. -OPTIONS - -f, --force yarn install with force flag - -h, --help show CLI help +FLAGS + -f, --force Run yarn install with force flag. + -h, --help Show CLI help. -v, --verbose DESCRIPTION + Installs a plugin into the CLI. Can be installed from npm or a git url. Installation of a user-installed plugin will override a core plugin. - e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command - will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in + e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command + will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI. + ALIASES $ heroku plugins:add EXAMPLES $ heroku plugins:install myplugin + $ heroku plugins:install https://github.com/someuser/someplugin + $ heroku plugins:install someuser/someplugin ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/install.ts)_ - ## `heroku plugins:link PLUGIN` -links a plugin into the CLI for development +Links a plugin into the CLI for development. ``` USAGE @@ -95,25 +140,48 @@ USAGE ARGUMENTS PATH [default: .] path to plugin -OPTIONS - -h, --help show CLI help +FLAGS + -h, --help Show CLI help. -v, --verbose DESCRIPTION + Links a plugin into the CLI for development. Installation of a linked plugin will override a user-installed or core plugin. e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' - command will override the user-installed or core plugin implementation. This is useful for development work. + command will override the user-installed or core plugin implementation. This is useful for development work. -EXAMPLE + +EXAMPLES $ heroku plugins:link myplugin ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/link.ts)_ +## `heroku plugins:uninstall PLUGIN...` + +Removes a plugin from the CLI. + +``` +USAGE + $ heroku plugins:uninstall PLUGIN... + +ARGUMENTS + PLUGIN plugin to uninstall + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Removes a plugin from the CLI. + +ALIASES + $ heroku plugins:unlink + $ heroku plugins:remove +``` ## `heroku plugins:uninstall PLUGIN...` -removes a plugin from the CLI +Removes a plugin from the CLI. ``` USAGE @@ -122,28 +190,53 @@ USAGE ARGUMENTS PLUGIN plugin to uninstall -OPTIONS - -h, --help show CLI help +FLAGS + -h, --help Show CLI help. -v, --verbose +DESCRIPTION + Removes a plugin from the CLI. + ALIASES $ heroku plugins:unlink $ heroku plugins:remove ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/uninstall.ts)_ +## `heroku plugins:uninstall PLUGIN...` + +Removes a plugin from the CLI. + +``` +USAGE + $ heroku plugins:uninstall PLUGIN... + +ARGUMENTS + PLUGIN plugin to uninstall + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Removes a plugin from the CLI. + +ALIASES + $ heroku plugins:unlink + $ heroku plugins:remove +``` ## `heroku plugins:update` -update installed plugins +Update installed plugins. ``` USAGE - $ heroku plugins:update + $ heroku plugins:update [-h] [-v] -OPTIONS - -h, --help show CLI help +FLAGS + -h, --help Show CLI help. -v, --verbose -``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/update.ts)_ +DESCRIPTION + Update installed plugins. +``` diff --git a/docs/ps.md b/docs/ps.md index 9a205c1208..191885c808 100644 --- a/docs/ps.md +++ b/docs/ps.md @@ -4,8 +4,6 @@ Client tools for Heroku Exec * [`heroku ps [TYPE [TYPE ...]]`](#heroku-ps-type-type-) -* [`heroku ps:autoscale:disable`](#heroku-psautoscaledisable) -* [`heroku ps:autoscale:enable`](#heroku-psautoscaleenable) * [`heroku ps:copy FILE`](#heroku-pscopy-file) * [`heroku ps:exec`](#heroku-psexec) * [`heroku ps:forward PORT`](#heroku-psforward-port) @@ -16,7 +14,6 @@ Client tools for Heroku Exec * [`heroku ps:socks`](#heroku-pssocks) * [`heroku ps:stop DYNO`](#heroku-psstop-dyno) * [`heroku ps:type`](#heroku-pstype) -* [`heroku ps:wait`](#heroku-pswait) ## `heroku ps [TYPE [TYPE ...]]` @@ -26,76 +23,45 @@ list dynos for an app USAGE $ heroku ps [TYPE [TYPE ...]] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json display as json +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json display as json + +DESCRIPTION + list dynos for an app + EXAMPLES $ heroku ps === run: one-off dyno run.1: up for 5m: bash - === web: bundle exec thin start -p $PORT web.1: created for 30s - $ heroku ps run # specifying types === run: one-off dyno run.1: up for 5m: bash ``` -## `heroku ps:autoscale:disable` - -disable web dyno autoscaling - -``` -USAGE - $ heroku ps:autoscale:disable - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` - -_See code: [@heroku-cli/plugin-ps](https://github.com/heroku/cli/blob/v7.68.0/packages/ps/src/commands/ps/autoscale/disable.ts)_ - -## `heroku ps:autoscale:enable` - -enable web dyno autoscaling - -``` -USAGE - $ heroku ps:autoscale:enable - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --max=max (required) maximum number of dynos - --min=min (required) minimum number of dynos - --notifications receive email notifications when the max dyno limit is reached - --p95=p95 desired p95 response time -``` - -_See code: [@heroku-cli/plugin-ps](https://github.com/heroku/cli/blob/v7.68.0/packages/ps/src/commands/ps/autoscale/enable.ts)_ - ## `heroku ps:copy FILE` Copy a file from a dyno to the local filesystem ``` USAGE - $ heroku ps:copy FILE + $ heroku ps:copy FILE -a [-d ] [-o ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -d, --dyno=dyno specify the dyno to connect to - -o, --output=output the name of the output file - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -d, --dyno= specify the dyno to connect to + -o, --output= the name of the output file + -r, --remote= git remote of app to use DESCRIPTION + Copy a file from a dyno to the local filesystem Example: - $ heroku ps:copy FILENAME --app murmuring-headland-14719 + $ heroku ps:copy FILENAME --app murmuring-headland-14719 ``` ## `heroku ps:exec` @@ -104,19 +70,20 @@ Create an SSH session to a dyno ``` USAGE - $ heroku ps:exec + $ heroku ps:exec -a [-d ] [--ssh] [--status] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -d, --dyno=dyno specify the dyno to connect to - -r, --remote=remote git remote of app to use - --ssh use native ssh - --status lists the status of the SSH server in the dyno +FLAGS + -a, --app= (required) app to run command against + -d, --dyno= specify the dyno to connect to + -r, --remote= git remote of app to use + --ssh use native ssh + --status lists the status of the SSH server in the dyno DESCRIPTION + Create an SSH session to a dyno Example: - $ heroku ps:exec 'node -i' --app murmuring-headland-14719 + $ heroku ps:exec 'node -i' --app murmuring-headland-14719 ``` ## `heroku ps:forward PORT` @@ -125,22 +92,23 @@ Forward traffic on a local port to a dyno ``` USAGE - $ heroku ps:forward PORT + $ heroku ps:forward PORT -a [-d ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -d, --dyno=dyno specify the dyno to connect to - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -d, --dyno= specify the dyno to connect to + -r, --remote= git remote of app to use DESCRIPTION + Forward traffic on a local port to a dyno Provide a port or comma-separated list of ports to forward. - For example, "4000,9000:9001" will forward port 4000 to port 4000 and - port 9000 to port 9001. + For example, "4000,9000:9001" will forward port 4000 to port 4000 and + port 9000 to port 9001. - Example: + Example: - $ heroku ps:forward 8080 --app murmuring-headland-14719 + $ heroku ps:forward 8080 --app murmuring-headland-14719 ``` ## `heroku ps:kill DYNO` @@ -149,19 +117,20 @@ stop app dyno ``` USAGE - $ heroku ps:kill DYNO + $ heroku ps:kill DYNO -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + stop app dyno + stop app dyno or dyno type EXAMPLES $ heroku ps:stop run.1828 Stopping run.1828 dyno... done - $ heroku ps:stop run Stopping run dynos... done ``` @@ -172,13 +141,15 @@ manage dyno sizes ``` USAGE - $ heroku ps:resize + $ heroku ps:resize -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + manage dyno sizes + Called with no arguments shows the current dyno size. Called with one argument sets the size. @@ -193,22 +164,21 @@ restart app dynos ``` USAGE - $ heroku ps:restart [DYNO] + $ heroku ps:restart [DYNO] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + restart app dynos if DYNO is not specified, restarts all dynos on app EXAMPLES $ heroku ps:restart web.1 Restarting web.1 dyno... done - $ heroku ps:restart web Restarting web dynos... done - $ heroku ps:restart Restarting dynos... done ``` @@ -219,13 +189,14 @@ scale dyno quantity up or down ``` USAGE - $ heroku ps:scale + $ heroku ps:scale -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + scale dyno quantity up or down Appending a size (eg. web=2:Standard-2X) allows simultaneous scaling and resizing. Omitting any arguments will display the app's current dyno formation, in a @@ -234,7 +205,6 @@ DESCRIPTION EXAMPLES $ heroku ps:scale web=3:Standard-2X worker+1 Scaling dynos... done, now running web at 3:Standard-2X, worker at 1:Standard-1X. - $ heroku ps:scale web=3:Standard-2X worker=1:Standard-1X ``` @@ -245,20 +215,21 @@ Launch a SOCKS proxy into a dyno ``` USAGE - $ heroku ps:socks + $ heroku ps:socks -a [-d ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -d, --dyno=dyno specify the dyno to connect to - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -d, --dyno= specify the dyno to connect to + -r, --remote= git remote of app to use DESCRIPTION + Launch a SOCKS proxy into a dyno Example: - $ heroku ps:socks --app murmuring-headland-14719 - Establishing credentials... done - SOCKSv5 proxy server started on port 1080 - Use CTRL+C to stop the proxy + $ heroku ps:socks --app murmuring-headland-14719 + Establishing credentials... done + SOCKSv5 proxy server started on port 1080 + Use CTRL+C to stop the proxy ``` ## `heroku ps:stop DYNO` @@ -267,19 +238,20 @@ stop app dyno ``` USAGE - $ heroku ps:stop DYNO + $ heroku ps:stop DYNO -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + stop app dyno + stop app dyno or dyno type EXAMPLES $ heroku ps:stop run.1828 Stopping run.1828 dyno... done - $ heroku ps:stop run Stopping run dynos... done ``` @@ -290,13 +262,15 @@ manage dyno sizes ``` USAGE - $ heroku ps:type + $ heroku ps:type -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + manage dyno sizes + Called with no arguments shows the current dyno size. Called with one argument sets the size. @@ -304,23 +278,3 @@ DESCRIPTION Called with 1..n TYPE=SIZE arguments sets the quantity per type. ``` - -## `heroku ps:wait` - -wait for all dynos to be running latest version after a release - -``` -USAGE - $ heroku ps:wait - -OPTIONS - -R, --with-run whether to wait for one-off run dynos - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -t, --type=type wait for one specific dyno type - - -w, --wait-interval=wait-interval [default: 10] how frequently to poll in seconds (to avoid hitting Heroku API rate - limits) -``` - -_See code: [@heroku-cli/plugin-ps](https://github.com/heroku/cli/blob/v7.68.0/packages/ps/src/commands/ps/wait.ts)_ diff --git a/docs/redis.md b/docs/redis.md index aaf9555e0a..bbc59c2423 100644 --- a/docs/redis.md +++ b/docs/redis.md @@ -22,12 +22,15 @@ gets information about redis ``` USAGE - $ heroku redis [DATABASE] + $ heroku redis [DATABASE] -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json format output as JSON +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json format output as JSON + +DESCRIPTION + gets information about redis ``` ## `heroku redis:cli [DATABASE]` @@ -36,12 +39,15 @@ opens a redis prompt ``` USAGE - $ heroku redis:cli [DATABASE] + $ heroku redis:cli [DATABASE] -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + +DESCRIPTION + opens a redis prompt ``` ## `heroku redis:credentials [DATABASE]` @@ -50,12 +56,15 @@ display credentials information ``` USAGE - $ heroku redis:credentials [DATABASE] + $ heroku redis:credentials [DATABASE] -a [--reset] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --reset reset credentials +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --reset reset credentials + +DESCRIPTION + display credentials information ``` ## `heroku redis:info [DATABASE]` @@ -64,12 +73,15 @@ gets information about redis ``` USAGE - $ heroku redis:info [DATABASE] + $ heroku redis:info [DATABASE] -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json format output as JSON +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json format output as JSON + +DESCRIPTION + gets information about redis ``` ## `heroku redis:keyspace-notifications [DATABASE]` @@ -78,30 +90,31 @@ set the keyspace notifications configuration ``` USAGE - $ heroku redis:keyspace-notifications [DATABASE] + $ heroku redis:keyspace-notifications [DATABASE] -c -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --config=config (required) set keyspace notifications configuration - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --config= (required) set keyspace notifications configuration + -r, --remote= git remote of app to use DESCRIPTION + set the keyspace notifications configuration Set the configuration to enable keyspace notification events: - K Keyspace events, published with __keyspace@__ prefix. - E Keyevent events, published with __keyevent@__ prefix. - g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... - $ String commands - l List commands - s Set commands - h Hash commands - z Sorted set commands - t Stream commands - x Expired events (events generated every time a key expires) - e Evicted events (events generated when a key is evicted for maxmemory) - m Key miss events (events generated when a key that doesn't exist is accessed) - A Alias for "g$lshztxe", so that the "AKE" string means all the events except "m". - - pass an empty string ('') to disable keyspace notifications + K Keyspace events, published with __keyspace@__ prefix. + E Keyevent events, published with __keyevent@__ prefix. + g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... + $ String commands + l List commands + s Set commands + h Hash commands + z Sorted set commands + t Stream commands + x Expired events (events generated every time a key expires) + e Evicted events (events generated when a key is evicted for maxmemory) + m Key miss events (events generated when a key that doesn't exist is accessed) + A Alias for "g$lshztxe", so that the "AKE" string means all the events except "m". + + pass an empty string ('') to disable keyspace notifications ``` ## `heroku redis:maintenance [DATABASE]` @@ -110,16 +123,17 @@ manage maintenance windows ``` USAGE - $ heroku redis:maintenance [DATABASE] + $ heroku redis:maintenance [DATABASE] -a [-w ] [--run] [-f] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -f, --force start maintenance without entering application maintenance mode - -r, --remote=remote git remote of app to use - -w, --window=window set weekly UTC maintenance window - --run start maintenance +FLAGS + -a, --app= (required) app to run command against + -f, --force start maintenance without entering application maintenance mode + -r, --remote= git remote of app to use + -w, --window= set weekly UTC maintenance window + --run start maintenance DESCRIPTION + manage maintenance windows Set or change the maintenance window for your Redis instance ``` @@ -129,24 +143,25 @@ set the key eviction policy ``` USAGE - $ heroku redis:maxmemory [DATABASE] + $ heroku redis:maxmemory [DATABASE] -p -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -p, --policy=policy (required) set policy name - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -p, --policy= (required) set policy name + -r, --remote= git remote of app to use DESCRIPTION + set the key eviction policy Set the key eviction policy when instance reaches its storage limit. Available policies for key eviction include: - noeviction # returns errors when memory limit is reached - allkeys-lfu # removes less frequently used keys first - volatile-lfu # removes less frequently used keys first that have an expiry set - allkeys-lru # removes less recently used keys first - volatile-lru # removes less recently used keys first that have an expiry set - allkeys-random # evicts random keys - volatile-random # evicts random keys but only those that have an expiry set - volatile-ttl # only evicts keys with an expiry set and a short TTL + noeviction # returns errors when memory limit is reached + allkeys-lfu # removes less frequently used keys first + volatile-lfu # removes less frequently used keys first that have an expiry set + allkeys-lru # removes less recently used keys first + volatile-lru # removes less recently used keys first that have an expiry set + allkeys-random # evicts random keys + volatile-random # evicts random keys but only those that have an expiry set + volatile-ttl # only evicts keys with an expiry set and a short TTL ``` ## `heroku redis:promote DATABASE` @@ -155,11 +170,14 @@ sets DATABASE as your REDIS_URL ``` USAGE - $ heroku redis:promote DATABASE + $ heroku redis:promote DATABASE -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + sets DATABASE as your REDIS_URL ``` ## `heroku redis:stats-reset [DATABASE]` @@ -168,12 +186,15 @@ reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat ``` USAGE - $ heroku redis:stats-reset [DATABASE] + $ heroku redis:stats-reset [DATABASE] -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + +DESCRIPTION + reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat) ``` ## `heroku redis:timeout [DATABASE]` @@ -182,16 +203,17 @@ set the number of seconds to wait before killing idle connections ``` USAGE - $ heroku redis:timeout [DATABASE] + $ heroku redis:timeout [DATABASE] -a [-s ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --seconds=seconds set timeout value +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + -s, --seconds= set timeout value DESCRIPTION + set the number of seconds to wait before killing idle connections Sets the number of seconds to wait before killing idle connections. A value of zero means that connections will not be - closed. + closed. ``` ## `heroku redis:upgrade [DATABASE]` @@ -200,13 +222,16 @@ perform in-place version upgrade ``` USAGE - $ heroku redis:upgrade [DATABASE] + $ heroku redis:upgrade [DATABASE] -a [-c ] [-v ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use - -v, --version=version +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + -v, --version= + +DESCRIPTION + perform in-place version upgrade ``` ## `heroku redis:wait [DATABASE]` @@ -215,10 +240,13 @@ wait for Redis instance to be available ``` USAGE - $ heroku redis:wait [DATABASE] + $ heroku redis:wait [DATABASE] -a [--wait-interval ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --wait-interval=wait-interval how frequently to poll in seconds +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --wait-interval= how frequently to poll in seconds + +DESCRIPTION + wait for Redis instance to be available ``` diff --git a/docs/sessions.md b/docs/sessions.md index a144156053..d3d1f2f4cb 100644 --- a/docs/sessions.md +++ b/docs/sessions.md @@ -12,13 +12,14 @@ list your OAuth sessions ``` USAGE - $ heroku sessions + $ heroku sessions [-j] -OPTIONS +FLAGS -j, --json output in json format -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/sessions/index.js)_ +DESCRIPTION + list your OAuth sessions +``` ## `heroku sessions:destroy ID` @@ -27,6 +28,7 @@ delete (logout) OAuth session by ID ``` USAGE $ heroku sessions:destroy ID -``` -_See code: [@heroku-cli/plugin-oauth-v5](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/sessions/destroy.js)_ +DESCRIPTION + delete (logout) OAuth session by ID +``` diff --git a/docs/spaces.md b/docs/spaces.md index c503a23331..2be07f62b0 100644 --- a/docs/spaces.md +++ b/docs/spaces.md @@ -30,11 +30,14 @@ list available spaces ``` USAGE - $ heroku spaces + $ heroku spaces [--json] [-t ] -OPTIONS - -t, --team=team team to use - --json output in json format +FLAGS + -t, --team= team to use + --json output in json format + +DESCRIPTION + list available spaces ``` ## `heroku spaces:create` @@ -43,28 +46,29 @@ create a new space ``` USAGE - $ heroku spaces:create + $ heroku spaces:create [SPACE] [-s ] [--region ] [--cidr ] [--data-cidr ] [-t ] -OPTIONS - -s, --space=space name of space to create - -t, --team=team team to use - --cidr=cidr RFC-1918 CIDR the space will use - --data-cidr=data-cidr RFC-1918 CIDR used by Heroku Data resources for the space - --region=region region name +FLAGS + -s, --space= name of space to create + -t, --team= team to use + --cidr= RFC-1918 CIDR the space will use + --data-cidr= RFC-1918 CIDR used by Heroku Data resources for the space + --region= region name DESCRIPTION + create a new space Example: - $ heroku spaces:create --space my-space --team my-team --region oregon - Creating space my-space in team my-team... done - === my-space - ID: e7b99e37-69b3-4475-ad47-a5cc5d75fd9f - Team: my-team - Region: oregon - CIDR: 10.0.0.0/16 - Data CIDR: 172.23.0.0/20 - State: allocating - Created at: 2016-01-06T03:23:13Z + $ heroku spaces:create --space my-space --team my-team --region oregon + Creating space my-space in team my-team... done + === my-space + ID: e7b99e37-69b3-4475-ad47-a5cc5d75fd9f + Team: my-team + Region: oregon + CIDR: 10.0.0.0/16 + Data CIDR: 172.23.0.0/20 + State: allocating + Created at: 2016-01-06T03:23:13Z ``` ## `heroku spaces:destroy` @@ -73,17 +77,18 @@ destroy a space ``` USAGE - $ heroku spaces:destroy + $ heroku spaces:destroy [SPACE] [-s ] [--confirm ] -OPTIONS - -s, --space=space space to destroy - --confirm=confirm set to space name to bypass confirm prompt +FLAGS + -s, --space= space to destroy + --confirm= set to space name to bypass confirm prompt DESCRIPTION + destroy a space Example: - $ heroku spaces:destroy --space my-space - Destroying my-space... done + $ heroku spaces:destroy --space my-space + Destroying my-space... done ``` ## `heroku spaces:info` @@ -92,11 +97,14 @@ show info about a space ``` USAGE - $ heroku spaces:info + $ heroku spaces:info [SPACE] [-s ] [--json] -OPTIONS - -s, --space=space space to get info of - --json output in json format +FLAGS + -s, --space= space to get info of + --json output in json format + +DESCRIPTION + show info about a space ``` ## `heroku spaces:peering:info` @@ -105,25 +113,26 @@ display the information necessary to initiate a peering connection ``` USAGE - $ heroku spaces:peering:info + $ heroku spaces:peering:info [SPACE] [-s ] [--json] -OPTIONS - -s, --space=space space to get peering info from - --json output in json format +FLAGS + -s, --space= space to get peering info from + --json output in json format DESCRIPTION + display the information necessary to initiate a peering connection Example: - $ heroku spaces:peering:info example-space - === example-space Peering Info - AWS Account ID: 012345678910 - AWS Region: us-west-2 - AWS VPC ID: vpc-baadf00d - AWS VPC CIDR: 10.0.0.0/16 - Space CIDRs: 10.0.128.0/20, 10.0.144.0/20 - Unavailable CIDRs: 10.1.0.0/16 + $ heroku spaces:peering:info example-space + === example-space Peering Info + AWS Account ID: 012345678910 + AWS Region: us-west-2 + AWS VPC ID: vpc-baadf00d + AWS VPC CIDR: 10.0.0.0/16 + Space CIDRs: 10.0.128.0/20, 10.0.144.0/20 + Unavailable CIDRs: 10.1.0.0/16 - You will use the information provied by this command to establish a peering connection request from your AWS VPC to + You will use the information provied by this command to establish a peering connection request from your AWS VPC to your private space. To start the peering process, go into your AWS console for the VPC you would like peered with your Private Space, @@ -142,11 +151,14 @@ list peering connections for a space ``` USAGE - $ heroku spaces:peerings + $ heroku spaces:peerings [SPACE] [-s ] [--json] -OPTIONS - -s, --space=space space to get peer list from - --json output in json format +FLAGS + -s, --space= space to get peer list from + --json output in json format + +DESCRIPTION + list peering connections for a space ``` ## `heroku spaces:peerings:accept` @@ -155,17 +167,18 @@ accepts a pending peering request for a private space ``` USAGE - $ heroku spaces:peerings:accept + $ heroku spaces:peerings:accept [PCXID] [-p ] [-s ] -OPTIONS - -p, --pcxid=pcxid PCX ID of a pending peering - -s, --space=space space to get peering info from +FLAGS + -p, --pcxid= PCX ID of a pending peering + -s, --space= space to get peering info from DESCRIPTION + accepts a pending peering request for a private space Example: - $ heroku spaces:peerings:accept pcx-4bd27022 --space example-space - Accepting and configuring peering connection pcx-4bd27022 + $ heroku spaces:peerings:accept pcx-4bd27022 --space example-space + Accepting and configuring peering connection pcx-4bd27022 ``` ## `heroku spaces:peerings:destroy` @@ -174,18 +187,19 @@ destroys an active peering connection in a private space ``` USAGE - $ heroku spaces:peerings:destroy + $ heroku spaces:peerings:destroy [PCXID] [-p ] [-s ] [--confirm ] -OPTIONS - -p, --pcxid=pcxid PCX ID of a pending peering - -s, --space=space space to get peering info from - --confirm=confirm set to PCX ID to bypass confirm prompt +FLAGS + -p, --pcxid= PCX ID of a pending peering + -s, --space= space to get peering info from + --confirm= set to PCX ID to bypass confirm prompt DESCRIPTION + destroys an active peering connection in a private space Example: - $ heroku spaces:peerings:destroy pcx-4bd27022 --confirm pcx-4bd27022 --space example-space - Tearing down peering connection pcx-4bd27022 + $ heroku spaces:peerings:destroy pcx-4bd27022 --confirm pcx-4bd27022 --space example-space + Tearing down peering connection pcx-4bd27022 ``` ## `heroku spaces:ps` @@ -194,11 +208,14 @@ list dynos for a space ``` USAGE - $ heroku spaces:ps + $ heroku spaces:ps [SPACE] [-s ] [--json] + +FLAGS + -s, --space= space to get dynos of + --json output in json format -OPTIONS - -s, --space=space space to get dynos of - --json output in json format +DESCRIPTION + list dynos for a space ``` ## `heroku spaces:rename` @@ -207,17 +224,18 @@ renames a space ``` USAGE - $ heroku spaces:rename + $ heroku spaces:rename --from --to -OPTIONS - --from=from (required) current name of space - --to=to (required) desired name of space +FLAGS + --from= (required) current name of space + --to= (required) desired name of space DESCRIPTION + renames a space Example: - $ heroku spaces:rename --from old-space-name --to new-space-name - Renaming space old-space-name to new-space-name... done + $ heroku spaces:rename --from old-space-name --to new-space-name + Renaming space old-space-name to new-space-name... done ``` ## `heroku spaces:topology` @@ -226,11 +244,14 @@ show space topology ``` USAGE - $ heroku spaces:topology + $ heroku spaces:topology [SPACE] [-s ] [--json] + +FLAGS + -s, --space= space to get topology of + --json output in json format -OPTIONS - -s, --space=space space to get topology of - --json output in json format +DESCRIPTION + show space topology ``` ## `heroku spaces:transfer` @@ -239,17 +260,18 @@ transfer a space to another team ``` USAGE - $ heroku spaces:transfer + $ heroku spaces:transfer --space --team -OPTIONS - --space=space (required) name of space - --team=team (required) desired owner of space +FLAGS + --space= (required) name of space + --team= (required) desired owner of space DESCRIPTION + transfer a space to another team Example: - $ heroku spaces:transfer --space=space-name --team=team-name - Transferring space-name to team-name... done + $ heroku spaces:transfer --space=space-name --team=team-name + Transferring space-name to team-name... done ``` ## `heroku spaces:vpn:config` @@ -258,22 +280,23 @@ display the configuration information for VPN ``` USAGE - $ heroku spaces:vpn:config + $ heroku spaces:vpn:config [NAME] [-s ] [-n ] [--json] -OPTIONS - -n, --name=name name or id of the VPN connection to retrieve config from - -s, --space=space space the VPN connection belongs to - --json output in json format +FLAGS + -n, --name= name or id of the VPN connection to retrieve config from + -s, --space= space the VPN connection belongs to + --json output in json format DESCRIPTION + display the configuration information for VPN Example: - $ heroku spaces:vpn:config --space my-space vpn-connection-name - === vpn-connection-name VPN Tunnels - VPN Tunnel Customer Gateway VPN Gateway Pre-shared Key Routable Subnets IKE Version - ────────── ──────────────── ────────────── ────────────── ──────────────── ─────────── - Tunnel 1 104.196.121.200 35.171.237.136 abcdef12345 10.0.0.0/16 1 - Tunnel 2 104.196.121.200 52.44.7.216 fedcba54321 10.0.0.0/16 1 + $ heroku spaces:vpn:config --space my-space vpn-connection-name + === vpn-connection-name VPN Tunnels + VPN Tunnel Customer Gateway VPN Gateway Pre-shared Key Routable Subnets IKE Version + ────────── ──────────────── ────────────── ────────────── ──────────────── ─────────── + Tunnel 1 104.196.121.200 35.171.237.136 abcdef12345 10.0.0.0/16 1 + Tunnel 2 104.196.121.200 52.44.7.216 fedcba54321 10.0.0.0/16 1 You will use the information provided by this command to establish a Private Space VPN Connection. @@ -289,16 +312,17 @@ create VPN ``` USAGE - $ heroku spaces:vpn:connect + $ heroku spaces:vpn:connect [NAME] [-n ] [-i ] [-c ] [-s ] -OPTIONS - -c, --cidrs=cidrs a list of routable CIDRs separated by commas - -i, --ip=ip public IP of customer gateway - -n, --name=name VPN name - -s, --space=space space name +FLAGS + -c, --cidrs= a list of routable CIDRs separated by commas + -i, --ip= public IP of customer gateway + -n, --name= VPN name + -s, --space= space name DESCRIPTION - Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to + create VPN + Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to hosts on your private networks and vice versa. The connection is established over the public Internet but all traffic is encrypted using IPSec. @@ -314,20 +338,21 @@ list the VPN Connections for a space ``` USAGE - $ heroku spaces:vpn:connections + $ heroku spaces:vpn:connections [SPACE] [-s ] [--json] -OPTIONS - -s, --space=space space to get VPN connections from - --json output in json format +FLAGS + -s, --space= space to get VPN connections from + --json output in json format DESCRIPTION + list the VPN Connections for a space Example: - $ heroku spaces:vpn:connections --space my-space - === my-space VPN Connections - Name Status Tunnels - ────── ────── ─────── - office active UP/UP + $ heroku spaces:vpn:connections --space my-space + === my-space VPN Connections + Name Status Tunnels + ────── ────── ─────── + office active UP/UP ``` ## `heroku spaces:vpn:destroy` @@ -336,18 +361,19 @@ destroys VPN in a private space ``` USAGE - $ heroku spaces:vpn:destroy + $ heroku spaces:vpn:destroy [NAME] [-s ] [-n ] [--confirm ] -OPTIONS - -n, --name=name name or id of the VPN connection to retrieve config from - -s, --space=space space to get peering info from - --confirm=confirm set to VPN connection name to bypass confirm prompt +FLAGS + -n, --name= name or id of the VPN connection to retrieve config from + -s, --space= space to get peering info from + --confirm= set to VPN connection name to bypass confirm prompt DESCRIPTION + destroys VPN in a private space Example: - $ heroku spaces:vpn:destroy --space example-space vpn-connection-name --confirm vpn-connection-name - Tearing down VPN Connection vpn-connection-name in space example-space + $ heroku spaces:vpn:destroy --space example-space vpn-connection-name --confirm vpn-connection-name + Tearing down VPN Connection vpn-connection-name in space example-space ``` ## `heroku spaces:vpn:info` @@ -356,29 +382,30 @@ display the information for VPN ``` USAGE - $ heroku spaces:vpn:info + $ heroku spaces:vpn:info [NAME] [-s ] [--json] [-n ] -OPTIONS - -n, --name=name name or id of the VPN connection to get info from - -s, --space=space space the vpn connection belongs to - --json output in json format +FLAGS + -n, --name= name or id of the VPN connection to get info from + -s, --space= space the vpn connection belongs to + --json output in json format DESCRIPTION + display the information for VPN Example: - $ heroku spaces:vpn:info --space my-space vpn-connection-name - === vpn-connection-name VPN Tunnel Info - Name: vpn-connection-name - ID: 123456789012 - Public IP: 35.161.69.30 - Routable CIDRs: 172.16.0.0/16 - Status: failed - Status Message: supplied CIDR block already in use - === my-space Tunnel Info - VPN Tunnel IP Address Status Status Last Changed Details - ────────── ───────────── ────── ──────────────────── ────────────── - Tunnel 1 52.44.146.197 UP 2016-10-25T22:09:05Z status message - Tunnel 2 52.44.146.197 UP 2016-10-25T22:09:05Z status message + $ heroku spaces:vpn:info --space my-space vpn-connection-name + === vpn-connection-name VPN Tunnel Info + Name: vpn-connection-name + ID: 123456789012 + Public IP: 35.161.69.30 + Routable CIDRs: 172.16.0.0/16 + Status: failed + Status Message: supplied CIDR block already in use + === my-space Tunnel Info + VPN Tunnel IP Address Status Status Last Changed Details + ────────── ───────────── ────── ──────────────────── ────────────── + Tunnel 1 52.44.146.197 UP 2016-10-25T22:09:05Z status message + Tunnel 2 52.44.146.197 UP 2016-10-25T22:09:05Z status message ``` ## `heroku spaces:vpn:update` @@ -387,15 +414,16 @@ update VPN ``` USAGE - $ heroku spaces:vpn:update + $ heroku spaces:vpn:update [NAME] [-n ] [-c ] [-s ] -OPTIONS - -c, --cidrs=cidrs a list of routable CIDRs separated by commas - -n, --name=name VPN name - -s, --space=space space name +FLAGS + -c, --cidrs= a list of routable CIDRs separated by commas + -n, --name= VPN name + -s, --space= space name DESCRIPTION - Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to + update VPN + Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to hosts on your private networks and vice versa. The connection is established over the public Internet but all traffic is encrypted using IPSec. @@ -410,14 +438,17 @@ wait for VPN Connection to be created ``` USAGE - $ heroku spaces:vpn:wait + $ heroku spaces:vpn:wait [NAME] [-s ] [-n ] [--json] [-i ] [-t ] + +FLAGS + -i, --interval= seconds to wait between poll intervals + -n, --name= name or id of the vpn connection to wait for + -s, --space= space the vpn connection belongs to + -t, --timeout= maximum number of seconds to wait + --json output in json format -OPTIONS - -i, --interval=interval seconds to wait between poll intervals - -n, --name=name name or id of the vpn connection to wait for - -s, --space=space space the vpn connection belongs to - -t, --timeout=timeout maximum number of seconds to wait - --json output in json format +DESCRIPTION + wait for VPN Connection to be created ``` ## `heroku spaces:wait` @@ -426,11 +457,14 @@ wait for a space to be created ``` USAGE - $ heroku spaces:wait + $ heroku spaces:wait [SPACE] [-s ] [--json] [-i ] [-t ] + +FLAGS + -i, --interval= seconds to wait between poll intervals + -s, --space= space to get info of + -t, --timeout= maximum number of seconds to wait + --json output in json format -OPTIONS - -i, --interval=interval seconds to wait between poll intervals - -s, --space=space space to get info of - -t, --timeout=timeout maximum number of seconds to wait - --json output in json format +DESCRIPTION + wait for a space to be created ``` diff --git a/docs/teams.md b/docs/teams.md index 1785cbc145..dd4693971c 100644 --- a/docs/teams.md +++ b/docs/teams.md @@ -11,11 +11,13 @@ list the teams that you are a member of ``` USAGE - $ heroku teams + $ heroku teams [--json] -OPTIONS +FLAGS --json output in json format DESCRIPTION + list the teams that you are a member of + Use heroku members:* to manage team members. ``` diff --git a/docs/update.md b/docs/update.md index 81eae5fe59..60db68ddce 100644 --- a/docs/update.md +++ b/docs/update.md @@ -11,10 +11,31 @@ update the heroku CLI ``` USAGE - $ heroku update [CHANNEL] + $ heroku update [CHANNEL] [-a] [-v | -i] [--force] -OPTIONS - --from-local interactively choose an already installed version -``` +FLAGS + -a, --available Install a specific version. + -i, --interactive Interactively select version to install. This is ignored if a channel is provided. + -v, --version= Install a specific version. + --force Force a re-download of the requested version. + +DESCRIPTION + update the heroku CLI + +EXAMPLES + Update to the stable channel: + + $ heroku update stable + + Update to a specific version: -_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.5.0/src/commands/update.ts)_ + $ heroku update --version 1.0.0 + + Interactively select version: + + $ heroku update --interactive + + See available versions: + + $ heroku update --available +``` diff --git a/docs/version.md b/docs/version.md new file mode 100644 index 0000000000..1ffefb1254 --- /dev/null +++ b/docs/version.md @@ -0,0 +1,24 @@ +`heroku version` +================ + + + +* [`heroku version`](#heroku-version) + +## `heroku version` + +``` +USAGE + $ heroku version [--json] [--verbose] + +FLAGS + --verbose Show additional information about the CLI. + +GLOBAL FLAGS + --json Format output as json. + +FLAG DESCRIPTIONS + --verbose Show additional information about the CLI. + + Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using. +``` diff --git a/docs/webhooks.md b/docs/webhooks.md index 7d30f390ba..389b36ff82 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -19,173 +19,181 @@ list webhooks on an app ``` USAGE - $ heroku webhooks + $ heroku webhooks [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + list webhooks on an app -EXAMPLE +EXAMPLES $ heroku webhooks ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/index.ts)_ - ## `heroku webhooks:add` add a webhook to an app ``` USAGE - $ heroku webhooks:add - -OPTIONS - -a, --app=app app to run command against - -i, --include=include (required) comma delimited event types your server will receive - -l, --level=level (required) notify does not retry, sync will retry until successful or timeout - -r, --remote=remote git remote of app to use - -s, --secret=secret value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header - -t, --authorization=authorization authoriation header to send with webhooks - -u, --url=url (required) URL for receiver - -EXAMPLE + $ heroku webhooks:add -i -l -u [-a ] [-r ] [-s ] [-t ] + +FLAGS + -a, --app= app to run command against + -i, --include= (required) comma delimited event types your server will receive + -l, --level= (required) notify does not retry, sync will retry until successful or timeout + -r, --remote= git remote of app to use + -s, --secret= value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header + -t, --authorization= authoriation header to send with webhooks + -u, --url= (required) URL for receiver + +DESCRIPTION + add a webhook to an app + +EXAMPLES $ heroku webhooks:add -i api:dyno -l notify -u https://example.com/hooks ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/add.ts)_ - ## `heroku webhooks:deliveries` list webhook deliveries on an app ``` USAGE - $ heroku webhooks:deliveries + $ heroku webhooks:deliveries [-a ] [-r ] [-s ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + -s, --status= filter deliveries by status -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - -s, --status=status filter deliveries by status +DESCRIPTION + list webhook deliveries on an app -EXAMPLE +EXAMPLES $ heroku webhooks:deliveries ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/deliveries/index.ts)_ - ## `heroku webhooks:deliveries:info ID` info for a webhook event on an app ``` USAGE - $ heroku webhooks:deliveries:info ID + $ heroku webhooks:deliveries:info ID [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + info for a webhook event on an app -EXAMPLE +EXAMPLES $ heroku webhooks:deliveries:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/deliveries/info.ts)_ - ## `heroku webhooks:events` list webhook events on an app ``` USAGE - $ heroku webhooks:events + $ heroku webhooks:events [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + list webhook events on an app -EXAMPLE +EXAMPLES $ heroku webhooks:events ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/events/index.ts)_ - ## `heroku webhooks:events:info ID` info for a webhook event on an app ``` USAGE - $ heroku webhooks:events:info ID + $ heroku webhooks:events:info ID [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -EXAMPLE +DESCRIPTION + info for a webhook event on an app + +EXAMPLES $ heroku webhooks:events:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/events/info.ts)_ - ## `heroku webhooks:info ID` info for a webhook on an app ``` USAGE - $ heroku webhooks:info ID + $ heroku webhooks:info ID [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + info for a webhook on an app -EXAMPLE +EXAMPLES $ heroku webhooks:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/info.ts)_ - ## `heroku webhooks:remove ID` removes a webhook from an app ``` USAGE - $ heroku webhooks:remove ID + $ heroku webhooks:remove ID [-a ] [-r ] ARGUMENTS ID id of webhook to remove -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + removes a webhook from an app -EXAMPLE +EXAMPLES $ heroku webhooks:remove 99999999-9999-9999-9999-999999999999 ``` -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/remove.ts)_ - ## `heroku webhooks:update ID` updates a webhook in an app ``` USAGE - $ heroku webhooks:update ID + $ heroku webhooks:update ID -i -l -u [-a ] [-r ] [-s ] [-t ] -OPTIONS - -a, --app=app app to run command against - -i, --include=include (required) comma delimited event types your server will receive - -l, --level=level (required) notify does not retry, sync will retry until successful or timeout - -r, --remote=remote git remote of app to use - -s, --secret=secret value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header - -t, --authorization=authorization authoriation header to send with webhooks - -u, --url=url (required) URL for receiver +FLAGS + -a, --app= app to run command against + -i, --include= (required) comma delimited event types your server will receive + -l, --level= (required) notify does not retry, sync will retry until successful or timeout + -r, --remote= git remote of app to use + -s, --secret= value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header + -t, --authorization= authoriation header to send with webhooks + -u, --url= (required) URL for receiver -EXAMPLE - $ heroku webhooks:update 99999999-9999-9999-9999-999999999999 -i dyno -l notify -s - 09928c40bf1b191b645174a19f7053d16a180da37332e719ef0998f4c0a2 -u https://example.com/hooks -``` +DESCRIPTION + updates a webhook in an app -_See code: [@heroku-cli/plugin-webhooks](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/update.ts)_ +EXAMPLES + $ heroku webhooks:update 99999999-9999-9999-9999-999999999999 -i dyno -l notify -s 09928c40bf1b191b645174a19f7053d16a180da37332e719ef0998f4c0a2 -u https://example.com/hooks +``` diff --git a/lerna.json b/lerna.json index 412a969a40..9f76a290b1 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "7.69.1", + "version": "8.0.2-beta.0", "useWorkspaces": true, "npmClient": "yarn", "command": { diff --git a/packages/addons-v5/CHANGELOG.md b/packages/addons-v5/CHANGELOG.md index 4fb6380049..fa6d80491b 100644 --- a/packages/addons-v5/CHANGELOG.md +++ b/packages/addons-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/addons-v5/README.md b/packages/addons-v5/README.md index c562224e50..69e39cde4f 100644 --- a/packages/addons-v5/README.md +++ b/packages/addons-v5/README.md @@ -30,13 +30,14 @@ lists your add-ons and attachments USAGE $ heroku addons [--all|--app APP] -OPTIONS - -A, --all show add-ons and attachments for all accessible apps - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --json return add-ons in json format +FLAGS + -A, --all show add-ons and attachments for all accessible apps + -a, --app= app to run command against + -r, --remote= git remote of app to use + --json return add-ons in json format DESCRIPTION + lists your add-ons and attachments The default filter applied depends on whether you are in a Heroku app directory. If so, the --app flag is implied. If not, the default of --all is implied. Explicitly providing either flag overrides the default @@ -44,6 +45,7 @@ DESCRIPTION EXAMPLES $ heroku addons --all + $ heroku addons --app acme-inc-www ``` @@ -53,14 +55,18 @@ attach an existing add-on resource to an app ``` USAGE - $ heroku addons:attach ADDON_NAME - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --as=as name for add-on attachment - --confirm=confirm overwrite existing add-on attachment with same name - --credential=credential credential name for scoped access to Heroku Postgres + $ heroku addons:attach ADDON_NAME -a [--as ] [--credential ] [--confirm ] [-r + ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --as= name for add-on attachment + --confirm= overwrite existing add-on attachment with same name + --credential= credential name for scoped access to Heroku Postgres + +DESCRIPTION + attach an existing add-on resource to an app ``` ## `heroku addons:create SERVICE:PLAN` @@ -69,15 +75,19 @@ create a new add-on resource ``` USAGE - $ heroku addons:create SERVICE:PLAN - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --as=as name for the initial add-on attachment - --confirm=confirm overwrite existing config vars or existing add-on attachments - --name=name name for the add-on resource - --wait watch add-on creation status and exit when complete + $ heroku addons:create SERVICE:PLAN -a [--name ] [--as ] [--confirm ] [--wait] [-r + ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --as= name for the initial add-on attachment + --confirm= overwrite existing config vars or existing add-on attachments + --name= name for the add-on resource + --wait watch add-on creation status and exit when complete + +DESCRIPTION + create a new add-on resource ``` ## `heroku addons:destroy [ADDON]... [flags]` @@ -88,11 +98,14 @@ permanently destroy an add-on resource USAGE $ heroku addons:destroy [ADDON]... [flags] -OPTIONS - -a, --app=app app to run command against - -c, --confirm=confirm +FLAGS + -a, --app= app to run command against + -c, --confirm= -f, --force allow destruction even if connected to other apps - -r, --remote=remote git remote of app to use + -r, --remote= git remote of app to use + +DESCRIPTION + permanently destroy an add-on resource ``` ## `heroku addons:detach ATTACHMENT_NAME` @@ -101,11 +114,14 @@ detach an existing add-on resource from an app ``` USAGE - $ heroku addons:detach ATTACHMENT_NAME + $ heroku addons:detach ATTACHMENT_NAME -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + detach an existing add-on resource from an app ``` ## `heroku addons:docs ADDON` @@ -114,12 +130,15 @@ open an add-on's Dev Center documentation in your browser ``` USAGE - $ heroku addons:docs ADDON + $ heroku addons:docs ADDON [--show-url] [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --show-url show URL, do not open browser -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --show-url show URL, do not open browser +DESCRIPTION + open an add-on's Dev Center documentation in your browser ``` ## `heroku addons:downgrade ADDON [PLAN]` @@ -128,13 +147,14 @@ change add-on plan ``` USAGE - $ heroku addons:downgrade ADDON [PLAN] + $ heroku addons:downgrade ADDON [PLAN] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use DESCRIPTION + change add-on plan See available plans with `heroku addons:plans SERVICE`. Note that `heroku addons:upgrade` and `heroku addons:downgrade` are the same. @@ -142,10 +162,9 @@ DESCRIPTION https://devcenter.heroku.com/articles/managing-add-ons -EXAMPLE +EXAMPLES Upgrade an add-on by service name: $ heroku addons:upgrade heroku-redis:premium-2 - Upgrade a specific add-on: $ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2 ``` @@ -158,9 +177,12 @@ show detailed add-on resource and attachment information USAGE $ heroku addons:info ADDON -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + show detailed add-on resource and attachment information ``` ## `heroku addons:open ADDON` @@ -169,12 +191,15 @@ open an add-on's dashboard in your browser ``` USAGE - $ heroku addons:open ADDON + $ heroku addons:open ADDON [--show-url] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --show-url show URL, do not open browser +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --show-url show URL, do not open browser + +DESCRIPTION + open an add-on's dashboard in your browser ``` ## `heroku addons:plans SERVICE` @@ -183,10 +208,13 @@ list all available plans for an add-on services ``` USAGE - $ heroku addons:plans SERVICE + $ heroku addons:plans SERVICE [--json] -OPTIONS +FLAGS --json output in json format + +DESCRIPTION + list all available plans for an add-on services ``` ## `heroku addons:rename ADDON NEW_NAME` @@ -197,9 +225,12 @@ rename an add-on USAGE $ heroku addons:rename ADDON NEW_NAME -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + rename an add-on ``` ## `heroku addons:services` @@ -208,10 +239,13 @@ list all available add-on services ``` USAGE - $ heroku addons:services + $ heroku addons:services [--json] -OPTIONS +FLAGS --json output in json format + +DESCRIPTION + list all available add-on services ``` ## `heroku addons:upgrade ADDON [PLAN]` @@ -220,13 +254,14 @@ change add-on plan ``` USAGE - $ heroku addons:upgrade ADDON [PLAN] + $ heroku addons:upgrade ADDON [PLAN] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use DESCRIPTION + change add-on plan See available plans with `heroku addons:plans SERVICE`. Note that `heroku addons:upgrade` and `heroku addons:downgrade` are the same. @@ -234,10 +269,9 @@ DESCRIPTION https://devcenter.heroku.com/articles/managing-add-ons -EXAMPLE +EXAMPLES Upgrade an add-on by service name: $ heroku addons:upgrade heroku-redis:premium-2 - Upgrade a specific add-on: $ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2 ``` @@ -250,9 +284,12 @@ show provisioning status of the add-ons on the app USAGE $ heroku addons:wait ADDON -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --wait-interval=wait-interval how frequently to poll in seconds +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --wait-interval= how frequently to poll in seconds + +DESCRIPTION + show provisioning status of the add-ons on the app ``` diff --git a/packages/addons-v5/package.json b/packages/addons-v5/package.json index c4a2516d58..bbc1d849df 100644 --- a/packages/addons-v5/package.json +++ b/packages/addons-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-addons-v5", "description": "`heroku addons:*` commands", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Bo Jeanes @bjeanes", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/apps-v5/CHANGELOG.md b/packages/apps-v5/CHANGELOG.md index 3f082ce708..72d450798a 100644 --- a/packages/apps-v5/CHANGELOG.md +++ b/packages/apps-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + ## [7.68.1](https://github.com/heroku/cli/compare/v7.68.0...v7.68.1) (2023-02-14) **Note:** Version bump only for package @heroku-cli/plugin-apps-v5 diff --git a/packages/apps-v5/README.md b/packages/apps-v5/README.md index 0cde48b564..de43f7793d 100644 --- a/packages/apps-v5/README.md +++ b/packages/apps-v5/README.md @@ -12,8 +12,8 @@ This core plugin comes preinstalled to the [Heroku CLI](https://cli.heroku.com). $ npm install -g @heroku-cli/plugin-apps-v5 $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-apps-v5/7.68.1 darwin-x64 node-v16.19.0 +$ heroku (--version) +@heroku-cli/plugin-apps-v5/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -75,21 +75,24 @@ list your apps ``` USAGE - $ heroku apps + $ heroku apps [-A] [--json] [-s ] [-p] [-t ] + +FLAGS + -A, --all include apps in all teams + -p, --personal list apps in personal account when a default team is set + -s, --space= filter by space + -t, --team= team to use + --json output in json format + +DESCRIPTION + list your apps -OPTIONS - -A, --all include apps in all teams - -p, --personal list apps in personal account when a default team is set - -s, --space=space filter by space - -t, --team=team team to use - --json output in json format EXAMPLES $ heroku apps === My Apps example example2 - === Collaborated Apps theirapp other@owner.name ``` @@ -100,42 +103,41 @@ creates a new app ``` USAGE - $ heroku apps:create [APP] + $ heroku apps:create [APP] [--addons ] [-b ] [-n] [-r ] [-s ] [--space ] + [--region ] [--json] [-t ] ARGUMENTS APP name of app to create -OPTIONS - -b, --buildpack=buildpack buildpack url to use for this app - -n, --no-remote do not create a git remote - -r, --remote=remote the git remote to create, default "heroku" - -s, --stack=stack the stack to create the app on - -t, --team=team team to use - --addons=addons comma-delimited list of addons to install - --json output in json format - --region=region specify region for the app to run in - --space=space the private space to create the app in +FLAGS + -b, --buildpack= buildpack url to use for this app + -n, --no-remote do not create a git remote + -r, --remote= the git remote to create, default "heroku" + -s, --stack= the stack to create the app on + -t, --team= team to use + --addons= comma-delimited list of addons to install + --json output in json format + --region= specify region for the app to run in + --space= the private space to create the app in + +DESCRIPTION + creates a new app + EXAMPLES $ heroku apps:create Creating app... done, stack is heroku-22 https://floating-dragon-42.heroku.com/ | https://git.heroku.com/floating-dragon-42.git - # or just $ heroku create - # use a heroku.yml manifest file $ heroku apps:create --manifest - # specify a buildpack $ heroku apps:create --buildpack https://github.com/some/buildpack.git - # specify a name $ heroku apps:create example - # create a staging app $ heroku apps:create example-staging --remote staging - # create an app in the eu region $ heroku apps:create --region eu ``` @@ -146,14 +148,15 @@ permanently destroy an app ``` USAGE - $ heroku apps:destroy + $ heroku apps:destroy [APP] [-c ] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -c, --confirm= + -r, --remote= git remote of app to use DESCRIPTION + permanently destroy an app This will also destroy all add-ons on the app. ``` @@ -163,15 +166,18 @@ view app errors ``` USAGE - $ heroku apps:errors + $ heroku apps:errors -a [--json] [--hours ] [--router] [--dyno] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --dyno show only dyno errors - --hours=hours number of hours to look back (default 24) - --json output in json format - --router show only router errors +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --dyno show only dyno errors + --hours= number of hours to look back (default 24) + --json output in json format + --router show only router errors + +DESCRIPTION + view app errors ``` ## `heroku apps:favorites` @@ -180,10 +186,13 @@ list favorited apps ``` USAGE - $ heroku apps:favorites + $ heroku apps:favorites [--json] -OPTIONS +FLAGS --json output in json format + +DESCRIPTION + list favorited apps ``` ## `heroku apps:favorites:add` @@ -192,11 +201,14 @@ favorites an app ``` USAGE - $ heroku apps:favorites:add + $ heroku apps:favorites:add -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + favorites an app ``` ## `heroku apps:favorites:remove` @@ -205,11 +217,14 @@ unfavorites an app ``` USAGE - $ heroku apps:favorites:remove + $ heroku apps:favorites:remove -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + unfavorites an app ``` ## `heroku apps:info` @@ -218,15 +233,16 @@ show detailed app information ``` USAGE - $ heroku apps:info + $ heroku apps:info [APP] [-s] [-j] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against +FLAGS + -a, --app= app to run command against -j, --json - -r, --remote=remote git remote of app to use - -s, --shell output more shell friendly key/value pairs + -r, --remote= git remote of app to use + -s, --shell output more shell friendly key/value pairs DESCRIPTION + show detailed app information $ heroku apps:info === example Git URL: https://git.heroku.com/example.git @@ -245,16 +261,19 @@ open the app in a web browser ``` USAGE - $ heroku apps:open [PATH] + $ heroku apps:open [PATH] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + open the app in a web browser -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku open -a myapp # opens https://myapp.herokuapp.com - $ heroku open -a myapp /foo # opens https://myapp.herokuapp.com/foo ``` @@ -265,13 +284,14 @@ rename an app ``` USAGE - $ heroku apps:rename NEWNAME + $ heroku apps:rename NEWNAME -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + rename an app This will locally update the git remote if it is set to the old app. EXAMPLES @@ -286,11 +306,14 @@ show the list of available stacks ``` USAGE - $ heroku apps:stacks + $ heroku apps:stacks -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + show the list of available stacks ``` ## `heroku apps:stacks:set STACK` @@ -299,11 +322,15 @@ set the stack of an app ``` USAGE - $ heroku apps:stacks:set STACK + $ heroku apps:stacks:set STACK -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + set the stack of an app -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku stack:set heroku-22 -a myapp @@ -318,17 +345,20 @@ set one or more config vars ``` USAGE - $ heroku config:set + $ heroku config:set -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + set one or more config vars -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku config:set RAILS_ENV=staging Setting config vars and restarting example... done, v10 RAILS_ENV: staging - $ heroku config:set RAILS_ENV=staging RACK_ENV=staging Setting config vars and restarting example... done, v11 RAILS_ENV: staging @@ -341,12 +371,15 @@ display the log drains of an app ``` USAGE - $ heroku drains + $ heroku drains -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format + +DESCRIPTION + display the log drains of an app ``` ## `heroku drains:add URL` @@ -355,11 +388,14 @@ adds a log drain to an app ``` USAGE - $ heroku drains:add URL + $ heroku drains:add URL -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + adds a log drain to an app ``` ## `heroku drains:remove [URL|TOKEN]` @@ -370,9 +406,12 @@ removes a log drain from an app USAGE $ heroku drains:remove [URL|TOKEN] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + removes a log drain from an app ``` ## `heroku dyno:kill DYNO` @@ -381,19 +420,20 @@ stop app dyno ``` USAGE - $ heroku dyno:kill DYNO + $ heroku dyno:kill DYNO -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + stop app dyno + stop app dyno or dyno type EXAMPLES $ heroku ps:stop run.1828 Stopping run.1828 dyno... done - $ heroku ps:stop run Stopping run dynos... done ``` @@ -404,13 +444,15 @@ manage dyno sizes ``` USAGE - $ heroku dyno:resize + $ heroku dyno:resize -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + manage dyno sizes + Called with no arguments shows the current dyno size. Called with one argument sets the size. @@ -425,22 +467,21 @@ restart app dynos ``` USAGE - $ heroku dyno:restart [DYNO] + $ heroku dyno:restart [DYNO] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + restart app dynos if DYNO is not specified, restarts all dynos on app EXAMPLES $ heroku ps:restart web.1 Restarting web.1 dyno... done - $ heroku ps:restart web Restarting web dynos... done - $ heroku ps:restart Restarting dynos... done ``` @@ -451,13 +492,14 @@ scale dyno quantity up or down ``` USAGE - $ heroku dyno:scale + $ heroku dyno:scale -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + scale dyno quantity up or down Appending a size (eg. web=2:Standard-2X) allows simultaneous scaling and resizing. Omitting any arguments will display the app's current dyno formation, in a @@ -466,7 +508,6 @@ DESCRIPTION EXAMPLES $ heroku ps:scale web=3:Standard-2X worker+1 Scaling dynos... done, now running web at 3:Standard-2X, worker at 1:Standard-1X. - $ heroku ps:scale web=3:Standard-2X worker=1:Standard-1X ``` @@ -477,19 +518,20 @@ stop app dyno ``` USAGE - $ heroku dyno:stop DYNO + $ heroku dyno:stop DYNO -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + stop app dyno + stop app dyno or dyno type EXAMPLES $ heroku ps:stop run.1828 Stopping run.1828 dyno... done - $ heroku ps:stop run Stopping run dynos... done ``` @@ -500,12 +542,15 @@ list available app features ``` USAGE - $ heroku features + $ heroku features -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format + +DESCRIPTION + list available app features ``` ## `heroku features:disable FEATURE` @@ -514,11 +559,14 @@ disables an app feature ``` USAGE - $ heroku features:disable FEATURE + $ heroku features:disable FEATURE -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + disables an app feature ``` ## `heroku features:enable FEATURE` @@ -527,11 +575,14 @@ enables an app feature ``` USAGE - $ heroku features:enable FEATURE + $ heroku features:enable FEATURE -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + enables an app feature ``` ## `heroku features:info FEATURE` @@ -540,12 +591,15 @@ display information about a feature ``` USAGE - $ heroku features:info FEATURE + $ heroku features:info FEATURE -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format + +DESCRIPTION + display information about a feature ``` ## `heroku keys` @@ -554,11 +608,14 @@ display your SSH keys ``` USAGE - $ heroku keys + $ heroku keys [-l] [--json] -OPTIONS +FLAGS -l, --long display full SSH keys --json output in json format + +DESCRIPTION + display your SSH keys ``` ## `heroku keys:add [KEY]` @@ -567,12 +624,13 @@ add an SSH key for a user ``` USAGE - $ heroku keys:add [KEY] + $ heroku keys:add [KEY] [-y] -OPTIONS +FLAGS -y, --yes automatically answer yes for all prompts DESCRIPTION + add an SSH key for a user if no KEY is specified, will try to find ~/.ssh/id_rsa.pub EXAMPLES @@ -581,7 +639,6 @@ EXAMPLES Would you like to generate one? [Yn] y Generating new SSH public key. Uploading SSH public key /.ssh/id_rsa.pub... done - $ heroku keys:add /my/key.pub Uploading SSH public key /my/key.pub... done ``` @@ -593,6 +650,9 @@ remove all SSH keys for current user ``` USAGE $ heroku keys:clear + +DESCRIPTION + remove all SSH keys for current user ``` ## `heroku keys:remove KEY` @@ -603,6 +663,10 @@ remove an SSH key from the user USAGE $ heroku keys:remove KEY +DESCRIPTION + remove an SSH key from the user + + EXAMPLES $ heroku keys:remove email@example.com Removing email@example.com SSH key... done @@ -614,12 +678,15 @@ list experimental features ``` USAGE - $ heroku labs + $ heroku labs [--json] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --json display as json +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --json display as json + +DESCRIPTION + list experimental features ``` ## `heroku labs:enable FEATURE` @@ -628,11 +695,14 @@ enables an experimental feature ``` USAGE - $ heroku labs:enable FEATURE + $ heroku labs:enable FEATURE [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + enables an experimental feature ``` ## `heroku labs:info FEATURE` @@ -641,12 +711,15 @@ show feature info ``` USAGE - $ heroku labs:info FEATURE + $ heroku labs:info FEATURE [--json] [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --json display as json -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --json display as json +DESCRIPTION + show feature info ``` ## `heroku maintenance` @@ -655,11 +728,14 @@ display the current maintenance status of app ``` USAGE - $ heroku maintenance + $ heroku maintenance -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + display the current maintenance status of app ``` ## `heroku maintenance:off` @@ -668,11 +744,14 @@ take the app out of maintenance mode ``` USAGE - $ heroku maintenance:off + $ heroku maintenance:off -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + take the app out of maintenance mode ``` ## `heroku maintenance:on` @@ -681,11 +760,14 @@ put the app into maintenance mode ``` USAGE - $ heroku maintenance:on + $ heroku maintenance:on -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + put the app into maintenance mode ``` ## `heroku notifications` @@ -694,14 +776,17 @@ display notifications ``` USAGE - $ heroku notifications + $ heroku notifications [--all] [--json] [--read] [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --all view all notifications (not just the ones for the current app) - --json output in json format - --read show notifications already read +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + --all view all notifications (not just the ones for the current app) + --json output in json format + --read show notifications already read + +DESCRIPTION + display notifications ``` ## `heroku ps [TYPE [TYPE ...]]` @@ -712,19 +797,21 @@ list dynos for an app USAGE $ heroku ps [TYPE [TYPE ...]] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json display as json +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json display as json + +DESCRIPTION + list dynos for an app + EXAMPLES $ heroku ps === run: one-off dyno run.1: up for 5m: bash - === web: bundle exec thin start -p $PORT web.1: created for 30s - $ heroku ps run # specifying types === run: one-off dyno run.1: up for 5m: bash @@ -736,19 +823,20 @@ stop app dyno ``` USAGE - $ heroku ps:kill DYNO + $ heroku ps:kill DYNO -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + stop app dyno + stop app dyno or dyno type EXAMPLES $ heroku ps:stop run.1828 Stopping run.1828 dyno... done - $ heroku ps:stop run Stopping run dynos... done ``` @@ -759,13 +847,15 @@ manage dyno sizes ``` USAGE - $ heroku ps:resize + $ heroku ps:resize -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + manage dyno sizes + Called with no arguments shows the current dyno size. Called with one argument sets the size. @@ -780,22 +870,21 @@ restart app dynos ``` USAGE - $ heroku ps:restart [DYNO] + $ heroku ps:restart [DYNO] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + restart app dynos if DYNO is not specified, restarts all dynos on app EXAMPLES $ heroku ps:restart web.1 Restarting web.1 dyno... done - $ heroku ps:restart web Restarting web dynos... done - $ heroku ps:restart Restarting dynos... done ``` @@ -806,13 +895,14 @@ scale dyno quantity up or down ``` USAGE - $ heroku ps:scale + $ heroku ps:scale -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + scale dyno quantity up or down Appending a size (eg. web=2:Standard-2X) allows simultaneous scaling and resizing. Omitting any arguments will display the app's current dyno formation, in a @@ -821,7 +911,6 @@ DESCRIPTION EXAMPLES $ heroku ps:scale web=3:Standard-2X worker+1 Scaling dynos... done, now running web at 3:Standard-2X, worker at 1:Standard-1X. - $ heroku ps:scale web=3:Standard-2X worker=1:Standard-1X ``` @@ -832,19 +921,20 @@ stop app dyno ``` USAGE - $ heroku ps:stop DYNO + $ heroku ps:stop DYNO -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + stop app dyno + stop app dyno or dyno type EXAMPLES $ heroku ps:stop run.1828 Stopping run.1828 dyno... done - $ heroku ps:stop run Stopping run dynos... done ``` @@ -855,13 +945,15 @@ manage dyno sizes ``` USAGE - $ heroku ps:type + $ heroku ps:type -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + manage dyno sizes + Called with no arguments shows the current dyno size. Called with one argument sets the size. @@ -876,13 +968,17 @@ display the releases for an app ``` USAGE - $ heroku releases + $ heroku releases -a [-n ] [--json] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -n, --num= number of releases to show + -r, --remote= git remote of app to use + --json output releases in json format + +DESCRIPTION + display the releases for an app -OPTIONS - -a, --app=app (required) app to run command against - -n, --num=num number of releases to show - -r, --remote=remote git remote of app to use - --json output releases in json format EXAMPLES $ heroku releases @@ -898,13 +994,16 @@ view detailed information for a release ``` USAGE - $ heroku releases:info [RELEASE] + $ heroku releases:info [RELEASE] -a [--json] [-s] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --shell output in shell format - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + -s, --shell output in shell format + --json output in json format + +DESCRIPTION + view detailed information for a release ``` ## `heroku releases:output [RELEASE]` @@ -913,11 +1012,14 @@ View the release command output ``` USAGE - $ heroku releases:output [RELEASE] + $ heroku releases:output [RELEASE] -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + View the release command output ``` ## `heroku releases:rollback [RELEASE]` @@ -926,13 +1028,14 @@ rollback to a previous release ``` USAGE - $ heroku releases:rollback [RELEASE] + $ heroku releases:rollback [RELEASE] -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use DESCRIPTION + rollback to a previous release If RELEASE is not specified, it will rollback one release ``` diff --git a/packages/apps-v5/package.json b/packages/apps-v5/package.json index e54effbc41..f5da6ed565 100644 --- a/packages/apps-v5/package.json +++ b/packages/apps-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-apps-v5", "description": "Heroku CLI plugin to manage apps.", - "version": "7.68.1", + "version": "8.0.2-beta.0", "author": "Jeff Dickey (@jdxcode)", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/apps/CHANGELOG.md b/packages/apps/CHANGELOG.md index 1b7931d45a..35c1dfb024 100644 --- a/packages/apps/CHANGELOG.md +++ b/packages/apps/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/heroku-cli-plugin-apps/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/heroku-cli-plugin-apps/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/heroku-cli-plugin-apps/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/heroku-cli-plugin-apps/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/apps/README.md b/packages/apps/README.md index 244daa969f..27460d5c51 100644 --- a/packages/apps/README.md +++ b/packages/apps/README.md @@ -17,8 +17,8 @@ heroku-cli-plugin-apps $ npm install -g @heroku-cli/plugin-apps $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-apps/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-apps/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -27,160 +27,5 @@ USAGE # Commands -* [`heroku domains`](#heroku-domains) -* [`heroku domains:add HOSTNAME`](#heroku-domainsadd-hostname) -* [`heroku domains:clear`](#heroku-domainsclear) -* [`heroku domains:info HOSTNAME`](#heroku-domainsinfo-hostname) -* [`heroku domains:remove HOSTNAME`](#heroku-domainsremove-hostname) -* [`heroku domains:update [HOSTNAME]`](#heroku-domainsupdate-hostname) -* [`heroku domains:wait [HOSTNAME]`](#heroku-domainswait-hostname) -## `heroku domains` - -list domains for an app - -``` -USAGE - $ heroku domains - -OPTIONS - -a, --app=app (required) app to run command against - -h, --help show CLI help - -j, --json output in json format - -r, --remote=remote git remote of app to use - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format - --filter=filter filter property by partial string matching, ex: name=foo - --no-header hide table header from output - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLES - $ heroku domains - === example Heroku Domain - example.herokuapp.com - - === example Custom Domains - Domain Name DNS Record Type DNS Target - www.example.com CNAME www.example.herokudns.com - - $ heroku domains --filter 'Domain Name=www.example.com' -``` - -_See code: [src/commands/domains/index.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.68.0/src/commands/domains/index.ts)_ - -## `heroku domains:add HOSTNAME` - -add a domain to an app - -``` -USAGE - $ heroku domains:add HOSTNAME - -OPTIONS - -a, --app=app (required) app to run command against - -c, --cert=cert the name of the SSL cert you want to use for this domain - -h, --help show CLI help - -j, --json output in json format - -r, --remote=remote git remote of app to use - --wait - -EXAMPLE - heroku domains:add www.example.com -``` - -_See code: [src/commands/domains/add.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.68.0/src/commands/domains/add.ts)_ - -## `heroku domains:clear` - -remove all domains from an app - -``` -USAGE - $ heroku domains:clear - -OPTIONS - -a, --app=app (required) app to run command against - -h, --help show CLI help - -r, --remote=remote git remote of app to use - -EXAMPLE - heroku domains:clear -``` - -_See code: [src/commands/domains/clear.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.68.0/src/commands/domains/clear.ts)_ - -## `heroku domains:info HOSTNAME` - -show detailed information for a domain on an app - -``` -USAGE - $ heroku domains:info HOSTNAME - -OPTIONS - -a, --app=app (required) app to run command against - -h, --help show CLI help - -r, --remote=remote git remote of app to use - -EXAMPLE - $ heroku domains:info www.example.com -``` - -_See code: [src/commands/domains/info.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.68.0/src/commands/domains/info.ts)_ - -## `heroku domains:remove HOSTNAME` - -remove a domain from an app - -``` -USAGE - $ heroku domains:remove HOSTNAME - -OPTIONS - -a, --app=app (required) app to run command against - -h, --help show CLI help - -r, --remote=remote git remote of app to use - -EXAMPLE - heroku domains:remove www.example.com -``` - -_See code: [src/commands/domains/remove.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.68.0/src/commands/domains/remove.ts)_ - -## `heroku domains:update [HOSTNAME]` - -update a domain to use a different SSL certificate on an app - -``` -USAGE - $ heroku domains:update [HOSTNAME] - -OPTIONS - -a, --app=app (required) app to run command against - -h, --help show CLI help - -r, --remote=remote git remote of app to use - --cert=cert (required) the name or id of the certificate you want to use for this domain - -EXAMPLE - heroku domains:update www.example.com --cert mycert -``` - -_See code: [src/commands/domains/update.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.68.0/src/commands/domains/update.ts)_ - -## `heroku domains:wait [HOSTNAME]` - -wait for domain to be active for an app - -``` -USAGE - $ heroku domains:wait [HOSTNAME] - -OPTIONS - -a, --app=app (required) app to run command against - -h, --help show CLI help - -r, --remote=remote git remote of app to use -``` - -_See code: [src/commands/domains/wait.ts](https://github.com/heroku/heroku-cli-plugin-apps/blob/v7.68.0/src/commands/domains/wait.ts)_ diff --git a/packages/apps/package.json b/packages/apps/package.json index fbbff8d4bf..4e6964cfc0 100644 --- a/packages/apps/package.json +++ b/packages/apps/package.json @@ -1,6 +1,6 @@ { "name": "@heroku-cli/plugin-apps", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Brett @brettgoulder", "bugs": "https://github.com/heroku/heroku-cli-plugin-apps/issues", "dependencies": { diff --git a/packages/auth/CHANGELOG.md b/packages/auth/CHANGELOG.md index 935d6f426c..2871cae99d 100644 --- a/packages/auth/CHANGELOG.md +++ b/packages/auth/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/auth/README.md b/packages/auth/README.md index 4f600e3b6a..8bad525bf8 100644 --- a/packages/auth/README.md +++ b/packages/auth/README.md @@ -14,125 +14,5 @@ auth core plugin for Heroku CLI # Commands -* [`heroku auth:2fa`](#heroku-auth2fa) -* [`heroku auth:2fa:disable`](#heroku-auth2fadisable) -* [`heroku auth:login`](#heroku-authlogin) -* [`heroku auth:logout`](#heroku-authlogout) -* [`heroku auth:token`](#heroku-authtoken) -* [`heroku auth:whoami`](#heroku-authwhoami) -* [`heroku labs:disable [FEATURE]`](#heroku-labsdisable-feature) -## `heroku auth:2fa` - -check 2fa status - -``` -USAGE - $ heroku auth:2fa - -ALIASES - $ heroku 2fa - $ heroku twofactor -``` - -_See code: [src/commands/auth/2fa/index.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/auth/2fa/index.ts)_ - -## `heroku auth:2fa:disable` - -disables 2fa on account - -``` -USAGE - $ heroku auth:2fa:disable - -ALIASES - $ heroku twofactor:disable - $ heroku 2fa:disable - -EXAMPLES - $ heroku auth:2fa:disable -``` - -_See code: [src/commands/auth/2fa/disable.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/auth/2fa/disable.ts)_ - -## `heroku auth:login` - -login with your Heroku credentials - -``` -USAGE - $ heroku auth:login - -OPTIONS - -e, --expires-in=expires-in duration of token in seconds (default 30 days) - -i, --interactive login with username/password - --browser=browser browser to open SSO with (example: "firefox", "safari") - -ALIASES - $ heroku login -``` - -_See code: [src/commands/auth/login.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/auth/login.ts)_ - -## `heroku auth:logout` - -clears local login credentials and invalidates API session - -``` -USAGE - $ heroku auth:logout - -ALIASES - $ heroku logout -``` - -_See code: [src/commands/auth/logout.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/auth/logout.ts)_ - -## `heroku auth:token` - -outputs current CLI authentication token. - -``` -USAGE - $ heroku auth:token - -OPTIONS - -h, --help show CLI help - -DESCRIPTION - By default, the CLI auth token is only valid for 1 year. To generate a long-lived token, use heroku - authorizations:create -``` - -_See code: [src/commands/auth/token.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/auth/token.ts)_ - -## `heroku auth:whoami` - -display the current logged in user - -``` -USAGE - $ heroku auth:whoami - -ALIASES - $ heroku whoami -``` - -_See code: [src/commands/auth/whoami.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/auth/whoami.ts)_ - -## `heroku labs:disable [FEATURE]` - -disables an experimental feature - -``` -USAGE - $ heroku labs:disable [FEATURE] - -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - --confirm=confirm -``` - -_See code: [src/commands/labs/disable.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/auth/src/commands/labs/disable.ts)_ diff --git a/packages/auth/package.json b/packages/auth/package.json index 2f64616142..e9b34ee88b 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-auth", "description": "auth core plugin for Heroku CLI", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey @jdxcode", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/autocomplete/CHANGELOG.md b/packages/autocomplete/CHANGELOG.md index f3af9c2d90..76837142f1 100644 --- a/packages/autocomplete/CHANGELOG.md +++ b/packages/autocomplete/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/autocomplete/README.md b/packages/autocomplete/README.md index 92f18121ad..ddfa2314e5 100644 --- a/packages/autocomplete/README.md +++ b/packages/autocomplete/README.md @@ -16,36 +16,18 @@ # Usage ```sh-session -$ heroku update -$ heroku plugins:install autocomplete -$ heroku autocomplete +$ npm install -g @heroku-cli/plugin-autocomplete +$ heroku COMMAND +running command... +$ heroku (--version|-v) +@heroku-cli/plugin-autocomplete/8.0.2-beta.0 darwin-arm64 node-v16.19.0 +$ heroku --help [COMMAND] +USAGE + $ heroku COMMAND +... ``` # Commands -* [`heroku autocomplete [SHELL]`](#heroku-autocomplete-shell) - -## `heroku autocomplete [SHELL]` - -display autocomplete installation instructions - -``` -USAGE - $ heroku autocomplete [SHELL] - -ARGUMENTS - SHELL shell type - -OPTIONS - -s, --skip-instructions don't show installation instructions - -EXAMPLES - $ heroku autocomplete - - $ heroku autocomplete bash - - $ heroku autocomplete zsh -``` -_See code: [src/commands/autocomplete/index.ts](https://github.com/heroku/heroku-cli-autocomplete/blob/master/src/commands/autocomplete/index.ts)_ diff --git a/packages/autocomplete/package.json b/packages/autocomplete/package.json index 858970cdff..82f6511e1e 100644 --- a/packages/autocomplete/package.json +++ b/packages/autocomplete/package.json @@ -1,6 +1,6 @@ { "name": "@heroku-cli/plugin-autocomplete", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Philipe Navarro @RasPhilCo", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/buildpacks/CHANGELOG.md b/packages/buildpacks/CHANGELOG.md index b6f6302acc..6998ac782e 100644 --- a/packages/buildpacks/CHANGELOG.md +++ b/packages/buildpacks/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/buildpacks/README.md b/packages/buildpacks/README.md index 2c69987ea5..5afcb60556 100644 --- a/packages/buildpacks/README.md +++ b/packages/buildpacks/README.md @@ -22,8 +22,8 @@ $ npm install -g @heroku-cli/plugin-buildpacks $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-buildpacks/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-buildpacks/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -32,144 +32,5 @@ USAGE # Commands -* [`heroku buildpacks`](#heroku-buildpacks) -* [`heroku buildpacks:add BUILDPACK`](#heroku-buildpacksadd-buildpack) -* [`heroku buildpacks:clear`](#heroku-buildpacksclear) -* [`heroku buildpacks:info BUILDPACK`](#heroku-buildpacksinfo-buildpack) -* [`heroku buildpacks:remove [BUILDPACK]`](#heroku-buildpacksremove-buildpack) -* [`heroku buildpacks:search [TERM]`](#heroku-buildpackssearch-term) -* [`heroku buildpacks:set BUILDPACK`](#heroku-buildpacksset-buildpack) -* [`heroku buildpacks:versions BUILDPACK`](#heroku-buildpacksversions-buildpack) -## `heroku buildpacks` - -display the buildpacks for an app - -``` -USAGE - $ heroku buildpacks - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` - -_See code: [src/commands/buildpacks/index.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/index.ts)_ - -## `heroku buildpacks:add BUILDPACK` - -add new app buildpack, inserting into list of buildpacks if necessary - -``` -USAGE - $ heroku buildpacks:add BUILDPACK - -ARGUMENTS - BUILDPACK namespace/name of the buildpack - -OPTIONS - -a, --app=app (required) app to run command against - -i, --index=index the 1-based index of the URL in the list of URLs - -r, --remote=remote git remote of app to use -``` - -_See code: [src/commands/buildpacks/add.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/add.ts)_ - -## `heroku buildpacks:clear` - -clear all buildpacks set on the app - -``` -USAGE - $ heroku buildpacks:clear - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` - -_See code: [src/commands/buildpacks/clear.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/clear.ts)_ - -## `heroku buildpacks:info BUILDPACK` - -fetch info about a buildpack - -``` -USAGE - $ heroku buildpacks:info BUILDPACK - -ARGUMENTS - BUILDPACK namespace/name of the buildpack -``` - -_See code: [src/commands/buildpacks/info.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/info.ts)_ - -## `heroku buildpacks:remove [BUILDPACK]` - -remove a buildpack set on the app - -``` -USAGE - $ heroku buildpacks:remove [BUILDPACK] - -ARGUMENTS - BUILDPACK namespace/name of the buildpack - -OPTIONS - -a, --app=app (required) app to run command against - -i, --index=index the 1-based index of the URL to remove from the list of URLs - -r, --remote=remote git remote of app to use -``` - -_See code: [src/commands/buildpacks/remove.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/remove.ts)_ - -## `heroku buildpacks:search [TERM]` - -search for buildpacks - -``` -USAGE - $ heroku buildpacks:search [TERM] - -ARGUMENTS - TERM search term that searches across name, namespace, and description - -OPTIONS - --description=description buildpack description to filter on - --name=name buildpack names to filter on using a comma separated list - --namespace=namespace buildpack namespaces to filter on using a comma separated list -``` - -_See code: [src/commands/buildpacks/search.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/search.ts)_ - -## `heroku buildpacks:set BUILDPACK` - -``` -USAGE - $ heroku buildpacks:set BUILDPACK - -ARGUMENTS - BUILDPACK namespace/name of the buildpack - -OPTIONS - -a, --app=app (required) app to run command against - -i, --index=index the 1-based index of the URL in the list of URLs - -r, --remote=remote git remote of app to use -``` - -_See code: [src/commands/buildpacks/set.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/set.ts)_ - -## `heroku buildpacks:versions BUILDPACK` - -list versions of a buildpack - -``` -USAGE - $ heroku buildpacks:versions BUILDPACK - -ARGUMENTS - BUILDPACK namespace/name of the buildpack -``` - -_See code: [src/commands/buildpacks/versions.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/buildpacks/src/commands/buildpacks/versions.ts)_ diff --git a/packages/buildpacks/package.json b/packages/buildpacks/package.json index 5e4be2f7a4..7d9c2233a3 100644 --- a/packages/buildpacks/package.json +++ b/packages/buildpacks/package.json @@ -1,6 +1,6 @@ { "name": "@heroku-cli/plugin-buildpacks", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Terence Lee @hone", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/certs-v5/CHANGELOG.md b/packages/certs-v5/CHANGELOG.md index dea6a3faa8..24342016fe 100644 --- a/packages/certs-v5/CHANGELOG.md +++ b/packages/certs-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/certs-v5/README.md b/packages/certs-v5/README.md index 8e6abf959c..68dc11aab5 100644 --- a/packages/certs-v5/README.md +++ b/packages/certs-v5/README.md @@ -7,17 +7,17 @@ heroku-certs * [`heroku certs`](#heroku-certs) -* [`heroku certs:add CRT KEY`](#heroku-certsadd-crt-key) +* [`heroku certs:add [CRT] [KEY]`](#heroku-certsadd-crt-key) * [`heroku certs:auto`](#heroku-certsauto) * [`heroku certs:auto:disable`](#heroku-certsautodisable) * [`heroku certs:auto:enable`](#heroku-certsautoenable) * [`heroku certs:auto:refresh`](#heroku-certsautorefresh) * [`heroku certs:chain`](#heroku-certschain) -* [`heroku certs:generate DOMAIN`](#heroku-certsgenerate-domain) +* [`heroku certs:generate [DOMAIN]`](#heroku-certsgenerate-domain) * [`heroku certs:info`](#heroku-certsinfo) * [`heroku certs:key`](#heroku-certskey) * [`heroku certs:remove`](#heroku-certsremove) -* [`heroku certs:update CRT KEY`](#heroku-certsupdate-crt-key) +* [`heroku certs:update [CRT] [KEY]`](#heroku-certsupdate-crt-key) ## `heroku certs` @@ -27,37 +27,33 @@ list SSL certificates for an app USAGE $ heroku certs -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + list SSL certificates for an app ``` -_See code: [commands/certs/index.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/index.js)_ +_See code: [commands/certs/index.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/index.js)_ -## `heroku certs:add CRT KEY` +## `heroku certs:add [CRT] [KEY]` add an SSL certificate to an app ``` USAGE - $ heroku certs:add CRT KEY + $ heroku certs:add [CRT] [KEY] [--0] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --bypass bypass the trust chain completion step +FLAGS + --0 bypass the trust chain completion step DESCRIPTION - Note: certificates with PEM encoding are also valid + add an SSL certificate to an app EXAMPLES $ heroku certs:add example.com.crt example.com.key - If you require intermediate certificates, refer to this article on merging certificates to get a complete chain: https://help.salesforce.com/s/articleView?id=000333504&type=1 ``` -_See code: [commands/certs/add.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/add.js)_ +_See code: [commands/certs/add.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/add.js)_ ## `heroku certs:auto` @@ -65,15 +61,16 @@ show ACM status for an app ``` USAGE - $ heroku certs:auto + $ heroku certs:auto [--0] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --wait watch ACM status and display the status when complete +FLAGS + --0 watch ACM status and display the status when complete + +DESCRIPTION + show ACM status for an app ``` -_See code: [commands/certs/auto/index.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/index.js)_ +_See code: [commands/certs/auto/index.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/auto/index.js)_ ## `heroku certs:auto:disable` @@ -83,12 +80,11 @@ disable ACM for an app USAGE $ heroku certs:auto:disable -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + disable ACM for an app ``` -_See code: [commands/certs/auto/disable.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/disable.js)_ +_See code: [commands/certs/auto/disable.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/auto/disable.js)_ ## `heroku certs:auto:enable` @@ -96,15 +92,16 @@ enable ACM status for an app ``` USAGE - $ heroku certs:auto:enable + $ heroku certs:auto:enable [--0] + +FLAGS + --0 watch ACM status and exit when complete -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --wait watch ACM status and exit when complete +DESCRIPTION + enable ACM status for an app ``` -_See code: [commands/certs/auto/enable.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/enable.js)_ +_See code: [commands/certs/auto/enable.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/auto/enable.js)_ ## `heroku certs:auto:refresh` @@ -114,12 +111,11 @@ refresh ACM for an app USAGE $ heroku certs:auto:refresh -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + refresh ACM for an app ``` -_See code: [commands/certs/auto/refresh.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/auto/refresh.js)_ +_See code: [commands/certs/auto/refresh.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/auto/refresh.js)_ ## `heroku certs:chain` @@ -129,44 +125,38 @@ print an ordered & complete chain for a certificate USAGE $ heroku certs:chain -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + print an ordered & complete chain for a certificate ``` -_See code: [commands/certs/chain.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/chain.js)_ +_See code: [commands/certs/chain.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/chain.js)_ -## `heroku certs:generate DOMAIN` +## `heroku certs:generate [DOMAIN]` generate a key and a CSR or self-signed certificate ``` USAGE - $ heroku certs:generate DOMAIN - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --area=area sub-country area (state, province, etc.) of owner - --city=city city of owner - --country=country country of owner, as a two-letter ISO country code - --keysize=keysize RSA key size in bits (default: 2048) - --now do not prompt for any owner information - --owner=owner name of organization certificate belongs to - --selfsigned generate a self-signed certificate instead of a CSR - --subject=subject specify entire certificate subject + $ heroku certs:generate [DOMAIN] [--0] [--1] [--2] [--3] [--4] [--5] [--6] [--7] + +FLAGS + --0 generate a self-signed certificate instead of a CSR + --1 RSA key size in bits (default: 2048) + --2 name of organization certificate belongs to + --3 country of owner, as a two-letter ISO country code + --4 sub-country area (state, province, etc.) of owner + --5 city of owner + --6 specify entire certificate subject + --7 do not prompt for any owner information DESCRIPTION - Generate a key and certificate signing request (or self-signed certificate) - for an app. Prompts for information to put in the certificate unless --now - is used, or at least one of the --subject, --owner, --country, --area, or - --city options is specified. + generate a key and a CSR or self-signed certificate EXAMPLES $ heroku certs:generate example.com ``` -_See code: [commands/certs/generate.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/generate.js)_ +_See code: [commands/certs/generate.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/generate.js)_ ## `heroku certs:info` @@ -174,17 +164,18 @@ show certificate information for an SSL certificate ``` USAGE - $ heroku certs:info + $ heroku certs:info [--0] [--1] [--2] + +FLAGS + --0 name to check info on + --1 endpoint to check info on + --2 show associated domains -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --endpoint=endpoint endpoint to check info on - --name=name name to check info on - --show-domains show associated domains +DESCRIPTION + show certificate information for an SSL certificate ``` -_See code: [commands/certs/info.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/info.js)_ +_See code: [commands/certs/info.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/info.js)_ ## `heroku certs:key` @@ -194,19 +185,14 @@ print the correct key for the given certificate USAGE $ heroku certs:key -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - DESCRIPTION - You must pass one single certificate, and one or more keys. - The first key that signs the certificate will be printed back. + print the correct key for the given certificate EXAMPLES $ heroku certs:key example.com.crt example.com.key ``` -_See code: [commands/certs/key.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/key.js)_ +_See code: [commands/certs/key.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/key.js)_ ## `heroku certs:remove` @@ -214,41 +200,39 @@ remove an SSL certificate from an app ``` USAGE - $ heroku certs:remove + $ heroku certs:remove [--1] [--2] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --endpoint=endpoint endpoint to remove - --name=name name to remove +FLAGS + --1 name to remove + --2 endpoint to remove + +DESCRIPTION + remove an SSL certificate from an app ``` -_See code: [commands/certs/remove.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/remove.js)_ +_See code: [commands/certs/remove.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/remove.js)_ -## `heroku certs:update CRT KEY` +## `heroku certs:update [CRT] [KEY]` update an SSL certificate on an app ``` USAGE - $ heroku certs:update CRT KEY + $ heroku certs:update [CRT] [KEY] [--0] [--2] [--3] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --bypass bypass the trust chain completion step - --endpoint=endpoint endpoint to update - --name=name name to update +FLAGS + --0 bypass the trust chain completion step + --2 name to update + --3 endpoint to update DESCRIPTION - Note: certificates with PEM encoding are also valid + update an SSL certificate on an app EXAMPLES $ heroku certs:update example.com.crt example.com.key - If you require intermediate certificates, refer to this article on merging certificates to get a complete chain: https://help.salesforce.com/s/articleView?id=000333504&type=1 ``` -_See code: [commands/certs/update.js](https://github.com/heroku/cli/blob/v7.68.0/packages/certs-v5/commands/certs/update.js)_ +_See code: [commands/certs/update.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/certs-v5/commands/certs/update.js)_ diff --git a/packages/certs-v5/package.json b/packages/certs-v5/package.json index c4d600ce0e..63fe389d6b 100644 --- a/packages/certs-v5/package.json +++ b/packages/certs-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-certs-v5", "description": "heroku ssl plugin", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Ransom Briggs rbriggs@heroku.com", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/certs/CHANGELOG.md b/packages/certs/CHANGELOG.md index 01e9ddbd49..0b0769bbcd 100644 --- a/packages/certs/CHANGELOG.md +++ b/packages/certs/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/certs/README.md b/packages/certs/README.md index b82a3d5e3e..e955edd4d5 100644 --- a/packages/certs/README.md +++ b/packages/certs/README.md @@ -19,8 +19,8 @@ $ npm install -g @heroku-cli/plugin-certs $ oclif-example COMMAND running command... -$ oclif-example (-v|--version|version) -@heroku-cli/plugin-certs/7.68.0 darwin-x64 node-v16.19.0 +$ oclif-example (--version|-v) +@heroku-cli/plugin-certs/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ oclif-example --help [COMMAND] USAGE $ oclif-example COMMAND diff --git a/packages/certs/package.json b/packages/certs/package.json index 6d83ab76e4..f04e342416 100644 --- a/packages/certs/package.json +++ b/packages/certs/package.json @@ -1,6 +1,6 @@ { "name": "@heroku-cli/plugin-certs", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey @jdxcode", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/ci-v5/CHANGELOG.md b/packages/ci-v5/CHANGELOG.md index dc500049e3..c835ab261c 100644 --- a/packages/ci-v5/CHANGELOG.md +++ b/packages/ci-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/ci-v5/package.json b/packages/ci-v5/package.json index 1092dd1d29..938f92c337 100644 --- a/packages/ci-v5/package.json +++ b/packages/ci-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-ci-v5", "description": "Heroku CLI plugin for Heroku CI", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Andrew Appleton, Gudmundur Bjarni Olafsson, Max Beizer, Ransom Briggs", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { @@ -14,7 +14,7 @@ }, "dependencies": { "@heroku-cli/command": "^9.0.2", - "@heroku-cli/plugin-run-v5": "^7.68.0", + "@heroku-cli/plugin-run-v5": "^8.0.2-beta.0", "ansi-escapes": "3.2.0", "bluebird": "^3.5.3", "github-url-to-object": "^4.0.4", diff --git a/packages/ci/CHANGELOG.md b/packages/ci/CHANGELOG.md index bf2b4663ac..c8bdb49215 100644 --- a/packages/ci/CHANGELOG.md +++ b/packages/ci/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/ci/README.md b/packages/ci/README.md index c301b945da..a1ac2e9579 100644 --- a/packages/ci/README.md +++ b/packages/ci/README.md @@ -22,8 +22,8 @@ Heroku CLI plugin for Heroku CI $ npm install -g @heroku-cli/plugin-ci $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-ci/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-ci/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -44,19 +44,22 @@ display the most recent CI runs for the given pipeline ``` USAGE - $ heroku ci + $ heroku ci [-a ] [--watch] [-p ] [--json] -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline - --json output in json format - --watch keep running and watch for new and update tests +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline + --json output in json format + --watch keep running and watch for new and update tests -EXAMPLE +DESCRIPTION + display the most recent CI runs for the given pipeline + +EXAMPLES $ heroku ci --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/index.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/index.ts)_ +_See code: [src/commands/ci/index.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/ci/src/commands/ci/index.ts)_ ## `heroku ci:info TEST-RUN` @@ -64,18 +67,21 @@ show the status of a specific test run ``` USAGE - $ heroku ci:info TEST-RUN + $ heroku ci:info TEST-RUN [-a ] [--node ] [-p ] + +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline + --node= the node number to show its setup and output -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline - --node=node the node number to show its setup and output +DESCRIPTION + show the status of a specific test run -EXAMPLE +EXAMPLES $ heroku ci:info 1288 --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/info.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/info.ts)_ +_See code: [src/commands/ci/info.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/ci/src/commands/ci/info.ts)_ ## `heroku ci:last` @@ -83,18 +89,21 @@ looks for the most recent run and returns the output of that run ``` USAGE - $ heroku ci:last + $ heroku ci:last [-a ] [--node ] [-p ] + +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline + --node= the node number to show its setup and output -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline - --node=node the node number to show its setup and output +DESCRIPTION + looks for the most recent run and returns the output of that run -EXAMPLE +EXAMPLES $ heroku ci:last --pipeline=my-pipeline --node 100 ``` -_See code: [src/commands/ci/last.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/last.ts)_ +_See code: [src/commands/ci/last.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/ci/src/commands/ci/last.ts)_ ## `heroku ci:rerun [NUMBER]` @@ -102,17 +111,20 @@ rerun tests against current directory ``` USAGE - $ heroku ci:rerun [NUMBER] + $ heroku ci:rerun [NUMBER] [-a ] [-p ] -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline -EXAMPLE +DESCRIPTION + rerun tests against current directory + +EXAMPLES $ heroku ci:rerun 985 --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/rerun.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/rerun.ts)_ +_See code: [src/commands/ci/rerun.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/ci/src/commands/ci/rerun.ts)_ ## `heroku ci:run` @@ -120,17 +132,20 @@ run tests against current directory ``` USAGE - $ heroku ci:run + $ heroku ci:run [-a ] [-p ] + +FLAGS + -a, --app= app name + -p, --pipeline= name of pipeline -OPTIONS - -a, --app=app app name - -p, --pipeline=pipeline name of pipeline +DESCRIPTION + run tests against current directory -EXAMPLE +EXAMPLES $ heroku ci:run --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/run.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ci/src/commands/ci/run.ts)_ +_See code: [src/commands/ci/run.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/ci/src/commands/ci/run.ts)_ * [`heroku ci:info`](#heroku-ci-info) * [`heroku ci:last`](#heroku-ci-last) diff --git a/packages/ci/package.json b/packages/ci/package.json index 08a4662a5b..f51418cee2 100644 --- a/packages/ci/package.json +++ b/packages/ci/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-ci", "description": "Heroku CLI plugin for Heroku CI", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Raúl Barroso @raulb", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 8277262cde..a2a71b15f5 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + ## [7.69.1](https://github.com/heroku/cli/compare/v7.69.0...v7.69.1) (2023-03-09) **Note:** Version bump only for package heroku diff --git a/packages/cli/README.md b/packages/cli/README.md index 09d9b3a89b..382c830eab 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -36,43 +36,30 @@ For other issues, [submit a support ticket](https://help.heroku.com/). * [`heroku access`](docs/access.md) - manage user access to apps * [`heroku addons`](docs/addons.md) - tools and services for developing, extending, and operating your app * [`heroku apps`](docs/apps.md) - manage apps on Heroku -* [`heroku auth`](docs/auth.md) - check 2fa status * [`heroku authorizations`](docs/authorizations.md) - OAuth authorizations -* [`heroku autocomplete`](docs/autocomplete.md) - display autocomplete installation instructions -* [`heroku buildpacks`](docs/buildpacks.md) - scripts used to compile apps * [`heroku certs`](docs/certs.md) - a topic for the ssl plugin * [`heroku ci`](docs/ci.md) - run an application test suite on Heroku * [`heroku clients`](docs/clients.md) - OAuth clients on the platform * [`heroku config`](docs/config.md) - environment variables of apps * [`heroku container`](docs/container.md) - Use containers to build and deploy Heroku apps -* [`heroku domains`](docs/domains.md) - custom domains for apps * [`heroku drains`](docs/drains.md) - forward logs to syslog or HTTPS * [`heroku features`](docs/features.md) - add/remove app features -* [`heroku git`](docs/git.md) - manage local git repository for app -* [`heroku help`](docs/help.md) - display help for heroku +* [`heroku help`](docs/help.md) - Display help for heroku. * [`heroku keys`](docs/keys.md) - add/remove account ssh keys * [`heroku labs`](docs/labs.md) - add/remove experimental features * [`heroku local`](docs/local.md) - run Heroku app locally -* [`heroku logs`](docs/logs.md) - display recent log output * [`heroku maintenance`](docs/maintenance.md) - enable/disable access to app * [`heroku members`](docs/members.md) - manage organization members -* [`heroku notifications`](docs/notifications.md) - display notifications * [`heroku orgs`](docs/orgs.md) - manage organizations * [`heroku pg`](docs/pg.md) - manage postgresql databases -* [`heroku pipelines`](docs/pipelines.md) - manage pipelines -* [`heroku plugins`](docs/plugins.md) - list installed plugins +* [`heroku plugins`](docs/plugins.md) - List installed plugins. * [`heroku ps`](docs/ps.md) - Client tools for Heroku Exec -* [`heroku psql`](docs/psql.md) - open a psql shell to the database * [`heroku redis`](docs/redis.md) - manage heroku redis instances -* [`heroku regions`](docs/regions.md) - list available regions for deployment -* [`heroku releases`](docs/releases.md) - display the releases for an app -* [`heroku reviewapps`](docs/reviewapps.md) - manage reviewapps in pipelines -* [`heroku run`](docs/run.md) - run a one-off process inside a Heroku dyno * [`heroku sessions`](docs/sessions.md) - OAuth sessions * [`heroku spaces`](docs/spaces.md) - manage heroku private spaces -* [`heroku status`](docs/status.md) - status of the Heroku platform * [`heroku teams`](docs/teams.md) - manage teams * [`heroku update`](docs/update.md) - update the Heroku CLI +* [`heroku version`](docs/version.md) * [`heroku webhooks`](docs/webhooks.md) - list webhooks on an app diff --git a/packages/cli/package.json b/packages/cli/package.json index 7785f0c46d..79142ccfe8 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,38 +1,38 @@ { "name": "heroku", "description": "CLI to interact with Heroku", - "version": "7.69.1", + "version": "8.0.2-beta.0", "author": "Jeff Dickey @jdxcode", "bin": "./bin/run", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { "@heroku-cli/color": "1.1.14", "@heroku-cli/command": "^9.0.2", - "@heroku-cli/plugin-addons-v5": "^7.68.0", - "@heroku-cli/plugin-apps": "^7.68.0", - "@heroku-cli/plugin-apps-v5": "^7.68.1", - "@heroku-cli/plugin-auth": "^7.68.0", - "@heroku-cli/plugin-autocomplete": "^7.68.0", - "@heroku-cli/plugin-buildpacks": "^7.68.0", - "@heroku-cli/plugin-certs": "^7.68.0", - "@heroku-cli/plugin-certs-v5": "^7.68.0", - "@heroku-cli/plugin-ci": "^7.68.0", - "@heroku-cli/plugin-ci-v5": "^7.68.0", - "@heroku-cli/plugin-config": "^7.68.0", - "@heroku-cli/plugin-container-registry-v5": "^7.68.0", - "@heroku-cli/plugin-git": "^7.68.0", - "@heroku-cli/plugin-local": "^7.69.0", - "@heroku-cli/plugin-oauth-v5": "^7.68.0", - "@heroku-cli/plugin-orgs-v5": "^7.68.0", - "@heroku-cli/plugin-pg-v5": "^7.68.0", - "@heroku-cli/plugin-pipelines": "^7.68.0", - "@heroku-cli/plugin-ps": "^7.68.0", + "@heroku-cli/plugin-addons-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-apps": "^8.0.2-beta.0", + "@heroku-cli/plugin-apps-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-auth": "^8.0.2-beta.0", + "@heroku-cli/plugin-autocomplete": "^8.0.2-beta.0", + "@heroku-cli/plugin-buildpacks": "^8.0.2-beta.0", + "@heroku-cli/plugin-certs": "^8.0.2-beta.0", + "@heroku-cli/plugin-certs-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-ci": "^8.0.2-beta.0", + "@heroku-cli/plugin-ci-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-config": "^8.0.2-beta.0", + "@heroku-cli/plugin-container-registry-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-git": "^8.0.2-beta.0", + "@heroku-cli/plugin-local": "^8.0.2-beta.0", + "@heroku-cli/plugin-oauth-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-orgs-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-pg-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-pipelines": "^8.0.2-beta.0", + "@heroku-cli/plugin-ps": "^8.0.2-beta.0", "@heroku-cli/plugin-ps-exec": "^2.4.0", - "@heroku-cli/plugin-redis-v5": "^7.68.3", - "@heroku-cli/plugin-run": "^7.68.0", - "@heroku-cli/plugin-spaces": "^7.68.0", - "@heroku-cli/plugin-status": "^7.68.0", - "@heroku-cli/plugin-webhooks": "^7.68.0", + "@heroku-cli/plugin-redis-v5": "^8.0.2-beta.0", + "@heroku-cli/plugin-run": "^8.0.2-beta.0", + "@heroku-cli/plugin-spaces": "^8.0.2-beta.0", + "@heroku-cli/plugin-status": "^8.0.2-beta.0", + "@heroku-cli/plugin-webhooks": "^8.0.2-beta.0", "@oclif/core": "^1.26.2", "@oclif/plugin-commands": "2.2.2", "@oclif/plugin-help": "^5", diff --git a/packages/config/CHANGELOG.md b/packages/config/CHANGELOG.md index dd264bbd42..3ca4a91fd5 100644 --- a/packages/config/CHANGELOG.md +++ b/packages/config/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/config/README.md b/packages/config/README.md index a677d860bc..6eb0bc75c5 100644 --- a/packages/config/README.md +++ b/packages/config/README.md @@ -19,8 +19,8 @@ $ npm install -g @heroku-cli/plugin-config $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-config/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-config/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -29,101 +29,5 @@ USAGE # Commands -* [`heroku config`](#heroku-config) -* [`heroku config:edit [KEY]`](#heroku-configedit-key) -* [`heroku config:get KEY...`](#heroku-configget-key) -* [`heroku config:unset`](#heroku-configunset) -## `heroku config` - -display the config vars for an app - -``` -USAGE - $ heroku config - -OPTIONS - -a, --app=app (required) app to run command against - -j, --json output config vars in json format - -r, --remote=remote git remote of app to use - -s, --shell output config vars in shell format -``` - -_See code: [src/commands/config/index.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/index.ts)_ - -## `heroku config:edit [KEY]` - -interactively edit config vars - -``` -USAGE - $ heroku config:edit [KEY] - -ARGUMENTS - KEY edit a single key - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -DESCRIPTION - This command opens the app config in a text editor set by $VISUAL or $EDITOR. - Any variables added/removed/changed will be updated on the app after saving and closing the file. - -EXAMPLES - # edit with vim - $ EDITOR="vim" heroku config:edit - # edit with emacs - $ EDITOR="emacs" heroku config:edit - # edit with pico - $ EDITOR="pico" heroku config:edit - # edit with atom editor - $ VISUAL="atom --wait" heroku config:edit -``` - -_See code: [src/commands/config/edit.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/edit.ts)_ - -## `heroku config:get KEY...` - -display a single config value for an app - -``` -USAGE - $ heroku config:get KEY... - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --shell output config vars in shell format - -EXAMPLES - $ heroku config:get RAILS_ENV - production -``` - -_See code: [src/commands/config/get.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/get.ts)_ - -## `heroku config:unset` - -unset one or more config vars - -``` -USAGE - $ heroku config:unset - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -ALIASES - $ heroku config:remove - -EXAMPLES - $ heroku config:unset RAILS_ENV - Unsetting RAILS_ENV and restarting example... done, v10 - $ heroku config:unset RAILS_ENV RACK_ENV - Unsetting RAILS_ENV, RACK_ENV and restarting example... done, v10 -``` - -_See code: [src/commands/config/unset.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/config/src/commands/config/unset.ts)_ diff --git a/packages/config/package.json b/packages/config/package.json index afd49f9e62..7e96a6097d 100644 --- a/packages/config/package.json +++ b/packages/config/package.json @@ -1,6 +1,6 @@ { "name": "@heroku-cli/plugin-config", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey @jdxcode", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/container-registry-v5/CHANGELOG.md b/packages/container-registry-v5/CHANGELOG.md index 5b62544a40..bd5711bfae 100644 --- a/packages/container-registry-v5/CHANGELOG.md +++ b/packages/container-registry-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/container-registry-v5/package.json b/packages/container-registry-v5/package.json index e7cc4eddc1..63ba8de115 100644 --- a/packages/container-registry-v5/package.json +++ b/packages/container-registry-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-container-registry-v5", "description": "Use containers to build and deploy Heroku apps", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Heroku", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/git/CHANGELOG.md b/packages/git/CHANGELOG.md index b94218e123..50dbdc5cfb 100644 --- a/packages/git/CHANGELOG.md +++ b/packages/git/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/git/README.md b/packages/git/README.md index bc0c190505..9a05142903 100644 --- a/packages/git/README.md +++ b/packages/git/README.md @@ -19,8 +19,8 @@ Heroku CLI plugin to manage local git repos. $ npm install -g @heroku-cli/plugin-git $ oclif-example COMMAND running command... -$ oclif-example (-v|--version|version) -@heroku-cli/plugin-git/7.68.0 darwin-x64 node-v16.19.0 +$ oclif-example (--version|-v) +@heroku-cli/plugin-git/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ oclif-example --help [COMMAND] USAGE $ oclif-example COMMAND @@ -29,55 +29,5 @@ USAGE # Commands -* [`oclif-example git:clone [DIRECTORY]`](#oclif-example-gitclone-directory) -* [`oclif-example git:remote`](#oclif-example-gitremote) -## `oclif-example git:clone [DIRECTORY]` - -clones a heroku app to your local machine at DIRECTORY (defaults to app name) - -``` -USAGE - $ oclif-example git:clone [DIRECTORY] - -ARGUMENTS - DIRECTORY where to clone the app - -OPTIONS - -a, --app=app (required) the Heroku app to use - -r, --remote=remote the git remote to create, default "heroku" - -EXAMPLES - $ heroku git:clone -a example - Cloning into 'example'... - remote: Counting objects: 42, done. - ... -``` - -_See code: [src/commands/git/clone.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/git/src/commands/git/clone.ts)_ - -## `oclif-example git:remote` - -adds a git remote to an app repo - -``` -USAGE - $ oclif-example git:remote - -OPTIONS - -a, --app=app the Heroku app to use - -r, --remote=remote the git remote to create - -DESCRIPTION - extra arguments will be passed to git remote add - -EXAMPLES - # set git remote heroku to https://git.heroku.com/example.git - $ heroku git:remote -a example - - # set git remote heroku-staging to https://git.heroku.com/example.git - $ heroku git:remote --remote heroku-staging -a example -``` - -_See code: [src/commands/git/remote.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/git/src/commands/git/remote.ts)_ diff --git a/packages/git/package.json b/packages/git/package.json index 3cd812e533..a680817fbc 100644 --- a/packages/git/package.json +++ b/packages/git/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-git", "description": "Heroku CLI plugin to manage local git repos.", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey (@jdxcode)", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/local/CHANGELOG.md b/packages/local/CHANGELOG.md index 8c3c5c6b6d..40d33a4bdb 100644 --- a/packages/local/CHANGELOG.md +++ b/packages/local/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.69.0](https://github.com/heroku/cli/compare/v7.68.3...v7.69.0) (2023-03-07) diff --git a/packages/local/README.md b/packages/local/README.md index 5c4963b566..c7d149cb44 100644 --- a/packages/local/README.md +++ b/packages/local/README.md @@ -20,8 +20,8 @@ local $ npm install -g @heroku-cli/plugin-local $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-local/7.69.0 darwin-arm64 node-v16.16.0 +$ heroku (--version|-v) +@heroku-cli/plugin-local/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -32,6 +32,7 @@ USAGE * [`heroku local [PROCESSNAME]`](#heroku-local-processname) * [`heroku local:run`](#heroku-localrun) +* [`heroku local:start [PROCESSNAME]`](#heroku-localstart-processname) * [`heroku local:version`](#heroku-localversion) ## `heroku local [PROCESSNAME]` @@ -40,27 +41,28 @@ run heroku app locally ``` USAGE - $ heroku local [PROCESSNAME] + $ heroku local [PROCESSNAME] [-f ] [-e ] [-p ] -OPTIONS - -e, --env=env location of env file (defaults to .env) - -f, --procfile=procfile use a different Procfile - -p, --port=port port to listen on +FLAGS + -e, --env= location of env file (defaults to .env) + -f, --procfile= use a different Procfile + -p, --port= port to listen on DESCRIPTION + run heroku app locally Start the application specified by a Procfile (defaults to ./Procfile) ALIASES $ heroku local:start -EXAMPLE +EXAMPLES $ heroku local $ heroku local web $ heroku local web=2 $ heroku local web=1,worker=2 ``` -_See code: [src/commands/local/index.ts](https://github.com/heroku/cli/blob/v7.69.0/src/commands/local/index.ts)_ +_See code: [src/commands/local/index.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/local/index.ts)_ ## `heroku local:run` @@ -68,17 +70,47 @@ run a one-off command ``` USAGE - $ heroku local:run + $ heroku local:run [-e ] [-p ] -OPTIONS - -e, --env=env - -p, --port=port [default: 5001] +FLAGS + -e, --env= + -p, --port= [default: 5001] -EXAMPLE +DESCRIPTION + run a one-off command + +EXAMPLES $ heroku local:run bin/migrate ``` -_See code: [src/commands/local/run.ts](https://github.com/heroku/cli/blob/v7.69.0/src/commands/local/run.ts)_ +_See code: [src/commands/local/run.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/local/run.ts)_ + +## `heroku local:start [PROCESSNAME]` + +run heroku app locally + +``` +USAGE + $ heroku local:start [PROCESSNAME] [-f ] [-e ] [-p ] + +FLAGS + -e, --env= location of env file (defaults to .env) + -f, --procfile= use a different Procfile + -p, --port= port to listen on + +DESCRIPTION + run heroku app locally + Start the application specified by a Procfile (defaults to ./Procfile) + +ALIASES + $ heroku local:start + +EXAMPLES + $ heroku local + $ heroku local web + $ heroku local web=2 + $ heroku local web=1,worker=2 +``` ## `heroku local:version` @@ -87,7 +119,10 @@ display node-foreman version ``` USAGE $ heroku local:version + +DESCRIPTION + display node-foreman version ``` -_See code: [src/commands/local/version.ts](https://github.com/heroku/cli/blob/v7.69.0/src/commands/local/version.ts)_ +_See code: [src/commands/local/version.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/local/version.ts)_ diff --git a/packages/local/package.json b/packages/local/package.json index 50e9b1cf9a..b8b00173b9 100644 --- a/packages/local/package.json +++ b/packages/local/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-local", "description": "run heroku apps locally", - "version": "7.69.0", + "version": "8.0.2-beta.0", "author": "Chad Carbert @chadian", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/oauth-v5/CHANGELOG.md b/packages/oauth-v5/CHANGELOG.md index 3fe5ba79e4..3c25adad7a 100644 --- a/packages/oauth-v5/CHANGELOG.md +++ b/packages/oauth-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/oauth-v5/README.md b/packages/oauth-v5/README.md index 099f6f74be..f945b22a84 100644 --- a/packages/oauth-v5/README.md +++ b/packages/oauth-v5/README.md @@ -123,18 +123,19 @@ Revoked authorization from "Another App". * [`heroku authorizations`](#heroku-authorizations) * [`heroku authorizations:create`](#heroku-authorizationscreate) -* [`heroku authorizations:info ID`](#heroku-authorizationsinfo-id) -* [`heroku authorizations:revoke ID`](#heroku-authorizationsrevoke-id) -* [`heroku authorizations:rotate ID`](#heroku-authorizationsrotate-id) -* [`heroku authorizations:update ID`](#heroku-authorizationsupdate-id) +* [`heroku authorizations:destroy [ID]`](#heroku-authorizationsdestroy-id) +* [`heroku authorizations:info [ID]`](#heroku-authorizationsinfo-id) +* [`heroku authorizations:revoke [ID]`](#heroku-authorizationsrevoke-id) +* [`heroku authorizations:rotate [ID]`](#heroku-authorizationsrotate-id) +* [`heroku authorizations:update [ID]`](#heroku-authorizationsupdate-id) * [`heroku clients`](#heroku-clients) -* [`heroku clients:create NAME REDIRECT_URI`](#heroku-clientscreate-name-redirect_uri) -* [`heroku clients:destroy ID`](#heroku-clientsdestroy-id) -* [`heroku clients:info ID`](#heroku-clientsinfo-id) -* [`heroku clients:rotate ID`](#heroku-clientsrotate-id) -* [`heroku clients:update ID`](#heroku-clientsupdate-id) +* [`heroku clients:create [NAME] [REDIRECT_URI]`](#heroku-clientscreate-name-redirect_uri) +* [`heroku clients:destroy [ID]`](#heroku-clientsdestroy-id) +* [`heroku clients:info [ID]`](#heroku-clientsinfo-id) +* [`heroku clients:rotate [ID]`](#heroku-clientsrotate-id) +* [`heroku clients:update [ID]`](#heroku-clientsupdate-id) * [`heroku sessions`](#heroku-sessions) -* [`heroku sessions:destroy ID`](#heroku-sessionsdestroy-id) +* [`heroku sessions:destroy [ID]`](#heroku-sessionsdestroy-id) ## `heroku authorizations` @@ -142,13 +143,16 @@ list OAuth authorizations ``` USAGE - $ heroku authorizations + $ heroku authorizations [-j] -OPTIONS - -j, --json output in json format +FLAGS + -j, --0 output in json format + +DESCRIPTION + list OAuth authorizations ``` -_See code: [lib/commands/authorizations/index.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/index.js)_ +_See code: [lib/commands/authorizations/index.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/authorizations/index.js)_ ## `heroku authorizations:create` @@ -156,75 +160,104 @@ create a new OAuth authorization ``` USAGE - $ heroku authorizations:create + $ heroku authorizations:create [-d] [-s] [-e] [-S] [-j] -OPTIONS - -S, --short only output token - -d, --description=description set a custom authorization description - -e, --expires-in=expires-in set expiration in seconds (default no expiration) - -j, --json output in json format - -s, --scope=scope set custom OAuth scopes +FLAGS + -S, --3 only output token + -d, --0 set a custom authorization description + -e, --2 set expiration in seconds (default no expiration) + -j, --4 output in json format + -s, --1 set custom OAuth scopes DESCRIPTION - This creates an authorization with access to your Heroku account. + create a new OAuth authorization ``` -_See code: [lib/commands/authorizations/create.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/create.js)_ +_See code: [lib/commands/authorizations/create.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/authorizations/create.js)_ + +## `heroku authorizations:destroy [ID]` + +revoke OAuth authorization + +``` +USAGE + $ heroku authorizations:destroy [ID] -## `heroku authorizations:info ID` +DESCRIPTION + revoke OAuth authorization + +ALIASES + $ heroku authorizations:destroy + $ heroku authorizations:revoke +``` + +## `heroku authorizations:info [ID]` show an existing OAuth authorization ``` USAGE - $ heroku authorizations:info ID + $ heroku authorizations:info [ID] [-j] + +FLAGS + -j, --0 output in json format -OPTIONS - -j, --json output in json format +DESCRIPTION + show an existing OAuth authorization ``` -_See code: [lib/commands/authorizations/info.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/info.js)_ +_See code: [lib/commands/authorizations/info.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/authorizations/info.js)_ -## `heroku authorizations:revoke ID` +## `heroku authorizations:revoke [ID]` revoke OAuth authorization ``` USAGE - $ heroku authorizations:revoke ID + $ heroku authorizations:revoke [ID] + +DESCRIPTION + revoke OAuth authorization ALIASES $ heroku authorizations:destroy + $ heroku authorizations:revoke ``` -_See code: [lib/commands/authorizations/revoke.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/revoke.js)_ +_See code: [lib/commands/authorizations/revoke.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/authorizations/revoke.js)_ -## `heroku authorizations:rotate ID` +## `heroku authorizations:rotate [ID]` updates an OAuth authorization token ``` USAGE - $ heroku authorizations:rotate ID + $ heroku authorizations:rotate [ID] + +DESCRIPTION + updates an OAuth authorization token ``` -_See code: [lib/commands/authorizations/rotate.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/rotate.js)_ +_See code: [lib/commands/authorizations/rotate.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/authorizations/rotate.js)_ -## `heroku authorizations:update ID` +## `heroku authorizations:update [ID]` updates an OAuth authorization ``` USAGE - $ heroku authorizations:update ID + $ heroku authorizations:update [ID] [-d] [--1] [--2] + +FLAGS + -d, --0 set a custom authorization description + --1 identifier of OAuth client to set + --2 secret of OAuth client to set -OPTIONS - -d, --description=description set a custom authorization description - --client-id=client-id identifier of OAuth client to set - --client-secret=client-secret secret of OAuth client to set +DESCRIPTION + updates an OAuth authorization ``` -_See code: [lib/commands/authorizations/update.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/authorizations/update.js)_ +_See code: [lib/commands/authorizations/update.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/authorizations/update.js)_ ## `heroku clients` @@ -232,84 +265,102 @@ list your OAuth clients ``` USAGE - $ heroku clients + $ heroku clients [-j] -OPTIONS - -j, --json output in json format +FLAGS + -j, --0 output in json format + +DESCRIPTION + list your OAuth clients ``` -_See code: [lib/commands/clients/index.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/index.js)_ +_See code: [lib/commands/clients/index.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/clients/index.js)_ -## `heroku clients:create NAME REDIRECT_URI` +## `heroku clients:create [NAME] [REDIRECT_URI]` create a new OAuth client ``` USAGE - $ heroku clients:create NAME REDIRECT_URI + $ heroku clients:create [NAME] [REDIRECT_URI] [-s] [-j] -OPTIONS - -j, --json output in json format - -s, --shell output in shell format +FLAGS + -j, --1 output in json format + -s, --0 output in shell format + +DESCRIPTION + create a new OAuth client ``` -_See code: [lib/commands/clients/create.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/create.js)_ +_See code: [lib/commands/clients/create.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/clients/create.js)_ -## `heroku clients:destroy ID` +## `heroku clients:destroy [ID]` delete client by ID ``` USAGE - $ heroku clients:destroy ID + $ heroku clients:destroy [ID] + +DESCRIPTION + delete client by ID ``` -_See code: [lib/commands/clients/destroy.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/destroy.js)_ +_See code: [lib/commands/clients/destroy.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/clients/destroy.js)_ -## `heroku clients:info ID` +## `heroku clients:info [ID]` show details of an oauth client ``` USAGE - $ heroku clients:info ID + $ heroku clients:info [ID] [-j] [-s] + +FLAGS + -j, --0 output in json format + -s, --1 output in shell format -OPTIONS - -j, --json output in json format - -s, --shell output in shell format +DESCRIPTION + show details of an oauth client ``` -_See code: [lib/commands/clients/info.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/info.js)_ +_See code: [lib/commands/clients/info.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/clients/info.js)_ -## `heroku clients:rotate ID` +## `heroku clients:rotate [ID]` rotate OAuth client secret ``` USAGE - $ heroku clients:rotate ID + $ heroku clients:rotate [ID] [-j] [-s] + +FLAGS + -j, --0 output in json format + -s, --1 output in shell format -OPTIONS - -j, --json output in json format - -s, --shell output in shell format +DESCRIPTION + rotate OAuth client secret ``` -_See code: [lib/commands/clients/rotate.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/rotate.js)_ +_See code: [lib/commands/clients/rotate.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/clients/rotate.js)_ -## `heroku clients:update ID` +## `heroku clients:update [ID]` update OAuth client ``` USAGE - $ heroku clients:update ID + $ heroku clients:update [ID] [-n] [--1] -OPTIONS - -n, --name=name change the client name - --url=url change the client redirect URL +FLAGS + -n, --0 change the client name + --1 change the client redirect URL + +DESCRIPTION + update OAuth client ``` -_See code: [lib/commands/clients/update.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/clients/update.js)_ +_See code: [lib/commands/clients/update.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/clients/update.js)_ ## `heroku sessions` @@ -317,22 +368,28 @@ list your OAuth sessions ``` USAGE - $ heroku sessions + $ heroku sessions [-j] -OPTIONS - -j, --json output in json format +FLAGS + -j, --0 output in json format + +DESCRIPTION + list your OAuth sessions ``` -_See code: [lib/commands/sessions/index.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/sessions/index.js)_ +_See code: [lib/commands/sessions/index.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/sessions/index.js)_ -## `heroku sessions:destroy ID` +## `heroku sessions:destroy [ID]` delete (logout) OAuth session by ID ``` USAGE - $ heroku sessions:destroy ID + $ heroku sessions:destroy [ID] + +DESCRIPTION + delete (logout) OAuth session by ID ``` -_See code: [lib/commands/sessions/destroy.js](https://github.com/heroku/cli/blob/v7.68.0/packages/oauth-v5/lib/commands/sessions/destroy.js)_ +_See code: [lib/commands/sessions/destroy.js](https://github.com/heroku/cli/blob/v8.0.2-beta.0/packages/oauth-v5/lib/commands/sessions/destroy.js)_ diff --git a/packages/oauth-v5/package.json b/packages/oauth-v5/package.json index 6328ee223e..840c9af707 100644 --- a/packages/oauth-v5/package.json +++ b/packages/oauth-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-oauth-v5", "description": "Heroku CLI plugin to manage OAuth clients.", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey (@dickeyxxx)", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/oauth/CHANGELOG.md b/packages/oauth/CHANGELOG.md index 56de3a4330..80ba3dc1ad 100644 --- a/packages/oauth/CHANGELOG.md +++ b/packages/oauth/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/oauth/README.md b/packages/oauth/README.md index 44fe48b16f..ae2d022fd0 100644 --- a/packages/oauth/README.md +++ b/packages/oauth/README.md @@ -18,8 +18,8 @@ Command line plugin for managing OAuth clients, authorizations and tokens. $ npm install -g @heroku-cli/plugin-oauth $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-oauth/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-oauth/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -28,249 +28,5 @@ USAGE # Commands -* [`heroku authorizations`](#heroku-authorizations) -* [`heroku authorizations:create`](#heroku-authorizationscreate) -* [`heroku authorizations:info ID`](#heroku-authorizationsinfo-id) -* [`heroku authorizations:revoke ID`](#heroku-authorizationsrevoke-id) -* [`heroku authorizations:rotate ID`](#heroku-authorizationsrotate-id) -* [`heroku authorizations:update ID`](#heroku-authorizationsupdate-id) -* [`heroku clients`](#heroku-clients) -* [`heroku clients:create NAME REDIRECT_URI`](#heroku-clientscreate-name-redirect_uri) -* [`heroku clients:destroy ID`](#heroku-clientsdestroy-id) -* [`heroku clients:info ID`](#heroku-clientsinfo-id) -* [`heroku clients:rotate ID`](#heroku-clientsrotate-id) -* [`heroku clients:update ID`](#heroku-clientsupdate-id) -* [`heroku help [COMMAND]`](#heroku-help-command) -* [`heroku sessions`](#heroku-sessions) -* [`heroku sessions:destroy ID`](#heroku-sessionsdestroy-id) -## `heroku authorizations` - -list OAuth authorizations - -``` -USAGE - $ heroku authorizations - -OPTIONS - -j, --json output in json format - -EXAMPLE - $ heroku authorizations -``` - -_See code: [src/commands/authorizations/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/authorizations/index.ts)_ - -## `heroku authorizations:create` - -create a new OAuth authorization - -``` -USAGE - $ heroku authorizations:create - -OPTIONS - -S, --short only output token - -d, --description=description set a custom authorization - -e, --expires-in=expires-in set expiration in seconds (default no expiration) - -j, --json output in json format - -s, --scope=scope set custom OAuth scopes - -EXAMPLE - $ heroku authorizations:create --description "For use with Anvil" -``` - -_See code: [src/commands/authorizations/create.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/authorizations/create.ts)_ - -## `heroku authorizations:info ID` - -show an existing OAuth authorization - -``` -USAGE - $ heroku authorizations:info ID - -OPTIONS - -j, --json output in json format -``` - -_See code: [src/commands/authorizations/info.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/authorizations/info.ts)_ - -## `heroku authorizations:revoke ID` - -revoke OAuth authorization - -``` -USAGE - $ heroku authorizations:revoke ID - -EXAMPLE - $ heroku authorizations:revoke 105a7bfa-34c3-476e-873a-b1ac3fdc12fb -``` - -_See code: [src/commands/authorizations/revoke.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/authorizations/revoke.ts)_ - -## `heroku authorizations:rotate ID` - -updates an OAuth authorization token - -``` -USAGE - $ heroku authorizations:rotate ID -``` - -_See code: [src/commands/authorizations/rotate.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/authorizations/rotate.ts)_ - -## `heroku authorizations:update ID` - -updates an OAuth authorization - -``` -USAGE - $ heroku authorizations:update ID - -OPTIONS - -d, --description=description set a custom authorization description - --client-id=client-id identifier of OAuth client to set - --client-secret=client-secret secret of OAuth client to set -``` - -_See code: [src/commands/authorizations/update.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/authorizations/update.ts)_ - -## `heroku clients` - -list your OAuth clients - -``` -USAGE - $ heroku clients - -OPTIONS - -j, --json output in json format -``` - -_See code: [src/commands/clients/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/clients/index.ts)_ - -## `heroku clients:create NAME REDIRECT_URI` - -create a new OAuth client - -``` -USAGE - $ heroku clients:create NAME REDIRECT_URI - -OPTIONS - -j, --json output in json format - -s, --shell output in shell format - -EXAMPLE - $ heroku clients:create "Amazing" https://amazing-client.herokuapp.com/auth/heroku/callback -``` - -_See code: [src/commands/clients/create.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/clients/create.ts)_ - -## `heroku clients:destroy ID` - -delete client by ID - -``` -USAGE - $ heroku clients:destroy ID -``` - -_See code: [src/commands/clients/destroy.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/clients/destroy.ts)_ - -## `heroku clients:info ID` - -show details of an oauth client - -``` -USAGE - $ heroku clients:info ID - -OPTIONS - -j, --json output in json format - -s, --shell output in shell format - -EXAMPLE - $ heroku clients:info 36120128-fee7-455e-8b7f-807aee130946 -``` - -_See code: [src/commands/clients/info.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/clients/info.ts)_ - -## `heroku clients:rotate ID` - -rotate OAuth client secret - -``` -USAGE - $ heroku clients:rotate ID - -OPTIONS - -j, --json output in json format - -s, --shell output in shell format -``` - -_See code: [src/commands/clients/rotate.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/clients/rotate.ts)_ - -## `heroku clients:update ID` - -update OAuth client - -``` -USAGE - $ heroku clients:update ID - -OPTIONS - -n, --name=name change the client name - --url=url change the client redirect URL - -EXAMPLE - $ heroku clients:update 3e304bda-d376-4278-bdea-6d6c08aa1359 --url - https://amazing-client.herokuapp.com/auth/heroku/callback -``` - -_See code: [src/commands/clients/update.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/clients/update.ts)_ - -## `heroku help [COMMAND]` - -display help for heroku - -``` -USAGE - $ heroku help [COMMAND] - -ARGUMENTS - COMMAND command to show help for - -OPTIONS - --all see all commands in CLI -``` - -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.0/src/commands/help.ts)_ - -## `heroku sessions` - -list your OAuth sessions - -``` -USAGE - $ heroku sessions - -OPTIONS - -j, --json output in json format -``` - -_See code: [src/commands/sessions/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/sessions/index.ts)_ - -## `heroku sessions:destroy ID` - -delete (logout) OAuth session by ID - -``` -USAGE - $ heroku sessions:destroy ID -``` - -_See code: [src/commands/sessions/destroy.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/sessions/destroy.ts)_ diff --git a/packages/oauth/package.json b/packages/oauth/package.json index c35de2204d..7ba4b2a6df 100644 --- a/packages/oauth/package.json +++ b/packages/oauth/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-oauth", "description": "Command line plugin for managing OAuth clients, authorizations and tokens.", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Taylor Mock @tmock12", "bin": { "heroku": "./bin/run" diff --git a/packages/orgs-v5/CHANGELOG.md b/packages/orgs-v5/CHANGELOG.md index a4956c4808..dcd600aa35 100644 --- a/packages/orgs-v5/CHANGELOG.md +++ b/packages/orgs-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/orgs-v5/README.md b/packages/orgs-v5/README.md index 1c54845dd4..f516e79b1f 100644 --- a/packages/orgs-v5/README.md +++ b/packages/orgs-v5/README.md @@ -60,12 +60,15 @@ list who has access to an app ``` USAGE - $ heroku access + $ heroku access -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json output in json format +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json output in json format + +DESCRIPTION + list who has access to an app ``` ## `heroku access:add EMAIL` @@ -74,15 +77,20 @@ add new users to your app ``` USAGE - $ heroku access:add EMAIL + $ heroku access:add EMAIL -a [-p ] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -p, --permissions= list of permissions comma separated + -r, --remote= git remote of app to use + +DESCRIPTION + add new users to your app -OPTIONS - -a, --app=app (required) app to run command against - -p, --permissions=permissions list of permissions comma separated - -r, --remote=remote git remote of app to use 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 ``` @@ -92,11 +100,15 @@ remove users from a team app ``` USAGE - $ heroku access:remove EMAIL + $ heroku access:remove EMAIL -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + remove users from a team app -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use EXAMPLES $ heroku access:remove user@email.com --app APP @@ -108,12 +120,16 @@ update existing collaborators on an team app ``` USAGE - $ heroku access:update EMAIL + $ heroku access:update EMAIL -a [-p ] [-r ] + +FLAGS + -a, --app= (required) app to run command against + -p, --permissions= comma-delimited list of permissions to update (deploy,manage,operate) + -r, --remote= git remote of app to use + +DESCRIPTION + update existing collaborators on an team app -OPTIONS - -a, --app=app (required) app to run command against - -p, --permissions=permissions comma-delimited list of permissions to update (deploy,manage,operate) - -r, --remote=remote git remote of app to use EXAMPLES $ heroku access:update user@email.com --app APP --permissions deploy,manage,operate @@ -125,11 +141,14 @@ add yourself to a team app ``` USAGE - $ heroku apps:join + $ heroku apps:join -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + add yourself to a team app ``` ## `heroku apps:leave` @@ -138,11 +157,14 @@ remove yourself from a team app ``` USAGE - $ heroku apps:leave + $ heroku apps:leave -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + remove yourself from a team app ``` ## `heroku apps:lock` @@ -151,11 +173,14 @@ prevent team members from joining an app ``` USAGE - $ heroku apps:lock + $ heroku apps:lock -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + prevent team members from joining an app ``` ## `heroku apps:transfer RECIPIENT` @@ -164,24 +189,26 @@ transfer applications to another user or team ``` USAGE - $ heroku apps:transfer RECIPIENT + $ heroku apps:transfer RECIPIENT [-l] [--bulk] [-a ] [-r ] ARGUMENTS RECIPIENT user or team to transfer applications to -OPTIONS - -a, --app=app app to run command against - -l, --locked lock the app upon transfer - -r, --remote=remote git remote of app to use - --bulk transfer applications in bulk +FLAGS + -a, --app= app to run command against + -l, --locked lock the app upon transfer + -r, --remote= git remote of app to use + --bulk transfer applications in bulk + +DESCRIPTION + transfer applications to another user or team + EXAMPLES $ heroku apps:transfer collaborator@example.com Transferring example to collaborator@example.com... done - $ heroku apps:transfer acme-widgets Transferring example to acme-widgets... done - $ heroku apps:transfer --bulk acme-widgets ... ``` @@ -192,11 +219,14 @@ unlock an app so any team member can join ``` USAGE - $ heroku apps:unlock + $ heroku apps:unlock -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + unlock an app so any team member can join ``` ## `heroku join` @@ -205,11 +235,14 @@ add yourself to a team app ``` USAGE - $ heroku join + $ heroku join -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + add yourself to a team app ``` ## `heroku leave` @@ -218,11 +251,14 @@ remove yourself from a team app ``` USAGE - $ heroku leave + $ heroku leave -a [-r ] + +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + remove yourself from a team app ``` ## `heroku lock` @@ -231,11 +267,14 @@ prevent team members from joining an app ``` USAGE - $ heroku lock + $ heroku lock -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + prevent team members from joining an app ``` ## `heroku members` @@ -244,13 +283,16 @@ list members of a team ``` USAGE - $ heroku members + $ heroku members [-r ] [--pending] [--json] [-t ] + +FLAGS + -r, --role= filter by role + -t, --team= team to use + --json output in json format + --pending filter by pending team invitations -OPTIONS - -r, --role=role filter by role - -t, --team=team team to use - --json output in json format - --pending filter by pending team invitations +DESCRIPTION + list members of a team ``` ## `heroku members:add EMAIL` @@ -259,11 +301,14 @@ adds a user to a team ``` USAGE - $ heroku members:add EMAIL + $ heroku members:add EMAIL -r [-t ] + +FLAGS + -r, --role= (required) member role (admin, collaborator, member, owner) + -t, --team= team to use -OPTIONS - -r, --role=role (required) member role (admin, collaborator, member, owner) - -t, --team=team team to use +DESCRIPTION + adds a user to a team ``` ## `heroku members:remove EMAIL` @@ -272,10 +317,13 @@ removes a user from a team ``` USAGE - $ heroku members:remove EMAIL + $ heroku members:remove EMAIL [-t ] -OPTIONS - -t, --team=team team to use +FLAGS + -t, --team= team to use + +DESCRIPTION + removes a user from a team ``` ## `heroku members:set EMAIL` @@ -284,11 +332,14 @@ sets a members role in a team ``` USAGE - $ heroku members:set EMAIL + $ heroku members:set EMAIL -r [-t ] + +FLAGS + -r, --role= (required) member role (admin, collaborator, member, owner) + -t, --team= team to use -OPTIONS - -r, --role=role (required) member role (admin, collaborator, member, owner) - -t, --team=team team to use +DESCRIPTION + sets a members role in a team ``` ## `heroku orgs` @@ -297,11 +348,14 @@ list the teams that you are a member of ``` USAGE - $ heroku orgs + $ heroku orgs [--json] [--enterprise] -OPTIONS +FLAGS --enterprise filter by enterprise teams --json output in json format + +DESCRIPTION + list the teams that you are a member of ``` ## `heroku orgs:open` @@ -310,10 +364,13 @@ open the team interface in a browser window ``` USAGE - $ heroku orgs:open + $ heroku orgs:open [-t ] -OPTIONS - -t, --team=team team to use +FLAGS + -t, --team= team to use + +DESCRIPTION + open the team interface in a browser window ``` ## `heroku teams` @@ -322,12 +379,14 @@ list the teams that you are a member of ``` USAGE - $ heroku teams + $ heroku teams [--json] -OPTIONS +FLAGS --json output in json format DESCRIPTION + list the teams that you are a member of + Use heroku members:* to manage team members. ``` @@ -337,10 +396,13 @@ unlock an app so any team member can join ``` USAGE - $ heroku unlock + $ heroku unlock -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + unlock an app so any team member can join ``` diff --git a/packages/orgs-v5/package.json b/packages/orgs-v5/package.json index 9408e0f277..7cfd368c3f 100644 --- a/packages/orgs-v5/package.json +++ b/packages/orgs-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-orgs-v5", "description": "CLI to manage Heroku Organizations", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Raul Barroso @raulb", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/pg-v5/CHANGELOG.md b/packages/pg-v5/CHANGELOG.md index 95a576cea6..fe67cd3e4c 100644 --- a/packages/pg-v5/CHANGELOG.md +++ b/packages/pg-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/pg-v5/package.json b/packages/pg-v5/package.json index 999651964e..5fe534e914 100644 --- a/packages/pg-v5/package.json +++ b/packages/pg-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-pg-v5", "description": "Heroku CLI plugin to manage Postgres.", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey (@dickeyxxx)", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/pipelines/CHANGELOG.md b/packages/pipelines/CHANGELOG.md index a1a0b9a400..9727b9941b 100644 --- a/packages/pipelines/CHANGELOG.md +++ b/packages/pipelines/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/pipelines/README.md b/packages/pipelines/README.md index 6bf8e6aea2..514692c9b9 100644 --- a/packages/pipelines/README.md +++ b/packages/pipelines/README.md @@ -20,8 +20,8 @@ $ npm install -g @heroku-cli/plugin-pipelines $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-pipelines/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-pipelines/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -30,347 +30,5 @@ USAGE # Commands -* [`heroku pipelines`](#heroku-pipelines) -* [`heroku pipelines:add PIPELINE`](#heroku-pipelinesadd-pipeline) -* [`heroku pipelines:connect NAME`](#heroku-pipelinesconnect-name) -* [`heroku pipelines:create [NAME]`](#heroku-pipelinescreate-name) -* [`heroku pipelines:destroy PIPELINE`](#heroku-pipelinesdestroy-pipeline) -* [`heroku pipelines:diff`](#heroku-pipelinesdiff) -* [`heroku pipelines:info PIPELINE`](#heroku-pipelinesinfo-pipeline) -* [`heroku pipelines:open PIPELINE`](#heroku-pipelinesopen-pipeline) -* [`heroku pipelines:promote`](#heroku-pipelinespromote) -* [`heroku pipelines:remove`](#heroku-pipelinesremove) -* [`heroku pipelines:rename PIPELINE NAME`](#heroku-pipelinesrename-pipeline-name) -* [`heroku pipelines:setup [NAME] [REPO]`](#heroku-pipelinessetup-name-repo) -* [`heroku pipelines:transfer OWNER`](#heroku-pipelinestransfer-owner) -* [`heroku pipelines:update`](#heroku-pipelinesupdate) -* [`heroku reviewapps:disable`](#heroku-reviewappsdisable) -* [`heroku reviewapps:enable`](#heroku-reviewappsenable) -## `heroku pipelines` - -list pipelines you have access to - -``` -USAGE - $ heroku pipelines - -OPTIONS - --json output in json format - -EXAMPLE - $ heroku pipelines -``` - -_See code: [src/commands/pipelines/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/index.ts)_ - -## `heroku pipelines:add PIPELINE` - -add this app to a pipeline - -``` -USAGE - $ heroku pipelines:add PIPELINE - -ARGUMENTS - PIPELINE name of pipeline - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --stage=stage stage of first app in pipeline - -DESCRIPTION - The app and pipeline names must be specified. - The stage of the app will be guessed based on its name if not specified. - -EXAMPLE - $ heroku pipelines:add my-pipeline -a my-app -s production -``` - -_See code: [src/commands/pipelines/add.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/add.ts)_ - -## `heroku pipelines:connect NAME` - -connect a github repo to an existing pipeline - -``` -USAGE - $ heroku pipelines:connect NAME - -ARGUMENTS - NAME name of pipeline - -OPTIONS - -r, --repo=repo (required) the GitHub repository to connect to - -EXAMPLE - $ heroku pipelines:connect my-pipeline -r githuborg/reponame -``` - -_See code: [src/commands/pipelines/connect.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/connect.ts)_ - -## `heroku pipelines:create [NAME]` - -create a new pipeline - -``` -USAGE - $ heroku pipelines:create [NAME] - -ARGUMENTS - NAME name of pipeline (defaults to basename of the app) - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --stage=stage stage of first app in pipeline - -t, --team=team the team which will own the apps - -DESCRIPTION - An existing app must be specified as the first app in the pipeline. - The pipeline name will be inferred from the app name if not specified. - The stage of the app will be guessed based on its name if not specified. - The pipeline owner will be the user creating the pipeline if not specified with -t for teams or -o for orgs. - -EXAMPLES - $ heroku pipelines:create -a my-app-staging - $ heroku pipelines:create my-pipeline -a my-app-staging -``` - -_See code: [src/commands/pipelines/create.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/create.ts)_ - -## `heroku pipelines:destroy PIPELINE` - -destroy a pipeline - -``` -USAGE - $ heroku pipelines:destroy PIPELINE - -ARGUMENTS - PIPELINE name of pipeline - -EXAMPLE - $ heroku pipelines:destroy my-pipeline -``` - -_See code: [src/commands/pipelines/destroy.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/destroy.ts)_ - -## `heroku pipelines:diff` - -compares the latest release of this app to its downstream app(s) - -``` -USAGE - $ heroku pipelines:diff - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -EXAMPLE - $ heroku pipelines:diff -a my-app-staging -``` - -_See code: [src/commands/pipelines/diff.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/diff.ts)_ - -## `heroku pipelines:info PIPELINE` - -show list of apps in a pipeline - -``` -USAGE - $ heroku pipelines:info PIPELINE - -ARGUMENTS - PIPELINE pipeline to show list of apps for - -OPTIONS - --json output in json format - -EXAMPLE - $ heroku pipelines:info my-pipeline -``` - -_See code: [src/commands/pipelines/info.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/info.ts)_ - -## `heroku pipelines:open PIPELINE` - -open a pipeline in dashboard - -``` -USAGE - $ heroku pipelines:open PIPELINE - -ARGUMENTS - PIPELINE name of pipeline - -EXAMPLE - $ heroku pipelines:open my-pipeline -``` - -_See code: [src/commands/pipelines/open.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/open.ts)_ - -## `heroku pipelines:promote` - -promote the latest release of this app to its downstream app(s) - -``` -USAGE - $ heroku pipelines:promote - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -t, --to=to comma separated list of apps to promote to - -EXAMPLE - $ heroku pipelines:promote -a my-app-staging -``` - -_See code: [src/commands/pipelines/promote.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/promote.ts)_ - -## `heroku pipelines:remove` - -remove this app from its pipeline - -``` -USAGE - $ heroku pipelines:remove - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -EXAMPLE - $ heroku pipelines:remove -a my-app -``` - -_See code: [src/commands/pipelines/remove.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/remove.ts)_ - -## `heroku pipelines:rename PIPELINE NAME` - -rename a pipeline - -``` -USAGE - $ heroku pipelines:rename PIPELINE NAME - -ARGUMENTS - PIPELINE current name of pipeline - NAME new name of pipeline - -EXAMPLE - $ heroku pipelines:rename my-pipeline new-pipeline-name -``` - -_See code: [src/commands/pipelines/rename.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/rename.ts)_ - -## `heroku pipelines:setup [NAME] [REPO]` - -bootstrap a new pipeline with common settings and create a production and staging app (requires a fully formed app.json in the repo) - -``` -USAGE - $ heroku pipelines:setup [NAME] [REPO] - -ARGUMENTS - NAME name of pipeline - REPO a GitHub repository to connect the pipeline to - -OPTIONS - -t, --team=team the team to assign pipeline ownership to (defaults to current user) - -y, --yes accept all default settings without prompting - -EXAMPLE - $ heroku pipelines:setup my-pipeline githuborg/reponame -t my-team -``` - -_See code: [src/commands/pipelines/setup.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/setup.ts)_ - -## `heroku pipelines:transfer OWNER` - -transfer ownership of a pipeline - -``` -USAGE - $ heroku pipelines:transfer OWNER - -ARGUMENTS - OWNER the owner to transfer the pipeline to - -OPTIONS - -c, --confirm=confirm - -p, --pipeline=pipeline (required) name of pipeline - -EXAMPLES - $ heroku pipelines:transfer admin@example.com -p my-pipeline - $ heroku pipelines:transfer admin-team -p my-pipeline -``` - -_See code: [src/commands/pipelines/transfer.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/transfer.ts)_ - -## `heroku pipelines:update` - -update the app's stage in a pipeline - -``` -USAGE - $ heroku pipelines:update - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --stage=stage (required) new stage of app - -EXAMPLE - $ heroku pipelines:update -s staging -a my-app -``` - -_See code: [src/commands/pipelines/update.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/pipelines/update.ts)_ - -## `heroku reviewapps:disable` - -disable review apps and/or settings on an existing pipeline - -``` -USAGE - $ heroku reviewapps:disable - -OPTIONS - -a, --app=app parent app used by review apps - -p, --pipeline=pipeline (required) name of pipeline - -r, --remote=remote git remote of app to use - --no-autodeploy disable autodeployments - --no-autodestroy disable automatically destroying review apps - --no-wait-for-ci disable wait for CI - -EXAMPLE - $ heroku reviewapps:disable -p my-pipeline -a my-app --no-autodeploy -``` - -_See code: [src/commands/reviewapps/disable.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/reviewapps/disable.ts)_ - -## `heroku reviewapps:enable` - -enable review apps and/or settings on an existing pipeline - -``` -USAGE - $ heroku reviewapps:enable - -OPTIONS - -a, --app=app parent app used by review apps - -p, --pipeline=pipeline (required) name of pipeline - -r, --remote=remote git remote of app to use - --autodeploy autodeploy the review app - --autodestroy autodestroy the review app - --wait-for-ci wait for CI to pass before deploying - -EXAMPLE - $ heroku reviewapps:enable -p my-pipeline -a my-app --autodeploy --autodestroy -``` - -_See code: [src/commands/reviewapps/enable.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/reviewapps/enable.ts)_ diff --git a/packages/pipelines/package.json b/packages/pipelines/package.json index 3a1942109c..063fd0e792 100644 --- a/packages/pipelines/package.json +++ b/packages/pipelines/package.json @@ -1,6 +1,6 @@ { "name": "@heroku-cli/plugin-pipelines", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "James Martinez @jmar910", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/ps/CHANGELOG.md b/packages/ps/CHANGELOG.md index 4a821a7233..f585b20ead 100644 --- a/packages/ps/CHANGELOG.md +++ b/packages/ps/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/ps/README.md b/packages/ps/README.md index 54fd2f8524..fe4de0c95e 100644 --- a/packages/ps/README.md +++ b/packages/ps/README.md @@ -14,78 +14,5 @@ ps core plugin for Heroku CLI # Commands -* [`heroku ps:autoscale:disable`](#heroku-psautoscaledisable) -* [`heroku ps:autoscale:enable`](#heroku-psautoscaleenable) -* [`heroku ps:wait`](#heroku-pswait) -* [`heroku regions`](#heroku-regions) -## `heroku ps:autoscale:disable` - -disable web dyno autoscaling - -``` -USAGE - $ heroku ps:autoscale:disable - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use -``` - -_See code: [src/commands/ps/autoscale/disable.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ps/src/commands/ps/autoscale/disable.ts)_ - -## `heroku ps:autoscale:enable` - -enable web dyno autoscaling - -``` -USAGE - $ heroku ps:autoscale:enable - -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --max=max (required) maximum number of dynos - --min=min (required) minimum number of dynos - --notifications receive email notifications when the max dyno limit is reached - --p95=p95 desired p95 response time -``` - -_See code: [src/commands/ps/autoscale/enable.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ps/src/commands/ps/autoscale/enable.ts)_ - -## `heroku ps:wait` - -wait for all dynos to be running latest version after a release - -``` -USAGE - $ heroku ps:wait - -OPTIONS - -R, --with-run whether to wait for one-off run dynos - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -t, --type=type wait for one specific dyno type - - -w, --wait-interval=wait-interval [default: 10] how frequently to poll in seconds (to avoid hitting Heroku API rate - limits) -``` - -_See code: [src/commands/ps/wait.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ps/src/commands/ps/wait.ts)_ - -## `heroku regions` - -list available regions for deployment - -``` -USAGE - $ heroku regions - -OPTIONS - --common show regions for common runtime - --json output in json format - --private show regions for private spaces -``` - -_See code: [src/commands/regions.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/ps/src/commands/regions.ts)_ diff --git a/packages/ps/package.json b/packages/ps/package.json index f1698c91b9..434a9c293b 100644 --- a/packages/ps/package.json +++ b/packages/ps/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-ps", "description": "ps core plugin for Heroku CLI", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey @jdxcode", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/redis-v5/CHANGELOG.md b/packages/redis-v5/CHANGELOG.md index 42f9541779..b3582ad946 100644 --- a/packages/redis-v5/CHANGELOG.md +++ b/packages/redis-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + ## [7.68.3](https://github.com/heroku/cli/compare/v7.68.2...v7.68.3) (2023-03-06) diff --git a/packages/redis-v5/README.md b/packages/redis-v5/README.md index e647137c7e..38174a7b27 100644 --- a/packages/redis-v5/README.md +++ b/packages/redis-v5/README.md @@ -40,12 +40,15 @@ gets information about redis ``` USAGE - $ heroku redis [DATABASE] + $ heroku redis [DATABASE] -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json format output as JSON +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json format output as JSON + +DESCRIPTION + gets information about redis ``` ## `heroku redis:cli [DATABASE]` @@ -54,12 +57,15 @@ opens a redis prompt ``` USAGE - $ heroku redis:cli [DATABASE] + $ heroku redis:cli [DATABASE] -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + +DESCRIPTION + opens a redis prompt ``` ## `heroku redis:credentials [DATABASE]` @@ -68,12 +74,15 @@ display credentials information ``` USAGE - $ heroku redis:credentials [DATABASE] + $ heroku redis:credentials [DATABASE] -a [--reset] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --reset reset credentials +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --reset reset credentials + +DESCRIPTION + display credentials information ``` ## `heroku redis:info [DATABASE]` @@ -82,12 +91,15 @@ gets information about redis ``` USAGE - $ heroku redis:info [DATABASE] + $ heroku redis:info [DATABASE] -a [--json] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --json format output as JSON +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --json format output as JSON + +DESCRIPTION + gets information about redis ``` ## `heroku redis:keyspace-notifications [DATABASE]` @@ -96,30 +108,31 @@ set the keyspace notifications configuration ``` USAGE - $ heroku redis:keyspace-notifications [DATABASE] + $ heroku redis:keyspace-notifications [DATABASE] -c -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --config=config (required) set keyspace notifications configuration - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --config= (required) set keyspace notifications configuration + -r, --remote= git remote of app to use DESCRIPTION + set the keyspace notifications configuration Set the configuration to enable keyspace notification events: - K Keyspace events, published with __keyspace@__ prefix. - E Keyevent events, published with __keyevent@__ prefix. - g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... - $ String commands - l List commands - s Set commands - h Hash commands - z Sorted set commands - t Stream commands - x Expired events (events generated every time a key expires) - e Evicted events (events generated when a key is evicted for maxmemory) - m Key miss events (events generated when a key that doesn't exist is accessed) - A Alias for "g$lshztxe", so that the "AKE" string means all the events except "m". - - pass an empty string ('') to disable keyspace notifications + K Keyspace events, published with __keyspace@__ prefix. + E Keyevent events, published with __keyevent@__ prefix. + g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... + $ String commands + l List commands + s Set commands + h Hash commands + z Sorted set commands + t Stream commands + x Expired events (events generated every time a key expires) + e Evicted events (events generated when a key is evicted for maxmemory) + m Key miss events (events generated when a key that doesn't exist is accessed) + A Alias for "g$lshztxe", so that the "AKE" string means all the events except "m". + + pass an empty string ('') to disable keyspace notifications ``` ## `heroku redis:maintenance [DATABASE]` @@ -128,16 +141,17 @@ manage maintenance windows ``` USAGE - $ heroku redis:maintenance [DATABASE] + $ heroku redis:maintenance [DATABASE] -a [-w ] [--run] [-f] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -f, --force start maintenance without entering application maintenance mode - -r, --remote=remote git remote of app to use - -w, --window=window set weekly UTC maintenance window - --run start maintenance +FLAGS + -a, --app= (required) app to run command against + -f, --force start maintenance without entering application maintenance mode + -r, --remote= git remote of app to use + -w, --window= set weekly UTC maintenance window + --run start maintenance DESCRIPTION + manage maintenance windows Set or change the maintenance window for your Redis instance ``` @@ -147,24 +161,25 @@ set the key eviction policy ``` USAGE - $ heroku redis:maxmemory [DATABASE] + $ heroku redis:maxmemory [DATABASE] -p -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -p, --policy=policy (required) set policy name - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -p, --policy= (required) set policy name + -r, --remote= git remote of app to use DESCRIPTION + set the key eviction policy Set the key eviction policy when instance reaches its storage limit. Available policies for key eviction include: - noeviction # returns errors when memory limit is reached - allkeys-lfu # removes less frequently used keys first - volatile-lfu # removes less frequently used keys first that have an expiry set - allkeys-lru # removes less recently used keys first - volatile-lru # removes less recently used keys first that have an expiry set - allkeys-random # evicts random keys - volatile-random # evicts random keys but only those that have an expiry set - volatile-ttl # only evicts keys with an expiry set and a short TTL + noeviction # returns errors when memory limit is reached + allkeys-lfu # removes less frequently used keys first + volatile-lfu # removes less frequently used keys first that have an expiry set + allkeys-lru # removes less recently used keys first + volatile-lru # removes less recently used keys first that have an expiry set + allkeys-random # evicts random keys + volatile-random # evicts random keys but only those that have an expiry set + volatile-ttl # only evicts keys with an expiry set and a short TTL ``` ## `heroku redis:promote DATABASE` @@ -173,11 +188,14 @@ sets DATABASE as your REDIS_URL ``` USAGE - $ heroku redis:promote DATABASE + $ heroku redis:promote DATABASE -a [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + sets DATABASE as your REDIS_URL ``` ## `heroku redis:stats-reset [DATABASE]` @@ -186,12 +204,15 @@ reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat ``` USAGE - $ heroku redis:stats-reset [DATABASE] + $ heroku redis:stats-reset [DATABASE] -a [-c ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + +DESCRIPTION + reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat) ``` ## `heroku redis:timeout [DATABASE]` @@ -200,16 +221,17 @@ set the number of seconds to wait before killing idle connections ``` USAGE - $ heroku redis:timeout [DATABASE] + $ heroku redis:timeout [DATABASE] -a [-s ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - -s, --seconds=seconds set timeout value +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + -s, --seconds= set timeout value DESCRIPTION + set the number of seconds to wait before killing idle connections Sets the number of seconds to wait before killing idle connections. A value of zero means that connections will not be - closed. + closed. ``` ## `heroku redis:upgrade [DATABASE]` @@ -218,13 +240,16 @@ perform in-place version upgrade ``` USAGE - $ heroku redis:upgrade [DATABASE] + $ heroku redis:upgrade [DATABASE] -a [-c ] [-v ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -c, --confirm=confirm - -r, --remote=remote git remote of app to use - -v, --version=version +FLAGS + -a, --app= (required) app to run command against + -c, --confirm= + -r, --remote= git remote of app to use + -v, --version= + +DESCRIPTION + perform in-place version upgrade ``` ## `heroku redis:wait [DATABASE]` @@ -233,11 +258,14 @@ wait for Redis instance to be available ``` USAGE - $ heroku redis:wait [DATABASE] + $ heroku redis:wait [DATABASE] -a [--wait-interval ] [-r ] -OPTIONS - -a, --app=app (required) app to run command against - -r, --remote=remote git remote of app to use - --wait-interval=wait-interval how frequently to poll in seconds +FLAGS + -a, --app= (required) app to run command against + -r, --remote= git remote of app to use + --wait-interval= how frequently to poll in seconds + +DESCRIPTION + wait for Redis instance to be available ``` diff --git a/packages/redis-v5/package.json b/packages/redis-v5/package.json index 37fb976c46..e79a08d077 100644 --- a/packages/redis-v5/package.json +++ b/packages/redis-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-redis-v5", "description": "Heroku plugin to manage Heroku Redis", - "version": "7.68.3", + "version": "8.0.2-beta.0", "author": "Heroku", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/run-v5/CHANGELOG.md b/packages/run-v5/CHANGELOG.md index 2fb92ff544..37a56a08ab 100644 --- a/packages/run-v5/CHANGELOG.md +++ b/packages/run-v5/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/run-v5/README.md b/packages/run-v5/README.md index cdc960ee89..6346c4c7af 100644 --- a/packages/run-v5/README.md +++ b/packages/run-v5/README.md @@ -6,91 +6,5 @@ heroku-run [![Circle CI](https://circleci.com/gh/heroku/heroku-run.svg?style=svg Heroku CLI plugin to run one-off dyno processes. -* [`heroku logs`](#heroku-logs) -* [`heroku run`](#heroku-run) -* [`heroku run:detached`](#heroku-rundetached) -## `heroku logs` - -display recent log output - -``` -USAGE - $ heroku logs - -OPTIONS - -a, --app=app (required) app to run command against - -d, --dyno=dyno only show output from this dyno type (such as "web" or "worker") - -n, --num=num number of lines to display - -r, --remote=remote git remote of app to use - -s, --source=source only show output from this source (such as "app" or "heroku") - -t, --tail continually stream logs - --force-colors force use of colors (even on non-tty output) - -DESCRIPTION - disable colors with --no-color, HEROKU_LOGS_COLOR=0, or HEROKU_COLOR=0 - -EXAMPLES - $ heroku logs - 2012-01-01T12:00:00+00:00 heroku[api]: Config add EXAMPLE by email@example.com - 2012-01-01T12:00:01+00:00 heroku[api]: Release v1 created by email@example.com -``` - -_See code: [commands/logs.js](https://github.com/heroku/cli/blob/v7.68.0/packages/run-v5/commands/logs.js)_ - -## `heroku run` - -run a one-off process inside a heroku dyno - -``` -USAGE - $ heroku run - -OPTIONS - -a, --app=app (required) app to run command against - -e, --env=env environment variables to set (use ';' to split multiple vars) - -r, --remote=remote git remote of app to use - -s, --size=size dyno size - -x, --exit-code passthrough the exit code of the remote command - --no-notify disables notification when dyno is up (alternatively use HEROKU_NOTIFICATIONS=0) - --no-tty force the command to not run in a tty - --type=type process type - -DESCRIPTION - Shows a notification if the dyno takes more than 20 seconds to start. - -EXAMPLES - $ heroku run bash - Running bash on app.... up, run.1 - ~ $ - - $ heroku run -s standard-2x -- myscript.sh -a arg1 -s arg2 - Running myscript.sh -a arg1 -s arg2 on app.... up, run.1 -``` - -_See code: [commands/run.js](https://github.com/heroku/cli/blob/v7.68.0/packages/run-v5/commands/run.js)_ - -## `heroku run:detached` - -run a detached dyno, where output is sent to your logs - -``` -USAGE - $ heroku run:detached - -OPTIONS - -a, --app=app (required) app to run command against - -e, --env=env environment variables to set (use ';' to split multiple vars) - -r, --remote=remote git remote of app to use - -s, --size=size dyno size - -t, --tail stream logs from the dyno - --type=type process type - -EXAMPLES - $ heroku run:detached ls - Running ls on app [detached]... up, run.1 - Run heroku logs -a app -p run.1 to view the output. -``` - -_See code: [commands/run/detached.js](https://github.com/heroku/cli/blob/v7.68.0/packages/run-v5/commands/run/detached.js)_ diff --git a/packages/run-v5/package.json b/packages/run-v5/package.json index 83a7bb9330..57965c1c51 100644 --- a/packages/run-v5/package.json +++ b/packages/run-v5/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-run-v5", "description": "Heroku CLI plugin to run one-off dyno processes.", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey (@dickeyxxx)", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/run/CHANGELOG.md b/packages/run/CHANGELOG.md index 7f63a7b56c..c9ee4ad3c8 100644 --- a/packages/run/CHANGELOG.md +++ b/packages/run/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/run/README.md b/packages/run/README.md index a9768c29fd..a5040528b8 100644 --- a/packages/run/README.md +++ b/packages/run/README.md @@ -20,8 +20,8 @@ $ npm install -g @heroku-cli/plugin-run $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-run/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-run/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -32,86 +32,5 @@ USAGE # Commands -* [`heroku logs`](#heroku-logs) -* [`heroku run`](#heroku-run) -* [`heroku run:detached`](#heroku-rundetached) -## `heroku logs` - -display recent log output - -``` -USAGE - $ heroku logs - -OPTIONS - -a, --app=app (required) app to run command against - -d, --dyno=dyno only show output from this dyno type (such as "web" or "worker") - -n, --num=num number of lines to display - -r, --remote=remote git remote of app to use - -s, --source=source only show output from this source (such as "app" or "heroku") - -t, --tail continually stream logs - --force-colors force use of colors (even on non-tty output) - -DESCRIPTION - disable colors with --no-color, HEROKU_LOGS_COLOR=0, or HEROKU_COLOR=0 - -EXAMPLES - $ heroku logs --app=my-app - $ heroku logs --num=50 - $ heroku logs --dyno=web --app=my-app - $ heroku logs --app=my-app --tail -``` - -_See code: [src/commands/logs.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/logs.ts)_ - -## `heroku run` - -run a one-off process inside a heroku dyno - -``` -USAGE - $ heroku run - -OPTIONS - -a, --app=app (required) parent app used by review apps - -e, --env=env environment variables to set (use ';' to split multiple vars) - -r, --remote=remote git remote of app to use - -s, --size=size dyno size - -x, --exit-code passthrough the exit code of the remote command - --no-notify disables notification when dyno is up (alternatively use HEROKU_NOTIFICATIONS=0) - --no-tty force the command to not run in a tty - --type=type process type - -DESCRIPTION - Shows a notification if the dyno takes more than 20 seconds to start. - -EXAMPLES - $ heroku run bash - $ heroku run -s standard-2x -- myscript.sh -a arg1 -s arg2 -``` - -_See code: [src/commands/run/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/run/index.ts)_ - -## `heroku run:detached` - -run a detached dyno, where output is sent to your logs - -``` -USAGE - $ heroku run:detached - -OPTIONS - -a, --app=app (required) app to run command against - -e, --env=env environment variables to set (use ';' to split multiple vars) - -r, --remote=remote git remote of app to use - -s, --size=size dyno size - -t, --tail continually stream logs - --type=type process type - -EXAMPLE - $ heroku run:detached ls -``` - -_See code: [src/commands/run/detached.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/run/detached.ts)_ diff --git a/packages/run/package.json b/packages/run/package.json index 99e32014f8..ff9de43083 100644 --- a/packages/run/package.json +++ b/packages/run/package.json @@ -1,6 +1,6 @@ { "name": "@heroku-cli/plugin-run", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Chris Freeman @cafreeman", "bugs": "https://github.com/heroku/cli/issues", "dependencies": { diff --git a/packages/spaces/CHANGELOG.md b/packages/spaces/CHANGELOG.md index b8d349bd80..0cdce7ae3d 100644 --- a/packages/spaces/CHANGELOG.md +++ b/packages/spaces/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/spaces/README.md b/packages/spaces/README.md index 4b9fc52a69..0340600c2d 100644 --- a/packages/spaces/README.md +++ b/packages/spaces/README.md @@ -34,11 +34,14 @@ list available spaces ``` USAGE - $ heroku spaces + $ heroku spaces [--json] [-t ] -OPTIONS - -t, --team=team team to use - --json output in json format +FLAGS + -t, --team= team to use + --json output in json format + +DESCRIPTION + list available spaces ``` ## `heroku spaces:create` @@ -47,28 +50,29 @@ create a new space ``` USAGE - $ heroku spaces:create + $ heroku spaces:create [SPACE] [-s ] [--region ] [--cidr ] [--data-cidr ] [-t ] -OPTIONS - -s, --space=space name of space to create - -t, --team=team team to use - --cidr=cidr RFC-1918 CIDR the space will use - --data-cidr=data-cidr RFC-1918 CIDR used by Heroku Data resources for the space - --region=region region name +FLAGS + -s, --space= name of space to create + -t, --team= team to use + --cidr= RFC-1918 CIDR the space will use + --data-cidr= RFC-1918 CIDR used by Heroku Data resources for the space + --region= region name DESCRIPTION + create a new space Example: - $ heroku spaces:create --space my-space --team my-team --region oregon - Creating space my-space in team my-team... done - === my-space - ID: e7b99e37-69b3-4475-ad47-a5cc5d75fd9f - Team: my-team - Region: oregon - CIDR: 10.0.0.0/16 - Data CIDR: 172.23.0.0/20 - State: allocating - Created at: 2016-01-06T03:23:13Z + $ heroku spaces:create --space my-space --team my-team --region oregon + Creating space my-space in team my-team... done + === my-space + ID: e7b99e37-69b3-4475-ad47-a5cc5d75fd9f + Team: my-team + Region: oregon + CIDR: 10.0.0.0/16 + Data CIDR: 172.23.0.0/20 + State: allocating + Created at: 2016-01-06T03:23:13Z ``` ## `heroku spaces:destroy` @@ -77,17 +81,18 @@ destroy a space ``` USAGE - $ heroku spaces:destroy + $ heroku spaces:destroy [SPACE] [-s ] [--confirm ] -OPTIONS - -s, --space=space space to destroy - --confirm=confirm set to space name to bypass confirm prompt +FLAGS + -s, --space= space to destroy + --confirm= set to space name to bypass confirm prompt DESCRIPTION + destroy a space Example: - $ heroku spaces:destroy --space my-space - Destroying my-space... done + $ heroku spaces:destroy --space my-space + Destroying my-space... done ``` ## `heroku spaces:info` @@ -96,11 +101,14 @@ show info about a space ``` USAGE - $ heroku spaces:info + $ heroku spaces:info [SPACE] [-s ] [--json] + +FLAGS + -s, --space= space to get info of + --json output in json format -OPTIONS - -s, --space=space space to get info of - --json output in json format +DESCRIPTION + show info about a space ``` ## `heroku spaces:peering:info` @@ -109,25 +117,26 @@ display the information necessary to initiate a peering connection ``` USAGE - $ heroku spaces:peering:info + $ heroku spaces:peering:info [SPACE] [-s ] [--json] -OPTIONS - -s, --space=space space to get peering info from - --json output in json format +FLAGS + -s, --space= space to get peering info from + --json output in json format DESCRIPTION + display the information necessary to initiate a peering connection Example: - $ heroku spaces:peering:info example-space - === example-space Peering Info - AWS Account ID: 012345678910 - AWS Region: us-west-2 - AWS VPC ID: vpc-baadf00d - AWS VPC CIDR: 10.0.0.0/16 - Space CIDRs: 10.0.128.0/20, 10.0.144.0/20 - Unavailable CIDRs: 10.1.0.0/16 + $ heroku spaces:peering:info example-space + === example-space Peering Info + AWS Account ID: 012345678910 + AWS Region: us-west-2 + AWS VPC ID: vpc-baadf00d + AWS VPC CIDR: 10.0.0.0/16 + Space CIDRs: 10.0.128.0/20, 10.0.144.0/20 + Unavailable CIDRs: 10.1.0.0/16 - You will use the information provied by this command to establish a peering connection request from your AWS VPC to + You will use the information provied by this command to establish a peering connection request from your AWS VPC to your private space. To start the peering process, go into your AWS console for the VPC you would like peered with your Private Space, @@ -146,11 +155,14 @@ list peering connections for a space ``` USAGE - $ heroku spaces:peerings + $ heroku spaces:peerings [SPACE] [-s ] [--json] + +FLAGS + -s, --space= space to get peer list from + --json output in json format -OPTIONS - -s, --space=space space to get peer list from - --json output in json format +DESCRIPTION + list peering connections for a space ``` ## `heroku spaces:peerings:accept` @@ -159,17 +171,18 @@ accepts a pending peering request for a private space ``` USAGE - $ heroku spaces:peerings:accept + $ heroku spaces:peerings:accept [PCXID] [-p ] [-s ] -OPTIONS - -p, --pcxid=pcxid PCX ID of a pending peering - -s, --space=space space to get peering info from +FLAGS + -p, --pcxid= PCX ID of a pending peering + -s, --space= space to get peering info from DESCRIPTION + accepts a pending peering request for a private space Example: - $ heroku spaces:peerings:accept pcx-4bd27022 --space example-space - Accepting and configuring peering connection pcx-4bd27022 + $ heroku spaces:peerings:accept pcx-4bd27022 --space example-space + Accepting and configuring peering connection pcx-4bd27022 ``` ## `heroku spaces:peerings:destroy` @@ -178,18 +191,19 @@ destroys an active peering connection in a private space ``` USAGE - $ heroku spaces:peerings:destroy + $ heroku spaces:peerings:destroy [PCXID] [-p ] [-s ] [--confirm ] -OPTIONS - -p, --pcxid=pcxid PCX ID of a pending peering - -s, --space=space space to get peering info from - --confirm=confirm set to PCX ID to bypass confirm prompt +FLAGS + -p, --pcxid= PCX ID of a pending peering + -s, --space= space to get peering info from + --confirm= set to PCX ID to bypass confirm prompt DESCRIPTION + destroys an active peering connection in a private space Example: - $ heroku spaces:peerings:destroy pcx-4bd27022 --confirm pcx-4bd27022 --space example-space - Tearing down peering connection pcx-4bd27022 + $ heroku spaces:peerings:destroy pcx-4bd27022 --confirm pcx-4bd27022 --space example-space + Tearing down peering connection pcx-4bd27022 ``` ## `heroku spaces:ps` @@ -198,11 +212,14 @@ list dynos for a space ``` USAGE - $ heroku spaces:ps + $ heroku spaces:ps [SPACE] [-s ] [--json] + +FLAGS + -s, --space= space to get dynos of + --json output in json format -OPTIONS - -s, --space=space space to get dynos of - --json output in json format +DESCRIPTION + list dynos for a space ``` ## `heroku spaces:rename` @@ -211,17 +228,18 @@ renames a space ``` USAGE - $ heroku spaces:rename + $ heroku spaces:rename --from --to -OPTIONS - --from=from (required) current name of space - --to=to (required) desired name of space +FLAGS + --from= (required) current name of space + --to= (required) desired name of space DESCRIPTION + renames a space Example: - $ heroku spaces:rename --from old-space-name --to new-space-name - Renaming space old-space-name to new-space-name... done + $ heroku spaces:rename --from old-space-name --to new-space-name + Renaming space old-space-name to new-space-name... done ``` ## `heroku spaces:topology` @@ -230,11 +248,14 @@ show space topology ``` USAGE - $ heroku spaces:topology + $ heroku spaces:topology [SPACE] [-s ] [--json] + +FLAGS + -s, --space= space to get topology of + --json output in json format -OPTIONS - -s, --space=space space to get topology of - --json output in json format +DESCRIPTION + show space topology ``` ## `heroku spaces:transfer` @@ -243,17 +264,18 @@ transfer a space to another team ``` USAGE - $ heroku spaces:transfer + $ heroku spaces:transfer --space --team -OPTIONS - --space=space (required) name of space - --team=team (required) desired owner of space +FLAGS + --space= (required) name of space + --team= (required) desired owner of space DESCRIPTION + transfer a space to another team Example: - $ heroku spaces:transfer --space=space-name --team=team-name - Transferring space-name to team-name... done + $ heroku spaces:transfer --space=space-name --team=team-name + Transferring space-name to team-name... done ``` ## `heroku spaces:vpn:config` @@ -262,22 +284,23 @@ display the configuration information for VPN ``` USAGE - $ heroku spaces:vpn:config + $ heroku spaces:vpn:config [NAME] [-s ] [-n ] [--json] -OPTIONS - -n, --name=name name or id of the VPN connection to retrieve config from - -s, --space=space space the VPN connection belongs to - --json output in json format +FLAGS + -n, --name= name or id of the VPN connection to retrieve config from + -s, --space= space the VPN connection belongs to + --json output in json format DESCRIPTION + display the configuration information for VPN Example: - $ heroku spaces:vpn:config --space my-space vpn-connection-name - === vpn-connection-name VPN Tunnels - VPN Tunnel Customer Gateway VPN Gateway Pre-shared Key Routable Subnets IKE Version - ────────── ──────────────── ────────────── ────────────── ──────────────── ─────────── - Tunnel 1 104.196.121.200 35.171.237.136 abcdef12345 10.0.0.0/16 1 - Tunnel 2 104.196.121.200 52.44.7.216 fedcba54321 10.0.0.0/16 1 + $ heroku spaces:vpn:config --space my-space vpn-connection-name + === vpn-connection-name VPN Tunnels + VPN Tunnel Customer Gateway VPN Gateway Pre-shared Key Routable Subnets IKE Version + ────────── ──────────────── ────────────── ────────────── ──────────────── ─────────── + Tunnel 1 104.196.121.200 35.171.237.136 abcdef12345 10.0.0.0/16 1 + Tunnel 2 104.196.121.200 52.44.7.216 fedcba54321 10.0.0.0/16 1 You will use the information provided by this command to establish a Private Space VPN Connection. @@ -293,16 +316,17 @@ create VPN ``` USAGE - $ heroku spaces:vpn:connect + $ heroku spaces:vpn:connect [NAME] [-n ] [-i ] [-c ] [-s ] -OPTIONS - -c, --cidrs=cidrs a list of routable CIDRs separated by commas - -i, --ip=ip public IP of customer gateway - -n, --name=name VPN name - -s, --space=space space name +FLAGS + -c, --cidrs= a list of routable CIDRs separated by commas + -i, --ip= public IP of customer gateway + -n, --name= VPN name + -s, --space= space name DESCRIPTION - Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to + create VPN + Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to hosts on your private networks and vice versa. The connection is established over the public Internet but all traffic is encrypted using IPSec. @@ -318,20 +342,21 @@ list the VPN Connections for a space ``` USAGE - $ heroku spaces:vpn:connections + $ heroku spaces:vpn:connections [SPACE] [-s ] [--json] -OPTIONS - -s, --space=space space to get VPN connections from - --json output in json format +FLAGS + -s, --space= space to get VPN connections from + --json output in json format DESCRIPTION + list the VPN Connections for a space Example: - $ heroku spaces:vpn:connections --space my-space - === my-space VPN Connections - Name Status Tunnels - ────── ────── ─────── - office active UP/UP + $ heroku spaces:vpn:connections --space my-space + === my-space VPN Connections + Name Status Tunnels + ────── ────── ─────── + office active UP/UP ``` ## `heroku spaces:vpn:destroy` @@ -340,18 +365,19 @@ destroys VPN in a private space ``` USAGE - $ heroku spaces:vpn:destroy + $ heroku spaces:vpn:destroy [NAME] [-s ] [-n ] [--confirm ] -OPTIONS - -n, --name=name name or id of the VPN connection to retrieve config from - -s, --space=space space to get peering info from - --confirm=confirm set to VPN connection name to bypass confirm prompt +FLAGS + -n, --name= name or id of the VPN connection to retrieve config from + -s, --space= space to get peering info from + --confirm= set to VPN connection name to bypass confirm prompt DESCRIPTION + destroys VPN in a private space Example: - $ heroku spaces:vpn:destroy --space example-space vpn-connection-name --confirm vpn-connection-name - Tearing down VPN Connection vpn-connection-name in space example-space + $ heroku spaces:vpn:destroy --space example-space vpn-connection-name --confirm vpn-connection-name + Tearing down VPN Connection vpn-connection-name in space example-space ``` ## `heroku spaces:vpn:info` @@ -360,29 +386,30 @@ display the information for VPN ``` USAGE - $ heroku spaces:vpn:info + $ heroku spaces:vpn:info [NAME] [-s ] [--json] [-n ] -OPTIONS - -n, --name=name name or id of the VPN connection to get info from - -s, --space=space space the vpn connection belongs to - --json output in json format +FLAGS + -n, --name= name or id of the VPN connection to get info from + -s, --space= space the vpn connection belongs to + --json output in json format DESCRIPTION + display the information for VPN Example: - $ heroku spaces:vpn:info --space my-space vpn-connection-name - === vpn-connection-name VPN Tunnel Info - Name: vpn-connection-name - ID: 123456789012 - Public IP: 35.161.69.30 - Routable CIDRs: 172.16.0.0/16 - Status: failed - Status Message: supplied CIDR block already in use - === my-space Tunnel Info - VPN Tunnel IP Address Status Status Last Changed Details - ────────── ───────────── ────── ──────────────────── ────────────── - Tunnel 1 52.44.146.197 UP 2016-10-25T22:09:05Z status message - Tunnel 2 52.44.146.197 UP 2016-10-25T22:09:05Z status message + $ heroku spaces:vpn:info --space my-space vpn-connection-name + === vpn-connection-name VPN Tunnel Info + Name: vpn-connection-name + ID: 123456789012 + Public IP: 35.161.69.30 + Routable CIDRs: 172.16.0.0/16 + Status: failed + Status Message: supplied CIDR block already in use + === my-space Tunnel Info + VPN Tunnel IP Address Status Status Last Changed Details + ────────── ───────────── ────── ──────────────────── ────────────── + Tunnel 1 52.44.146.197 UP 2016-10-25T22:09:05Z status message + Tunnel 2 52.44.146.197 UP 2016-10-25T22:09:05Z status message ``` ## `heroku spaces:vpn:update` @@ -391,15 +418,16 @@ update VPN ``` USAGE - $ heroku spaces:vpn:update + $ heroku spaces:vpn:update [NAME] [-n ] [-c ] [-s ] -OPTIONS - -c, --cidrs=cidrs a list of routable CIDRs separated by commas - -n, --name=name VPN name - -s, --space=space space name +FLAGS + -c, --cidrs= a list of routable CIDRs separated by commas + -n, --name= VPN name + -s, --space= space name DESCRIPTION - Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to + update VPN + Private Spaces can be connected to another private network via an IPSec VPN connection allowing dynos to connect to hosts on your private networks and vice versa. The connection is established over the public Internet but all traffic is encrypted using IPSec. @@ -414,14 +442,17 @@ wait for VPN Connection to be created ``` USAGE - $ heroku spaces:vpn:wait + $ heroku spaces:vpn:wait [NAME] [-s ] [-n ] [--json] [-i ] [-t ] + +FLAGS + -i, --interval= seconds to wait between poll intervals + -n, --name= name or id of the vpn connection to wait for + -s, --space= space the vpn connection belongs to + -t, --timeout= maximum number of seconds to wait + --json output in json format -OPTIONS - -i, --interval=interval seconds to wait between poll intervals - -n, --name=name name or id of the vpn connection to wait for - -s, --space=space space the vpn connection belongs to - -t, --timeout=timeout maximum number of seconds to wait - --json output in json format +DESCRIPTION + wait for VPN Connection to be created ``` ## `heroku spaces:wait` @@ -430,13 +461,16 @@ wait for a space to be created ``` USAGE - $ heroku spaces:wait + $ heroku spaces:wait [SPACE] [-s ] [--json] [-i ] [-t ] + +FLAGS + -i, --interval= seconds to wait between poll intervals + -s, --space= space to get info of + -t, --timeout= maximum number of seconds to wait + --json output in json format -OPTIONS - -i, --interval=interval seconds to wait between poll intervals - -s, --space=space space to get info of - -t, --timeout=timeout maximum number of seconds to wait - --json output in json format +DESCRIPTION + wait for a space to be created ``` ## `heroku trusted-ips` @@ -445,13 +479,15 @@ list trusted IP ranges for a space ``` USAGE - $ heroku trusted-ips + $ heroku trusted-ips [SPACE] [-s ] [--json] -OPTIONS - -s, --space=space space to get inbound rules from - --json output in json format +FLAGS + -s, --space= space to get inbound rules from + --json output in json format DESCRIPTION + list trusted IP ranges for a space + Trusted IP ranges are only available on Private Spaces. The space name is a required parameter. Newly created spaces will have 0.0.0.0/0 set by default @@ -465,19 +501,21 @@ Add one range to the list of trusted IP ranges ``` USAGE - $ heroku trusted-ips:add SOURCE + $ heroku trusted-ips:add SOURCE [-s ] [--confirm ] -OPTIONS - -s, --space=space space to add rule to - --confirm=confirm set to space name to bypass confirm prompt +FLAGS + -s, --space= space to add rule to + --confirm= set to space name to bypass confirm prompt DESCRIPTION + Add one range to the list of trusted IP ranges + Uses CIDR notation. Example: - $ heroku trusted-ips:add --space my-space 192.168.2.0/24 - Added 192.168.0.1/24 to trusted IP ranges on my-space + $ heroku trusted-ips:add --space my-space 192.168.2.0/24 + Added 192.168.0.1/24 to trusted IP ranges on my-space ``` ## `heroku trusted-ips:remove SOURCE` @@ -486,18 +524,20 @@ Remove a range from the list of trusted IP ranges ``` USAGE - $ heroku trusted-ips:remove SOURCE + $ heroku trusted-ips:remove SOURCE --space [--confirm ] -OPTIONS - --confirm=confirm set to space name to bypass confirm prompt - --space=space (required) space to remove rule from +FLAGS + --confirm= set to space name to bypass confirm prompt + --space= (required) space to remove rule from DESCRIPTION + Remove a range from the list of trusted IP ranges + Uses CIDR notation. Example: - $ heroku trusted-ips:remove --space my-space 192.168.2.0/24 - Removed 192.168.2.0/24 from trusted IP ranges on my-space + $ heroku trusted-ips:remove --space my-space 192.168.2.0/24 + Removed 192.168.2.0/24 from trusted IP ranges on my-space ``` diff --git a/packages/spaces/package.json b/packages/spaces/package.json index e620737a54..aeaf85c43a 100644 --- a/packages/spaces/package.json +++ b/packages/spaces/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-spaces", "description": "Heroku plugin to manage Heroku Private Spaces", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Heroku", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/status/CHANGELOG.md b/packages/status/CHANGELOG.md index 83c3774119..db9a1d748b 100644 --- a/packages/status/CHANGELOG.md +++ b/packages/status/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/status/README.md b/packages/status/README.md index 74135c1cc4..31d659d433 100644 --- a/packages/status/README.md +++ b/packages/status/README.md @@ -58,8 +58,8 @@ $ npm install -g @heroku-cli/plugin-status $ npm install -g @heroku-cli/plugin-status $ @heroku-cli/plugin-status COMMAND running command... -$ @heroku-cli/plugin-status (-v|--version|version) -@heroku-cli/plugin-status/7.68.0 darwin-x64 node-v16.19.0 +$ @heroku-cli/plugin-status (--version|-v) +@heroku-cli/plugin-status/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ @heroku-cli/plugin-status --help [COMMAND] USAGE $ @heroku-cli/plugin-status COMMAND @@ -67,19 +67,5 @@ USAGE ``` -* [`@heroku-cli/plugin-status status`](#heroku-cliplugin-status-status) -## `@heroku-cli/plugin-status status` - -display current status of the Heroku platform - -``` -USAGE - $ @heroku-cli/plugin-status status - -OPTIONS - --json output in json format -``` - -_See code: [src/commands/status.ts](https://github.com/heroku/cli/blob/v7.68.0/packages/status/src/commands/status.ts)_ diff --git a/packages/status/package.json b/packages/status/package.json index 877251c173..4569517279 100644 --- a/packages/status/package.json +++ b/packages/status/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-status", "description": "CLI Plugin for Heroku Status", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Jeff Dickey @jdxcode", "bugs": "https://github.com/heroku/cli/issues", "cli-engine": { diff --git a/packages/webhooks/CHANGELOG.md b/packages/webhooks/CHANGELOG.md index baecc9fd6d..97ab8f0b5b 100644 --- a/packages/webhooks/CHANGELOG.md +++ b/packages/webhooks/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [8.0.2-beta.0](https://github.com/heroku/cli/compare/v7.69.1...v8.0.2-beta.0) (2023-03-15) + + +### Reverts + +* Revert "refactor: revert oclif upgrade (#2256)" ([c970fed](https://github.com/heroku/cli/commit/c970fed7c76ee613b935a0b7930ed327068bf627)), closes [#2256](https://github.com/heroku/cli/issues/2256) + + + + + # [7.68.0](https://github.com/heroku/cli/compare/v8.0.1...v7.68.0) (2023-02-06) diff --git a/packages/webhooks/README.md b/packages/webhooks/README.md index 54db632f92..430bcf9844 100644 --- a/packages/webhooks/README.md +++ b/packages/webhooks/README.md @@ -20,8 +20,8 @@ webhooks $ npm install -g @heroku-cli/plugin-webhooks $ heroku COMMAND running command... -$ heroku (-v|--version|version) -@heroku-cli/plugin-webhooks/7.68.0 darwin-x64 node-v16.19.0 +$ heroku (--version|-v) +@heroku-cli/plugin-webhooks/8.0.2-beta.0 darwin-arm64 node-v16.19.0 $ heroku --help [COMMAND] USAGE $ heroku COMMAND @@ -46,17 +46,20 @@ list webhooks on an app ``` USAGE - $ heroku webhooks + $ heroku webhooks [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + list webhooks on an app -EXAMPLE +EXAMPLES $ heroku webhooks ``` -_See code: [src/commands/webhooks/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/index.ts)_ +_See code: [src/commands/webhooks/index.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/index.ts)_ ## `heroku webhooks:add` @@ -64,22 +67,25 @@ add a webhook to an app ``` USAGE - $ heroku webhooks:add - -OPTIONS - -a, --app=app app to run command against - -i, --include=include (required) comma delimited event types your server will receive - -l, --level=level (required) notify does not retry, sync will retry until successful or timeout - -r, --remote=remote git remote of app to use - -s, --secret=secret value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header - -t, --authorization=authorization authoriation header to send with webhooks - -u, --url=url (required) URL for receiver - -EXAMPLE + $ heroku webhooks:add -i -l -u [-a ] [-r ] [-s ] [-t ] + +FLAGS + -a, --app= app to run command against + -i, --include= (required) comma delimited event types your server will receive + -l, --level= (required) notify does not retry, sync will retry until successful or timeout + -r, --remote= git remote of app to use + -s, --secret= value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header + -t, --authorization= authoriation header to send with webhooks + -u, --url= (required) URL for receiver + +DESCRIPTION + add a webhook to an app + +EXAMPLES $ heroku webhooks:add -i api:dyno -l notify -u https://example.com/hooks ``` -_See code: [src/commands/webhooks/add.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/add.ts)_ +_See code: [src/commands/webhooks/add.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/add.ts)_ ## `heroku webhooks:deliveries` @@ -87,18 +93,21 @@ list webhook deliveries on an app ``` USAGE - $ heroku webhooks:deliveries + $ heroku webhooks:deliveries [-a ] [-r ] [-s ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + -s, --status= filter deliveries by status -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use - -s, --status=status filter deliveries by status +DESCRIPTION + list webhook deliveries on an app -EXAMPLE +EXAMPLES $ heroku webhooks:deliveries ``` -_See code: [src/commands/webhooks/deliveries/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/deliveries/index.ts)_ +_See code: [src/commands/webhooks/deliveries/index.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/deliveries/index.ts)_ ## `heroku webhooks:deliveries:info ID` @@ -106,17 +115,20 @@ info for a webhook event on an app ``` USAGE - $ heroku webhooks:deliveries:info ID + $ heroku webhooks:deliveries:info ID [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -EXAMPLE +DESCRIPTION + info for a webhook event on an app + +EXAMPLES $ heroku webhooks:deliveries:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/deliveries/info.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/deliveries/info.ts)_ +_See code: [src/commands/webhooks/deliveries/info.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/deliveries/info.ts)_ ## `heroku webhooks:events` @@ -124,17 +136,20 @@ list webhook events on an app ``` USAGE - $ heroku webhooks:events + $ heroku webhooks:events [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -EXAMPLE +DESCRIPTION + list webhook events on an app + +EXAMPLES $ heroku webhooks:events ``` -_See code: [src/commands/webhooks/events/index.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/events/index.ts)_ +_See code: [src/commands/webhooks/events/index.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/events/index.ts)_ ## `heroku webhooks:events:info ID` @@ -142,17 +157,20 @@ info for a webhook event on an app ``` USAGE - $ heroku webhooks:events:info ID + $ heroku webhooks:events:info ID [-a ] [-r ] + +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +DESCRIPTION + info for a webhook event on an app -EXAMPLE +EXAMPLES $ heroku webhooks:events:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/events/info.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/events/info.ts)_ +_See code: [src/commands/webhooks/events/info.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/events/info.ts)_ ## `heroku webhooks:info ID` @@ -160,17 +178,20 @@ info for a webhook on an app ``` USAGE - $ heroku webhooks:info ID + $ heroku webhooks:info ID [-a ] [-r ] -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use -EXAMPLE +DESCRIPTION + info for a webhook on an app + +EXAMPLES $ heroku webhooks:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/info.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/info.ts)_ +_See code: [src/commands/webhooks/info.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/info.ts)_ ## `heroku webhooks:remove ID` @@ -178,20 +199,23 @@ removes a webhook from an app ``` USAGE - $ heroku webhooks:remove ID + $ heroku webhooks:remove ID [-a ] [-r ] ARGUMENTS ID id of webhook to remove -OPTIONS - -a, --app=app app to run command against - -r, --remote=remote git remote of app to use +FLAGS + -a, --app= app to run command against + -r, --remote= git remote of app to use + +DESCRIPTION + removes a webhook from an app -EXAMPLE +EXAMPLES $ heroku webhooks:remove 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/remove.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/remove.ts)_ +_See code: [src/commands/webhooks/remove.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/remove.ts)_ ## `heroku webhooks:update ID` @@ -199,21 +223,23 @@ updates a webhook in an app ``` USAGE - $ heroku webhooks:update ID + $ heroku webhooks:update ID -i -l -u [-a ] [-r ] [-s ] [-t ] + +FLAGS + -a, --app= app to run command against + -i, --include= (required) comma delimited event types your server will receive + -l, --level= (required) notify does not retry, sync will retry until successful or timeout + -r, --remote= git remote of app to use + -s, --secret= value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header + -t, --authorization= authoriation header to send with webhooks + -u, --url= (required) URL for receiver -OPTIONS - -a, --app=app app to run command against - -i, --include=include (required) comma delimited event types your server will receive - -l, --level=level (required) notify does not retry, sync will retry until successful or timeout - -r, --remote=remote git remote of app to use - -s, --secret=secret value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header - -t, --authorization=authorization authoriation header to send with webhooks - -u, --url=url (required) URL for receiver +DESCRIPTION + updates a webhook in an app -EXAMPLE - $ heroku webhooks:update 99999999-9999-9999-9999-999999999999 -i dyno -l notify -s - 09928c40bf1b191b645174a19f7053d16a180da37332e719ef0998f4c0a2 -u https://example.com/hooks +EXAMPLES + $ heroku webhooks:update 99999999-9999-9999-9999-999999999999 -i dyno -l notify -s 09928c40bf1b191b645174a19f7053d16a180da37332e719ef0998f4c0a2 -u https://example.com/hooks ``` -_See code: [src/commands/webhooks/update.ts](https://github.com/heroku/cli/blob/v7.68.0/src/commands/webhooks/update.ts)_ +_See code: [src/commands/webhooks/update.ts](https://github.com/heroku/cli/blob/v8.0.2-beta.0/src/commands/webhooks/update.ts)_ diff --git a/packages/webhooks/package.json b/packages/webhooks/package.json index 62f0424e04..69d26cab6b 100644 --- a/packages/webhooks/package.json +++ b/packages/webhooks/package.json @@ -1,7 +1,7 @@ { "name": "@heroku-cli/plugin-webhooks", "description": "Heroku CLI plugin to manage webhooks", - "version": "7.68.0", + "version": "8.0.2-beta.0", "author": "Chad Carbert @chadian", "bugs": "https://github.com/heroku/cli/issues", "dependencies": {