diff --git a/CHANGELOG.md b/CHANGELOG.md index cfedc6c425..eeff84103d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [9.4.0](https://github.com/heroku/cli/compare/v9.3.2...v9.4.0) (2024-11-11) + + +### Bug Fixes + +* access command error handling ([#3077](https://github.com/heroku/cli/issues/3077)) ([79188e5](https://github.com/heroku/cli/commit/79188e571b3b7cdbca85ce9012be92a93938dee3)) + + +### Features + +* **cli:** Adding disclaimer for plugin AI install ([#3065](https://github.com/heroku/cli/issues/3065)) ([80ab352](https://github.com/heroku/cli/commit/80ab352a5b68e96dba6d5a0ed900f6e1c166d98f)) + + + + + ## [9.3.2](https://github.com/heroku/cli/compare/v9.3.1...v9.3.2) (2024-10-23) **Note:** Version bump only for package heroku diff --git a/docs/access.md b/docs/access.md index 1248afc062..5583ce6dfa 100644 --- a/docs/access.md +++ b/docs/access.md @@ -25,7 +25,7 @@ DESCRIPTION list who has access to an app ``` -_See code: [src/commands/access/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/access/index.ts)_ +_See code: [src/commands/access/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/access/index.ts)_ ## `heroku access:add EMAIL` @@ -35,6 +35,9 @@ add new users to your app USAGE $ heroku access:add EMAIL -a [-r ] [-p ] +ARGUMENTS + EMAIL email address of the team member + FLAGS -a, --app= (required) app to run command against -p, --permissions= list of permissions comma separated @@ -49,7 +52,7 @@ EXAMPLES $ heroku access:add user@email.com --app APP --permissions deploy,manage,operate # permissions must be comma separated ``` -_See code: [src/commands/access/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/access/add.ts)_ +_See code: [src/commands/access/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/access/add.ts)_ ## `heroku access:remove` @@ -70,7 +73,7 @@ EXAMPLES $ heroku access:remove user@email.com --app APP ``` -_See code: [src/commands/access/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/access/remove.ts)_ +_See code: [src/commands/access/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/access/remove.ts)_ ## `heroku access:update EMAIL` @@ -80,6 +83,9 @@ update existing collaborators on an team app USAGE $ heroku access:update EMAIL -p -a [-r ] +ARGUMENTS + EMAIL email address of the team member + FLAGS -a, --app= (required) app to run command against -p, --permissions= (required) comma-delimited list of permissions to update (deploy,manage,operate) @@ -89,4 +95,4 @@ DESCRIPTION update existing collaborators on an team app ``` -_See code: [src/commands/access/update.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/access/update.ts)_ +_See code: [src/commands/access/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/access/update.ts)_ diff --git a/docs/addons.md b/docs/addons.md index e63ca2b4c2..5f829a943d 100644 --- a/docs/addons.md +++ b/docs/addons.md @@ -47,7 +47,7 @@ EXAMPLES $ heroku addons --app acme-inc-www ``` -_See code: [src/commands/addons/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/index.ts)_ +_See code: [src/commands/addons/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/index.ts)_ ## `heroku addons:attach ADDON_NAME` @@ -58,6 +58,9 @@ USAGE $ heroku addons:attach ADDON_NAME -a [--as ] [--credential ] [--confirm ] [-r ] +ARGUMENTS + ADDON_NAME unique identifier or globally unique name of the add-on + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -69,7 +72,7 @@ DESCRIPTION attach an existing add-on resource to an app ``` -_See code: [src/commands/addons/attach.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/attach.ts)_ +_See code: [src/commands/addons/attach.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/attach.ts)_ ## `heroku addons:create SERVICE:PLAN` @@ -80,6 +83,9 @@ USAGE $ heroku addons:create SERVICE:PLAN -a [--name ] [--as ] [--confirm ] [--wait] [-r ] +ARGUMENTS + SERVICE:PLAN unique identifier or unique name of the add-on service plan + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -101,7 +107,7 @@ EXAMPLES $heroku addons:create heroku-postgresql:standard-0 --app my-app -- --fork DATABASE ``` -_See code: [src/commands/addons/create.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/create.ts)_ +_See code: [src/commands/addons/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/create.ts)_ ## `heroku addons:destroy ADDONNAME` @@ -111,6 +117,9 @@ permanently destroy an add-on resource USAGE $ heroku addons:destroy ADDONNAME [-f] [-c ] [--wait] [-a ] [-r ] +ARGUMENTS + ADDONNAME unique identifier or globally unique name of the add-on + FLAGS -a, --app= app to run command against -c, --confirm= @@ -125,7 +134,7 @@ EXAMPLES addons:destroy [ADDON]... [flags] ``` -_See code: [src/commands/addons/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/destroy.ts)_ +_See code: [src/commands/addons/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/destroy.ts)_ ## `heroku addons:detach ATTACHMENT_NAME` @@ -135,6 +144,9 @@ detach an existing add-on resource from an app USAGE $ heroku addons:detach ATTACHMENT_NAME -a [-r ] +ARGUMENTS + ATTACHMENT_NAME unique identifier of the add-on attachment + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -143,7 +155,7 @@ DESCRIPTION detach an existing add-on resource from an app ``` -_See code: [src/commands/addons/detach.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/detach.ts)_ +_See code: [src/commands/addons/detach.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/detach.ts)_ ## `heroku addons:docs ADDON` @@ -153,6 +165,9 @@ open an add-on's Dev Center documentation in your browser USAGE $ heroku addons:docs ADDON [--show-url] [-a ] [-r ] +ARGUMENTS + ADDON unique identifier or globally unique name of the add-on + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -162,7 +177,7 @@ DESCRIPTION open an add-on's Dev Center documentation in your browser ``` -_See code: [src/commands/addons/docs.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/docs.ts)_ +_See code: [src/commands/addons/docs.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/docs.ts)_ ## `heroku addons:downgrade ADDON [PLAN]` @@ -172,6 +187,10 @@ change add-on plan. USAGE $ heroku addons:downgrade ADDON [PLAN] [-a ] [-r ] +ARGUMENTS + ADDON unique identifier or globally unique name of the add-on + PLAN unique identifier or name of the plan + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -204,6 +223,9 @@ show detailed add-on resource and attachment information USAGE $ heroku addons:info ADDON +ARGUMENTS + ADDON unique identifier or globally unique name of the add-on + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -212,7 +234,7 @@ DESCRIPTION show detailed add-on resource and attachment information ``` -_See code: [src/commands/addons/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/info.ts)_ +_See code: [src/commands/addons/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/info.ts)_ ## `heroku addons:open ADDON` @@ -222,6 +244,9 @@ open an add-on's dashboard in your browser USAGE $ heroku addons:open ADDON [--show-url] [-a ] [-r ] +ARGUMENTS + ADDON unique identifier or globally unique name of the add-on + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -231,7 +256,7 @@ DESCRIPTION open an add-on's dashboard in your browser ``` -_See code: [src/commands/addons/open.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/open.ts)_ +_See code: [src/commands/addons/open.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/open.ts)_ ## `heroku addons:plans SERVICE` @@ -241,6 +266,9 @@ list all available plans for an add-on service USAGE $ heroku addons:plans SERVICE [--json] +ARGUMENTS + SERVICE unique identifier or globally unique name of the add-on + FLAGS --json output in json format @@ -248,7 +276,7 @@ DESCRIPTION list all available plans for an add-on service ``` -_See code: [src/commands/addons/plans.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/plans.ts)_ +_See code: [src/commands/addons/plans.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/plans.ts)_ ## `heroku addons:rename ADDON_NAME NEW_NAME` @@ -258,11 +286,15 @@ rename an add-on USAGE $ heroku addons:rename ADDON_NAME NEW_NAME +ARGUMENTS + ADDON_NAME unique identifier or globally unique name of the add-on + NEW_NAME new globally unique name of the add-on + DESCRIPTION rename an add-on ``` -_See code: [src/commands/addons/rename.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/rename.ts)_ +_See code: [src/commands/addons/rename.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/rename.ts)_ ## `heroku addons:services` @@ -279,7 +311,7 @@ DESCRIPTION list all available add-on services ``` -_See code: [src/commands/addons/services.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/services.ts)_ +_See code: [src/commands/addons/services.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/services.ts)_ ## `heroku addons:upgrade ADDON [PLAN]` @@ -289,6 +321,10 @@ change add-on plan. USAGE $ heroku addons:upgrade ADDON [PLAN] [-a ] [-r ] +ARGUMENTS + ADDON unique identifier or globally unique name of the add-on + PLAN unique identifier or name of the plan + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -313,7 +349,7 @@ EXAMPLES $ heroku addons:upgrade swimming-briskly-123 heroku-redis:premium-2 ``` -_See code: [src/commands/addons/upgrade.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/upgrade.ts)_ +_See code: [src/commands/addons/upgrade.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/upgrade.ts)_ ## `heroku addons:wait [ADDON]` @@ -323,6 +359,9 @@ show provisioning status of the add-ons on the app USAGE $ heroku addons:wait [ADDON] [--wait-interval ] [-a ] [-r ] +ARGUMENTS + ADDON unique identifier or globally unique name of the add-on + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -332,4 +371,4 @@ DESCRIPTION show provisioning status of the add-ons on the app ``` -_See code: [src/commands/addons/wait.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/addons/wait.ts)_ +_See code: [src/commands/addons/wait.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/addons/wait.ts)_ diff --git a/docs/apps.md b/docs/apps.md index 9959003414..4020d295d7 100644 --- a/docs/apps.md +++ b/docs/apps.md @@ -43,7 +43,7 @@ EXAMPLES $ heroku apps ``` -_See code: [src/commands/apps/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/index.ts)_ +_See code: [src/commands/apps/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/index.ts)_ ## `heroku apps:create [APP]` @@ -89,7 +89,7 @@ EXAMPLES $ heroku apps:create --region eu ``` -_See code: [src/commands/apps/create.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/create.ts)_ +_See code: [src/commands/apps/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/create.ts)_ ## `heroku apps:destroy` @@ -108,7 +108,7 @@ DESCRIPTION permanently destroy an app ``` -_See code: [src/commands/apps/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/destroy.ts)_ +_See code: [src/commands/apps/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/destroy.ts)_ ## `heroku apps:errors` @@ -130,7 +130,7 @@ DESCRIPTION view app errors ``` -_See code: [src/commands/apps/errors.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/errors.ts)_ +_See code: [src/commands/apps/errors.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/errors.ts)_ ## `heroku apps:favorites` @@ -147,7 +147,7 @@ DESCRIPTION list favorited apps ``` -_See code: [src/commands/apps/favorites/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/favorites/index.ts)_ +_See code: [src/commands/apps/favorites/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/favorites/index.ts)_ ## `heroku apps:favorites:add` @@ -165,7 +165,7 @@ DESCRIPTION favorites an app ``` -_See code: [src/commands/apps/favorites/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/favorites/add.ts)_ +_See code: [src/commands/apps/favorites/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/favorites/add.ts)_ ## `heroku apps:favorites:remove` @@ -183,7 +183,7 @@ DESCRIPTION unfavorites an app ``` -_See code: [src/commands/apps/favorites/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/favorites/remove.ts)_ +_See code: [src/commands/apps/favorites/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/favorites/remove.ts)_ ## `heroku apps:info` @@ -208,7 +208,7 @@ EXAMPLES $ heroku apps:info --shell ``` -_See code: [src/commands/apps/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/info.ts)_ +_See code: [src/commands/apps/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/info.ts)_ ## `heroku apps:join` @@ -229,7 +229,7 @@ ALIASES $ heroku join ``` -_See code: [src/commands/apps/join.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/join.ts)_ +_See code: [src/commands/apps/join.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/join.ts)_ ## `heroku apps:leave` @@ -253,7 +253,7 @@ EXAMPLES $ heroku apps:leave -a APP ``` -_See code: [src/commands/apps/leave.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/leave.ts)_ +_See code: [src/commands/apps/leave.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/leave.ts)_ ## `heroku apps:lock` @@ -274,7 +274,7 @@ ALIASES $ heroku lock ``` -_See code: [src/commands/apps/lock.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/lock.ts)_ +_See code: [src/commands/apps/lock.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/lock.ts)_ ## `heroku apps:open [PATH]` @@ -284,6 +284,9 @@ open the app in a web browser USAGE $ heroku apps:open [PATH] -a [-r ] +ARGUMENTS + PATH base URL path of app + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -297,7 +300,7 @@ EXAMPLES $ heroku open -a myapp /foo ``` -_See code: [src/commands/apps/open.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/open.ts)_ +_See code: [src/commands/apps/open.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/open.ts)_ ## `heroku apps:rename NEWNAME` @@ -307,6 +310,9 @@ rename an app USAGE $ heroku apps:rename NEWNAME -a [-r ] +ARGUMENTS + NEWNAME new unique name of the app + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -318,7 +324,7 @@ EXAMPLES $ heroku apps:rename --app oldname newname ``` -_See code: [src/commands/apps/rename.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/rename.ts)_ +_See code: [src/commands/apps/rename.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/rename.ts)_ ## `heroku apps:stacks` @@ -336,7 +342,7 @@ DESCRIPTION show the list of available stacks ``` -_See code: [src/commands/apps/stacks/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/stacks/index.ts)_ +_See code: [src/commands/apps/stacks/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/stacks/index.ts)_ ## `heroku apps:stacks:set STACK` @@ -346,6 +352,9 @@ set the stack of an app USAGE $ heroku apps:stacks:set STACK -a [-r ] +ARGUMENTS + STACK unique name or identifier of the stack + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -360,7 +369,7 @@ EXAMPLES Run git push heroku main to trigger a new build on myapp. ``` -_See code: [src/commands/apps/stacks/set.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/stacks/set.ts)_ +_See code: [src/commands/apps/stacks/set.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/stacks/set.ts)_ ## `heroku apps:transfer RECIPIENT` @@ -391,7 +400,7 @@ EXAMPLES ... ``` -_See code: [src/commands/apps/transfer.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/transfer.ts)_ +_See code: [src/commands/apps/transfer.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/transfer.ts)_ ## `heroku apps:unlock` @@ -412,4 +421,4 @@ ALIASES $ heroku unlock ``` -_See code: [src/commands/apps/unlock.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/apps/unlock.ts)_ +_See code: [src/commands/apps/unlock.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/apps/unlock.ts)_ diff --git a/docs/auth.md b/docs/auth.md index 6711bf0310..84c5dd68e8 100644 --- a/docs/auth.md +++ b/docs/auth.md @@ -26,7 +26,7 @@ ALIASES $ heroku twofactor ``` -_See code: [src/commands/auth/2fa/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/auth/2fa/index.ts)_ +_See code: [src/commands/auth/2fa/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/auth/2fa/index.ts)_ ## `heroku auth:2fa:disable` @@ -47,7 +47,7 @@ EXAMPLES $ heroku auth:2fa:disable ``` -_See code: [src/commands/auth/2fa/disable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/auth/2fa/disable.ts)_ +_See code: [src/commands/auth/2fa/disable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/auth/2fa/disable.ts)_ ## `heroku auth:login` @@ -69,7 +69,7 @@ ALIASES $ heroku login ``` -_See code: [src/commands/auth/login.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/auth/login.ts)_ +_See code: [src/commands/auth/login.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/auth/login.ts)_ ## `heroku auth:logout` @@ -86,7 +86,7 @@ ALIASES $ heroku logout ``` -_See code: [src/commands/auth/logout.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/auth/logout.ts)_ +_See code: [src/commands/auth/logout.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/auth/logout.ts)_ ## `heroku auth:token` @@ -105,7 +105,7 @@ DESCRIPTION authorizations:create ``` -_See code: [src/commands/auth/token.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/auth/token.ts)_ +_See code: [src/commands/auth/token.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/auth/token.ts)_ ## `heroku auth:whoami` @@ -122,4 +122,4 @@ ALIASES $ heroku whoami ``` -_See code: [src/commands/auth/whoami.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/auth/whoami.ts)_ +_See code: [src/commands/auth/whoami.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/auth/whoami.ts)_ diff --git a/docs/authorizations.md b/docs/authorizations.md index 6b295c1e84..e77b105418 100644 --- a/docs/authorizations.md +++ b/docs/authorizations.md @@ -29,7 +29,7 @@ EXAMPLES $ heroku authorizations ``` -_See code: [src/commands/authorizations/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/authorizations/index.ts)_ +_See code: [src/commands/authorizations/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/authorizations/index.ts)_ ## `heroku authorizations:create` @@ -53,7 +53,7 @@ EXAMPLES $ heroku authorizations:create --description "For use with Anvil" ``` -_See code: [src/commands/authorizations/create.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/authorizations/create.ts)_ +_See code: [src/commands/authorizations/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/authorizations/create.ts)_ ## `heroku authorizations:destroy ID` @@ -63,6 +63,9 @@ revoke OAuth authorization USAGE $ heroku authorizations:destroy ID +ARGUMENTS + ID ID of the authorization + DESCRIPTION revoke OAuth authorization @@ -82,6 +85,9 @@ show an existing OAuth authorization USAGE $ heroku authorizations:info ID [-j] +ARGUMENTS + ID ID of the authorization + FLAGS -j, --json output in json format @@ -89,7 +95,7 @@ DESCRIPTION show an existing OAuth authorization ``` -_See code: [src/commands/authorizations/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/authorizations/info.ts)_ +_See code: [src/commands/authorizations/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/authorizations/info.ts)_ ## `heroku authorizations:revoke ID` @@ -99,6 +105,9 @@ revoke OAuth authorization USAGE $ heroku authorizations:revoke ID +ARGUMENTS + ID ID of the authorization + DESCRIPTION revoke OAuth authorization @@ -110,7 +119,7 @@ EXAMPLES $ heroku authorizations:revoke 105a7bfa-34c3-476e-873a-b1ac3fdc12fb ``` -_See code: [src/commands/authorizations/revoke.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/authorizations/revoke.ts)_ +_See code: [src/commands/authorizations/revoke.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/authorizations/revoke.ts)_ ## `heroku authorizations:rotate ID` @@ -120,11 +129,14 @@ updates an OAuth authorization token USAGE $ heroku authorizations:rotate ID +ARGUMENTS + ID ID of the authorization + DESCRIPTION updates an OAuth authorization token ``` -_See code: [src/commands/authorizations/rotate.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/authorizations/rotate.ts)_ +_See code: [src/commands/authorizations/rotate.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/authorizations/rotate.ts)_ ## `heroku authorizations:update ID` @@ -134,6 +146,9 @@ updates an OAuth authorization USAGE $ heroku authorizations:update ID [-d ] [--client-id --client-secret ] +ARGUMENTS + ID ID of the authorization + FLAGS -d, --description= set a custom authorization description --client-id= identifier of OAuth client to set @@ -143,4 +158,4 @@ DESCRIPTION updates an OAuth authorization ``` -_See code: [src/commands/authorizations/update.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/authorizations/update.ts)_ +_See code: [src/commands/authorizations/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/authorizations/update.ts)_ diff --git a/docs/autocomplete.md b/docs/autocomplete.md index 6082d04f6e..88748ccfb8 100644 --- a/docs/autocomplete.md +++ b/docs/autocomplete.md @@ -32,4 +32,4 @@ EXAMPLES $ heroku autocomplete --refresh-cache ``` -_See code: [src/commands/autocomplete/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/autocomplete/index.ts)_ +_See code: [src/commands/autocomplete/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/autocomplete/index.ts)_ diff --git a/docs/buildpacks.md b/docs/buildpacks.md index 79a53475a6..7bdb58f008 100644 --- a/docs/buildpacks.md +++ b/docs/buildpacks.md @@ -28,7 +28,7 @@ DESCRIPTION display the buildpacks for an app ``` -_See code: [src/commands/buildpacks/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/index.ts)_ +_See code: [src/commands/buildpacks/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/index.ts)_ ## `heroku buildpacks:add BUILDPACK` @@ -50,7 +50,7 @@ DESCRIPTION add new app buildpack, inserting into list of buildpacks if necessary ``` -_See code: [src/commands/buildpacks/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/add.ts)_ +_See code: [src/commands/buildpacks/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/add.ts)_ ## `heroku buildpacks:clear` @@ -68,7 +68,7 @@ DESCRIPTION clear all buildpacks set on the app ``` -_See code: [src/commands/buildpacks/clear.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/clear.ts)_ +_See code: [src/commands/buildpacks/clear.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/clear.ts)_ ## `heroku buildpacks:info BUILDPACK` @@ -85,7 +85,7 @@ DESCRIPTION fetch info about a buildpack ``` -_See code: [src/commands/buildpacks/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/info.ts)_ +_See code: [src/commands/buildpacks/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/info.ts)_ ## `heroku buildpacks:remove [BUILDPACK]` @@ -107,7 +107,7 @@ DESCRIPTION remove a buildpack set on the app ``` -_See code: [src/commands/buildpacks/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/remove.ts)_ +_See code: [src/commands/buildpacks/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/remove.ts)_ ## `heroku buildpacks:search [TERM]` @@ -129,7 +129,7 @@ DESCRIPTION search for buildpacks ``` -_See code: [src/commands/buildpacks/search.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/search.ts)_ +_See code: [src/commands/buildpacks/search.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/search.ts)_ ## `heroku buildpacks:set BUILDPACK` @@ -146,7 +146,7 @@ FLAGS -r, --remote= git remote of app to use ``` -_See code: [src/commands/buildpacks/set.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/set.ts)_ +_See code: [src/commands/buildpacks/set.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/set.ts)_ ## `heroku buildpacks:versions BUILDPACK` @@ -163,4 +163,4 @@ DESCRIPTION list versions of a buildpack ``` -_See code: [src/commands/buildpacks/versions.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/buildpacks/versions.ts)_ +_See code: [src/commands/buildpacks/versions.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/buildpacks/versions.ts)_ diff --git a/docs/certs.md b/docs/certs.md index 17ba2886d4..0ffacd331b 100644 --- a/docs/certs.md +++ b/docs/certs.md @@ -30,7 +30,7 @@ DESCRIPTION list SSL certificates for an app ``` -_See code: [src/commands/certs/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/index.ts)_ +_See code: [src/commands/certs/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/index.ts)_ ## `heroku certs:add CRT KEY` @@ -40,6 +40,10 @@ Add an SSL certificate to an app. USAGE $ heroku certs:add CRT KEY -a [-r ] +ARGUMENTS + CRT absolute path of the certificate file on disk + KEY absolute path of the key file on disk + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -56,7 +60,7 @@ EXAMPLES https://help.salesforce.com/s/articleView?id=000333504&type=1 ``` -_See code: [src/commands/certs/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/add.ts)_ +_See code: [src/commands/certs/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/add.ts)_ ## `heroku certs:auto` @@ -75,7 +79,7 @@ DESCRIPTION show ACM status for an app ``` -_See code: [src/commands/certs/auto/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/auto/index.ts)_ +_See code: [src/commands/certs/auto/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/auto/index.ts)_ ## `heroku certs:auto:disable` @@ -93,7 +97,7 @@ DESCRIPTION disable ACM for an app ``` -_See code: [src/commands/certs/auto/disable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/auto/disable.ts)_ +_See code: [src/commands/certs/auto/disable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/auto/disable.ts)_ ## `heroku certs:auto:enable` @@ -112,7 +116,7 @@ DESCRIPTION enable ACM status for an app ``` -_See code: [src/commands/certs/auto/enable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/auto/enable.ts)_ +_See code: [src/commands/certs/auto/enable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/auto/enable.ts)_ ## `heroku certs:auto:refresh` @@ -130,7 +134,7 @@ DESCRIPTION refresh ACM for an app ``` -_See code: [src/commands/certs/auto/refresh.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/auto/refresh.ts)_ +_See code: [src/commands/certs/auto/refresh.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/auto/refresh.ts)_ ## `heroku certs:generate DOMAIN` @@ -141,6 +145,9 @@ USAGE $ heroku certs:generate DOMAIN -a [--selfsigned] [--keysize ] [--owner ] [--country ] [--area ] [--city ] [--subject ] [--now] [-r ] +ARGUMENTS + DOMAIN domain name to generate + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -157,7 +164,7 @@ DESCRIPTION generate a key and a CSR or self-signed certificate ``` -_See code: [src/commands/certs/generate.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/generate.ts)_ +_See code: [src/commands/certs/generate.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/generate.ts)_ ## `heroku certs:info` @@ -178,7 +185,7 @@ DESCRIPTION show certificate information for an SSL certificate ``` -_See code: [src/commands/certs/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/info.ts)_ +_See code: [src/commands/certs/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/info.ts)_ ## `heroku certs:remove` @@ -198,7 +205,7 @@ DESCRIPTION remove an SSL certificate from an app ``` -_See code: [src/commands/certs/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/remove.ts)_ +_See code: [src/commands/certs/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/remove.ts)_ ## `heroku certs:update CRT KEY` @@ -208,6 +215,10 @@ update an SSL certificate on an app USAGE $ heroku certs:update CRT KEY -a [--name ] [--endpoint ] [-r ] +ARGUMENTS + CRT absolute path of the certificate file on disk + KEY absolute path of the key file on disk + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -225,4 +236,4 @@ EXAMPLES https://help.salesforce.com/s/articleView?id=000333504&type=1 ``` -_See code: [src/commands/certs/update.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/certs/update.ts)_ +_See code: [src/commands/certs/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/certs/update.ts)_ diff --git a/docs/ci.md b/docs/ci.md index bccc0aedb9..0d807b6c3f 100644 --- a/docs/ci.md +++ b/docs/ci.md @@ -38,7 +38,7 @@ EXAMPLES $ heroku ci --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/index.ts)_ +_See code: [src/commands/ci/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/index.ts)_ ## `heroku ci:config` @@ -62,7 +62,7 @@ EXAMPLES $ heroku ci:config --app murmuring-headland-14719 --json ``` -_See code: [src/commands/ci/config/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/config/index.ts)_ +_See code: [src/commands/ci/config/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/config/index.ts)_ ## `heroku ci:config:get KEY` @@ -72,6 +72,9 @@ get a CI config var USAGE $ heroku ci:config:get KEY [-h] [-a ] [-r ] [-p ] [-s] +ARGUMENTS + KEY name of the config var key + FLAGS -a, --app= app to run command against -h, --help Show CLI help. @@ -87,7 +90,7 @@ EXAMPLES test ``` -_See code: [src/commands/ci/config/get.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/config/get.ts)_ +_See code: [src/commands/ci/config/get.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/config/get.ts)_ ## `heroku ci:config:set` @@ -111,7 +114,7 @@ EXAMPLES RAILS_ENV: test ``` -_See code: [src/commands/ci/config/set.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/config/set.ts)_ +_See code: [src/commands/ci/config/set.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/config/set.ts)_ ## `heroku ci:config:unset` @@ -133,7 +136,7 @@ EXAMPLES $ heroku ci:config:unset RAILS_ENV ``` -_See code: [src/commands/ci/config/unset.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/config/unset.ts)_ +_See code: [src/commands/ci/config/unset.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/config/unset.ts)_ ## `heroku ci:debug` @@ -153,7 +156,7 @@ DESCRIPTION opens an interactive test debugging session with the contents of the current directory ``` -_See code: [src/commands/ci/debug.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/debug.ts)_ +_See code: [src/commands/ci/debug.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/debug.ts)_ ## `heroku ci:info TEST-RUN` @@ -163,6 +166,9 @@ show the status of a specific test run USAGE $ heroku ci:info TEST-RUN [-a ] [-r ] [--node ] [-p ] +ARGUMENTS + TEST-RUN auto-incremented test run number + FLAGS -a, --app= app to run command against -p, --pipeline= name of pipeline @@ -176,7 +182,7 @@ EXAMPLES $ heroku ci:info 1288 --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/info.ts)_ +_See code: [src/commands/ci/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/info.ts)_ ## `heroku ci:last` @@ -199,7 +205,7 @@ EXAMPLES $ heroku ci:last --pipeline=my-pipeline --node 100 ``` -_See code: [src/commands/ci/last.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/last.ts)_ +_See code: [src/commands/ci/last.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/last.ts)_ ## `heroku ci:migrate-manifest` @@ -216,7 +222,7 @@ EXAMPLES $ heroku ci:migrate-manifest ``` -_See code: [src/commands/ci/migrate-manifest.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/migrate-manifest.ts)_ +_See code: [src/commands/ci/migrate-manifest.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/migrate-manifest.ts)_ ## `heroku ci:open` @@ -239,7 +245,7 @@ EXAMPLES $ heroku ci:open --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/open.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/open.ts)_ +_See code: [src/commands/ci/open.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/open.ts)_ ## `heroku ci:rerun [NUMBER]` @@ -249,6 +255,9 @@ rerun tests against current directory USAGE $ heroku ci:rerun [NUMBER] [-a ] [-r ] [-p ] +ARGUMENTS + NUMBER auto-incremented test run number + FLAGS -a, --app= app to run command against -p, --pipeline= name of pipeline @@ -261,7 +270,7 @@ EXAMPLES $ heroku ci:rerun 985 --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/rerun.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/rerun.ts)_ +_See code: [src/commands/ci/rerun.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/rerun.ts)_ ## `heroku ci:run` @@ -283,4 +292,4 @@ EXAMPLES $ heroku ci:run --app murmuring-headland-14719 ``` -_See code: [src/commands/ci/run.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ci/run.ts)_ +_See code: [src/commands/ci/run.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ci/run.ts)_ diff --git a/docs/clients.md b/docs/clients.md index f05b1eff80..a9925bb90f 100644 --- a/docs/clients.md +++ b/docs/clients.md @@ -25,7 +25,7 @@ DESCRIPTION list your OAuth clients ``` -_See code: [src/commands/clients/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/clients/index.ts)_ +_See code: [src/commands/clients/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/clients/index.ts)_ ## `heroku clients:create NAME REDIRECT_URI` @@ -35,6 +35,10 @@ create a new OAuth client USAGE $ heroku clients:create NAME REDIRECT_URI [-j] [-s] +ARGUMENTS + NAME name of the OAuth client + REDIRECT_URI redirect URL of the OAuth client + FLAGS -j, --json output in json format -s, --shell output in shell format @@ -46,7 +50,7 @@ EXAMPLES $ 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/v9.3.2/packages/cli/src/commands/clients/create.ts)_ +_See code: [src/commands/clients/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/clients/create.ts)_ ## `heroku clients:destroy ID` @@ -56,11 +60,14 @@ delete client by ID USAGE $ heroku clients:destroy ID +ARGUMENTS + ID ID of the OAuth client + DESCRIPTION delete client by ID ``` -_See code: [src/commands/clients/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/clients/destroy.ts)_ +_See code: [src/commands/clients/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/clients/destroy.ts)_ ## `heroku clients:info ID` @@ -70,6 +77,9 @@ show details of an oauth client USAGE $ heroku clients:info ID [-j] [-s] +ARGUMENTS + ID ID of the OAuth client + FLAGS -j, --json output in json format -s, --shell output in shell format @@ -81,7 +91,7 @@ EXAMPLES $ heroku clients:info 36120128-fee7-455e-8b7f-807aee130946 ``` -_See code: [src/commands/clients/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/clients/info.ts)_ +_See code: [src/commands/clients/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/clients/info.ts)_ ## `heroku clients:rotate ID` @@ -91,6 +101,9 @@ rotate OAuth client secret USAGE $ heroku clients:rotate ID [-j] [-s] +ARGUMENTS + ID ID of the OAuth client + FLAGS -j, --json output in json format -s, --shell output in shell format @@ -99,7 +112,7 @@ DESCRIPTION rotate OAuth client secret ``` -_See code: [src/commands/clients/rotate.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/clients/rotate.ts)_ +_See code: [src/commands/clients/rotate.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/clients/rotate.ts)_ ## `heroku clients:update ID` @@ -109,6 +122,9 @@ update OAuth client USAGE $ heroku clients:update ID [-n ] [--url ] +ARGUMENTS + ID ID of the OAuth client + FLAGS -n, --name= change the client name --url= change the client redirect URL @@ -120,4 +136,4 @@ EXAMPLES $ 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/v9.3.2/packages/cli/src/commands/clients/update.ts)_ +_See code: [src/commands/clients/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/clients/update.ts)_ diff --git a/docs/config.md b/docs/config.md index 967ce3d1d3..99d5035e84 100644 --- a/docs/config.md +++ b/docs/config.md @@ -28,7 +28,7 @@ DESCRIPTION display the config vars for an app ``` -_See code: [src/commands/config/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/config/index.ts)_ ## `heroku config:edit [KEY]` @@ -64,7 +64,7 @@ EXAMPLES $ VISUAL="atom --wait" heroku config:edit ``` -_See code: [src/commands/config/edit.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/config/edit.ts)_ +_See code: [src/commands/config/edit.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/config/edit.ts)_ ## `heroku config:get KEY...` @@ -74,6 +74,9 @@ display a single config value for an app USAGE $ heroku config:get KEY... +ARGUMENTS + KEY key name of the config var value + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -87,7 +90,7 @@ EXAMPLES production ``` -_See code: [src/commands/config/get.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/config/get.ts)_ +_See code: [src/commands/config/get.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/config/get.ts)_ ## `heroku config:remove` @@ -140,7 +143,7 @@ EXAMPLES RACK_ENV: staging ``` -_See code: [src/commands/config/set.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/config/set.ts)_ +_See code: [src/commands/config/set.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/config/set.ts)_ ## `heroku config:unset` @@ -168,4 +171,4 @@ EXAMPLES Unsetting RAILS_ENV, RACK_ENV and restarting example... done, v10 ``` -_See code: [src/commands/config/unset.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/config/unset.ts)_ +_See code: [src/commands/config/unset.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/config/unset.ts)_ diff --git a/docs/container.md b/docs/container.md index 8acd494be7..999c93c610 100644 --- a/docs/container.md +++ b/docs/container.md @@ -24,7 +24,7 @@ DESCRIPTION Use containers to build and deploy Heroku apps ``` -_See code: [src/commands/container/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/index.ts)_ +_See code: [src/commands/container/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/index.ts)_ ## `heroku container:login` @@ -41,7 +41,7 @@ DESCRIPTION log in to Heroku Container Registry ``` -_See code: [src/commands/container/login.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/login.ts)_ +_See code: [src/commands/container/login.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/login.ts)_ ## `heroku container:logout` @@ -58,7 +58,7 @@ DESCRIPTION log out from Heroku Container Registry ``` -_See code: [src/commands/container/logout.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/logout.ts)_ +_See code: [src/commands/container/logout.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/logout.ts)_ ## `heroku container:pull -a APP [-v] PROCESS_TYPE...` @@ -82,7 +82,7 @@ EXAMPLES $ heroku container:pull web:latest # Pulls the latest tag from the web image ``` -_See code: [src/commands/container/pull.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/pull.ts)_ +_See code: [src/commands/container/pull.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/pull.ts)_ ## `heroku container:push` @@ -117,7 +117,7 @@ EXAMPLES $ heroku container:push --recursive --context-path . # Pushes Dockerfile.* using current dir as build context ``` -_See code: [src/commands/container/push.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/push.ts)_ +_See code: [src/commands/container/push.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/push.ts)_ ## `heroku container:release` @@ -140,7 +140,7 @@ EXAMPLES heroku container:release web worker # Releases the previously pushed web and worker process types ``` -_See code: [src/commands/container/release.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/release.ts)_ +_See code: [src/commands/container/release.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/release.ts)_ ## `heroku container:rm -a APP [-v] PROCESS_TYPE...` @@ -162,7 +162,7 @@ EXAMPLES heroku container:rm web worker # Destroys the web and worker containers ``` -_See code: [src/commands/container/rm.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/rm.ts)_ +_See code: [src/commands/container/rm.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/rm.ts)_ ## `heroku container:run -a APP [-v] PROCESS_TYPE...` @@ -187,4 +187,4 @@ EXAMPLES $ heroku container:pull web:latest # Pulls the latest tag from the web image ``` -_See code: [src/commands/container/run.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/container/run.ts)_ +_See code: [src/commands/container/run.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/container/run.ts)_ diff --git a/docs/domains.md b/docs/domains.md index 342565b304..f8abc62f9d 100644 --- a/docs/domains.md +++ b/docs/domains.md @@ -48,7 +48,7 @@ EXAMPLES $ heroku domains --filter 'Domain Name=www.example.com' ``` -_See code: [src/commands/domains/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/domains/index.ts)_ +_See code: [src/commands/domains/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/domains/index.ts)_ ## `heroku domains:add HOSTNAME` @@ -58,6 +58,9 @@ add a domain to an app USAGE $ heroku domains:add HOSTNAME -a [-h] [-c ] [-j] [--wait] [-r ] +ARGUMENTS + HOSTNAME unique identifier of the domain or full hostname + FLAGS -a, --app= (required) app to run command against -c, --cert= the name of the SSL cert you want to use for this domain @@ -73,7 +76,7 @@ EXAMPLES $ heroku domains:add www.example.com ``` -_See code: [src/commands/domains/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/domains/add.ts)_ +_See code: [src/commands/domains/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/domains/add.ts)_ ## `heroku domains:clear` @@ -95,7 +98,7 @@ EXAMPLES $ heroku domains:clear ``` -_See code: [src/commands/domains/clear.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/domains/clear.ts)_ +_See code: [src/commands/domains/clear.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/domains/clear.ts)_ ## `heroku domains:info HOSTNAME` @@ -105,6 +108,9 @@ show detailed information for a domain on an app USAGE $ heroku domains:info HOSTNAME -a [-h] [-r ] +ARGUMENTS + HOSTNAME unique identifier of the domain or full hostname + FLAGS -a, --app= (required) app to run command against -h, --help Show CLI help. @@ -117,7 +123,7 @@ EXAMPLES $ heroku domains:info www.example.com ``` -_See code: [src/commands/domains/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/domains/info.ts)_ +_See code: [src/commands/domains/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/domains/info.ts)_ ## `heroku domains:remove HOSTNAME` @@ -127,6 +133,9 @@ remove a domain from an app USAGE $ heroku domains:remove HOSTNAME -a [-h] [-r ] +ARGUMENTS + HOSTNAME unique identifier of the domain or full hostname + FLAGS -a, --app= (required) app to run command against -h, --help Show CLI help. @@ -139,7 +148,7 @@ EXAMPLES $ heroku domains:remove www.example.com ``` -_See code: [src/commands/domains/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/domains/remove.ts)_ +_See code: [src/commands/domains/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/domains/remove.ts)_ ## `heroku domains:update HOSTNAME` @@ -149,6 +158,9 @@ update a domain to use a different SSL certificate on an app USAGE $ heroku domains:update HOSTNAME -a --cert [-h] [-r ] +ARGUMENTS + HOSTNAME unique identifier of the domain or full hostname + FLAGS -a, --app= (required) app to run command against -h, --help Show CLI help. @@ -162,7 +174,7 @@ EXAMPLES $ heroku domains:update www.example.com --cert mycert ``` -_See code: [src/commands/domains/update.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/domains/update.ts)_ +_See code: [src/commands/domains/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/domains/update.ts)_ ## `heroku domains:wait [HOSTNAME]` @@ -172,6 +184,9 @@ wait for domain to be active for an app USAGE $ heroku domains:wait [HOSTNAME] -a [-h] [-r ] +ARGUMENTS + HOSTNAME unique identifier of the domain or full hostname + FLAGS -a, --app= (required) app to run command against -h, --help Show CLI help. @@ -181,4 +196,4 @@ DESCRIPTION wait for domain to be active for an app ``` -_See code: [src/commands/domains/wait.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/domains/wait.ts)_ +_See code: [src/commands/domains/wait.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/domains/wait.ts)_ diff --git a/docs/drains.md b/docs/drains.md index 0e24df73e9..374b5e9169 100644 --- a/docs/drains.md +++ b/docs/drains.md @@ -26,7 +26,7 @@ DESCRIPTION display the log drains of an app ``` -_See code: [src/commands/drains/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/drains/index.ts)_ +_See code: [src/commands/drains/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/drains/index.ts)_ ## `heroku drains:add URL` @@ -36,6 +36,9 @@ adds a log drain to an app USAGE $ heroku drains:add URL -a [-r ] +ARGUMENTS + URL URL of the log drain + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -44,7 +47,7 @@ DESCRIPTION adds a log drain to an app ``` -_See code: [src/commands/drains/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/drains/add.ts)_ +_See code: [src/commands/drains/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/drains/add.ts)_ ## `heroku drains:get` @@ -73,6 +76,9 @@ removes a log drain from an app USAGE $ heroku drains:remove URL -a [-r ] +ARGUMENTS + URL URL of the log drain + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -84,7 +90,7 @@ EXAMPLES drains:remove [URL|TOKEN] ``` -_See code: [src/commands/drains/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/drains/remove.ts)_ +_See code: [src/commands/drains/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/drains/remove.ts)_ ## `heroku drains:set URL` @@ -94,6 +100,9 @@ replaces the log drain for a space USAGE $ heroku drains:set URL -s +ARGUMENTS + URL URL to replace the log drain with + FLAGS -s, --space= (required) space for which to set log drain diff --git a/docs/features.md b/docs/features.md index 8a23e85540..45391d6f48 100644 --- a/docs/features.md +++ b/docs/features.md @@ -25,7 +25,7 @@ DESCRIPTION list available app features ``` -_See code: [src/commands/features/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/features/index.ts)_ +_See code: [src/commands/features/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/features/index.ts)_ ## `heroku features:disable FEATURE` @@ -35,6 +35,9 @@ disables an app feature USAGE $ heroku features:disable FEATURE -a [-r ] +ARGUMENTS + FEATURE unique identifier or name of the app feature + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -43,7 +46,7 @@ DESCRIPTION disables an app feature ``` -_See code: [src/commands/features/disable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/features/disable.ts)_ +_See code: [src/commands/features/disable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/features/disable.ts)_ ## `heroku features:enable FEATURE` @@ -53,6 +56,9 @@ enables an app feature USAGE $ heroku features:enable FEATURE -a [-r ] +ARGUMENTS + FEATURE unique identifier or name of the app feature + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -61,7 +67,7 @@ DESCRIPTION enables an app feature ``` -_See code: [src/commands/features/enable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/features/enable.ts)_ +_See code: [src/commands/features/enable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/features/enable.ts)_ ## `heroku features:info FEATURE` @@ -71,6 +77,9 @@ display information about a feature USAGE $ heroku features:info FEATURE -a [-r ] [--json] +ARGUMENTS + FEATURE unique identifier or name of the app feature + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -80,4 +89,4 @@ DESCRIPTION display information about a feature ``` -_See code: [src/commands/features/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/features/info.ts)_ +_See code: [src/commands/features/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/features/info.ts)_ diff --git a/docs/git.md b/docs/git.md index 66422406b1..85ad4d5624 100644 --- a/docs/git.md +++ b/docs/git.md @@ -31,7 +31,7 @@ EXAMPLES ... ``` -_See code: [src/commands/git/clone.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/git/clone.ts)_ +_See code: [src/commands/git/clone.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/git/clone.ts)_ ## `heroku git:remote` @@ -57,4 +57,4 @@ EXAMPLES $ heroku git:remote --remote heroku-staging -a example ``` -_See code: [src/commands/git/remote.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/git/remote.ts)_ +_See code: [src/commands/git/remote.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/git/remote.ts)_ diff --git a/docs/keys.md b/docs/keys.md index 9120df611f..f880952582 100644 --- a/docs/keys.md +++ b/docs/keys.md @@ -24,7 +24,7 @@ DESCRIPTION display your SSH keys ``` -_See code: [src/commands/keys/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/keys/index.ts)_ +_See code: [src/commands/keys/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/keys/index.ts)_ ## `heroku keys:add [KEY]` @@ -34,6 +34,9 @@ add an SSH key for a user USAGE $ heroku keys:add [KEY] [-y] +ARGUMENTS + KEY absolute path to the key located on disk. If omitted, we use the default rsa key. + FLAGS -y, --yes automatically answer yes for all prompts @@ -50,7 +53,7 @@ EXAMPLES Uploading SSH public key /my/key.pub... done ``` -_See code: [src/commands/keys/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/keys/add.ts)_ +_See code: [src/commands/keys/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/keys/add.ts)_ ## `heroku keys:clear` @@ -64,7 +67,7 @@ DESCRIPTION remove all SSH keys for current user ``` -_See code: [src/commands/keys/clear.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/keys/clear.ts)_ +_See code: [src/commands/keys/clear.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/keys/clear.ts)_ ## `heroku keys:remove KEY` @@ -74,6 +77,9 @@ remove an SSH key from the user USAGE $ heroku keys:remove KEY +ARGUMENTS + KEY email address of the user + DESCRIPTION remove an SSH key from the user @@ -82,4 +88,4 @@ EXAMPLES Removing email@example.com SSH key... done ``` -_See code: [src/commands/keys/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/keys/remove.ts)_ +_See code: [src/commands/keys/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/keys/remove.ts)_ diff --git a/docs/labs.md b/docs/labs.md index ea2fe47ee5..9ba96e875b 100644 --- a/docs/labs.md +++ b/docs/labs.md @@ -25,7 +25,7 @@ DESCRIPTION list experimental features ``` -_See code: [src/commands/labs/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/labs/index.ts)_ +_See code: [src/commands/labs/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/labs/index.ts)_ ## `heroku labs:disable FEATURE` @@ -35,6 +35,9 @@ disables an experimental feature USAGE $ heroku labs:disable FEATURE [-a ] [-r ] [--confirm ] +ARGUMENTS + FEATURE unique identifier or name of the account feature + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -44,7 +47,7 @@ DESCRIPTION disables an experimental feature ``` -_See code: [src/commands/labs/disable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/labs/disable.ts)_ +_See code: [src/commands/labs/disable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/labs/disable.ts)_ ## `heroku labs:enable FEATURE` @@ -54,6 +57,9 @@ enables an experimental feature USAGE $ heroku labs:enable FEATURE [-a ] [-r ] +ARGUMENTS + FEATURE unique identifier or name of the account feature + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -62,7 +68,7 @@ DESCRIPTION enables an experimental feature ``` -_See code: [src/commands/labs/enable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/labs/enable.ts)_ +_See code: [src/commands/labs/enable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/labs/enable.ts)_ ## `heroku labs:info FEATURE` @@ -72,6 +78,9 @@ show feature info USAGE $ heroku labs:info FEATURE [-a ] [-r ] [--json] +ARGUMENTS + FEATURE unique identifier or name of the account feature + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -81,4 +90,4 @@ DESCRIPTION show feature info ``` -_See code: [src/commands/labs/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/labs/info.ts)_ +_See code: [src/commands/labs/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/labs/info.ts)_ diff --git a/docs/local.md b/docs/local.md index 98b3269b86..ec9f073141 100644 --- a/docs/local.md +++ b/docs/local.md @@ -16,6 +16,9 @@ run heroku app locally USAGE $ heroku local [PROCESSNAME] [-f ] [-e ] [-p ] +ARGUMENTS + PROCESSNAME name of the process + FLAGS -e, --env= location of env file (defaults to .env) -f, --procfile= use a different Procfile @@ -35,7 +38,7 @@ EXAMPLES $ heroku local web=1,worker=2 ``` -_See code: [src/commands/local/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/local/index.ts)_ +_See code: [src/commands/local/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/local/index.ts)_ ## `heroku local:run` @@ -56,7 +59,7 @@ EXAMPLES $ heroku local:run bin/migrate ``` -_See code: [src/commands/local/run.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/local/run.ts)_ +_See code: [src/commands/local/run.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/local/run.ts)_ ## `heroku local:start [PROCESSNAME]` @@ -66,6 +69,9 @@ run heroku app locally USAGE $ heroku local:start [PROCESSNAME] [-f ] [-e ] [-p ] +ARGUMENTS + PROCESSNAME name of the process + FLAGS -e, --env= location of env file (defaults to .env) -f, --procfile= use a different Procfile @@ -97,4 +103,4 @@ DESCRIPTION display node-foreman version ``` -_See code: [src/commands/local/version.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/local/version.ts)_ +_See code: [src/commands/local/version.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/local/version.ts)_ diff --git a/docs/logs.md b/docs/logs.md index a6ef61ea42..7e08fc8179 100644 --- a/docs/logs.md +++ b/docs/logs.md @@ -36,4 +36,4 @@ EXAMPLES $ heroku logs --app=my-app --tail ``` -_See code: [src/commands/logs.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/logs.ts)_ +_See code: [src/commands/logs.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/logs.ts)_ diff --git a/docs/maintenance.md b/docs/maintenance.md index 678b8bf3f4..3129bec751 100644 --- a/docs/maintenance.md +++ b/docs/maintenance.md @@ -23,7 +23,7 @@ DESCRIPTION display the current maintenance status of app ``` -_See code: [src/commands/maintenance/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/maintenance/index.ts)_ +_See code: [src/commands/maintenance/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/maintenance/index.ts)_ ## `heroku maintenance:off` @@ -41,7 +41,7 @@ DESCRIPTION take the app out of maintenance mode ``` -_See code: [src/commands/maintenance/off.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/maintenance/off.ts)_ +_See code: [src/commands/maintenance/off.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/maintenance/off.ts)_ ## `heroku maintenance:on` @@ -59,4 +59,4 @@ DESCRIPTION put the app into maintenance mode ``` -_See code: [src/commands/maintenance/on.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/maintenance/on.ts)_ +_See code: [src/commands/maintenance/on.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/maintenance/on.ts)_ diff --git a/docs/members.md b/docs/members.md index 2517ee99dd..568cc1c470 100644 --- a/docs/members.md +++ b/docs/members.md @@ -26,7 +26,7 @@ DESCRIPTION list members of a team ``` -_See code: [src/commands/members/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/members/index.ts)_ +_See code: [src/commands/members/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/members/index.ts)_ ## `heroku members:add EMAIL` @@ -36,6 +36,9 @@ adds a user to a team USAGE $ heroku members:add EMAIL -r -t +ARGUMENTS + EMAIL email address of the team member + FLAGS -r, --role= (required) member role (admin, collaborator, member, owner) -t, --team= (required) team to use @@ -44,7 +47,7 @@ DESCRIPTION adds a user to a team ``` -_See code: [src/commands/members/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/members/add.ts)_ +_See code: [src/commands/members/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/members/add.ts)_ ## `heroku members:remove` @@ -61,7 +64,7 @@ DESCRIPTION removes a user from a team ``` -_See code: [src/commands/members/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/members/remove.ts)_ +_See code: [src/commands/members/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/members/remove.ts)_ ## `heroku members:set` @@ -79,4 +82,4 @@ DESCRIPTION sets a members role in a team ``` -_See code: [src/commands/members/set.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/members/set.ts)_ +_See code: [src/commands/members/set.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/members/set.ts)_ diff --git a/docs/notifications.md b/docs/notifications.md index 3fc6af31e4..2693f958dc 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -24,4 +24,4 @@ DESCRIPTION display notifications ``` -_See code: [src/commands/notifications/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/notifications/index.ts)_ +_See code: [src/commands/notifications/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/notifications/index.ts)_ diff --git a/docs/orgs.md b/docs/orgs.md index a743ca6ccf..e2549383d4 100644 --- a/docs/orgs.md +++ b/docs/orgs.md @@ -22,7 +22,7 @@ DESCRIPTION list the teams that you are a member of ``` -_See code: [src/commands/orgs/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/orgs/index.ts)_ +_See code: [src/commands/orgs/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/orgs/index.ts)_ ## `heroku orgs:open` @@ -39,4 +39,4 @@ DESCRIPTION open the team interface in a browser window ``` -_See code: [src/commands/orgs/open.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/orgs/open.ts)_ +_See code: [src/commands/orgs/open.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/orgs/open.ts)_ diff --git a/docs/pg.md b/docs/pg.md index 989443c4ef..9c593cc444 100644 --- a/docs/pg.md +++ b/docs/pg.md @@ -72,6 +72,11 @@ show database information USAGE $ heroku pg [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use all + databases. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -99,7 +104,7 @@ DESCRIPTION list database backups ``` -_See code: [src/commands/pg/backups/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/index.ts)_ +_See code: [src/commands/pg/backups/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/index.ts)_ ## `heroku pg:backups:cancel [BACKUP_ID]` @@ -109,6 +114,9 @@ cancel an in-progress backup or restore (default newest) USAGE $ heroku pg:backups:cancel [BACKUP_ID] -a [-r ] +ARGUMENTS + BACKUP_ID ID of the backup. If omitted, we use the last unfinished backup ID. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -117,7 +125,7 @@ DESCRIPTION cancel an in-progress backup or restore (default newest) ``` -_See code: [src/commands/pg/backups/cancel.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/cancel.ts)_ +_See code: [src/commands/pg/backups/cancel.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/cancel.ts)_ ## `heroku pg:backups:capture [DATABASE]` @@ -127,6 +135,11 @@ capture a new backup USAGE $ heroku pg:backups:capture [DATABASE] -a [--wait-interval ] [-v] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -137,7 +150,7 @@ DESCRIPTION capture a new backup ``` -_See code: [src/commands/pg/backups/capture.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/capture.ts)_ +_See code: [src/commands/pg/backups/capture.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/capture.ts)_ ## `heroku pg:backups:delete BACKUP_ID` @@ -147,6 +160,9 @@ delete a backup USAGE $ heroku pg:backups:delete BACKUP_ID -a [-c ] [-r ] +ARGUMENTS + BACKUP_ID ID of the backup + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -159,7 +175,7 @@ EXAMPLES $ heroku pg:backup:delete --app APP_ID BACKUP_ID ``` -_See code: [src/commands/pg/backups/delete.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/delete.ts)_ +_See code: [src/commands/pg/backups/delete.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/delete.ts)_ ## `heroku pg:backups:download [BACKUP_ID]` @@ -169,6 +185,9 @@ downloads database backup USAGE $ heroku pg:backups:download [BACKUP_ID] -a [-o ] [-r ] +ARGUMENTS + BACKUP_ID ID of the backup. If omitted, we use the last backup ID. + FLAGS -a, --app= (required) app to run command against -o, --output= location to download to. Defaults to latest.dump @@ -178,7 +197,7 @@ DESCRIPTION downloads database backup ``` -_See code: [src/commands/pg/backups/download.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/download.ts)_ +_See code: [src/commands/pg/backups/download.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/download.ts)_ ## `heroku pg:backups:info [BACKUP_ID]` @@ -188,6 +207,9 @@ get information about a specific backup USAGE $ heroku pg:backups:info [BACKUP_ID] -a [-r ] +ARGUMENTS + BACKUP_ID ID of the backup. If omitted, we use the last backup ID. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -196,7 +218,7 @@ DESCRIPTION get information about a specific backup ``` -_See code: [src/commands/pg/backups/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/info.ts)_ +_See code: [src/commands/pg/backups/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/info.ts)_ ## `heroku pg:backups:restore [BACKUP] [DATABASE]` @@ -207,6 +229,12 @@ USAGE $ heroku pg:backups:restore [BACKUP] [DATABASE] -a [--wait-interval ] [-e ] [-v] [-c ] [-r ] +ARGUMENTS + BACKUP URL or backup ID from another app + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -218,9 +246,34 @@ FLAGS DESCRIPTION restore a backup (default latest) to a database + +EXAMPLES + # Basic Restore from Backup ID + + $ heroku pg:backups:restore b101 DATABASE_URL --app my-heroku-app + + # Restore from Another App + + $ heroku pg:backups:restore example-app::b101 DATABASE_URL --app my-heroku-app + + # Restore from a Public URL + + $ heroku pg:backups:restore 'https://s3.amazonaws.com/my-bucket/mydb.dump' DATABASE_URL --app my-heroku-app + + # Verbose Output + + $ heroku pg:backups:restore b101 DATABASE_URL --app my-heroku-app --verbose + + # Restore with Confirmation Prompt + + $ heroku pg:backups:restore b101 DATABASE_URL --app my-heroku-app --confirm my-heroku-app + + # Restore with a Specific Database Name + + $ heroku pg:backups:restore b101 HEROKU_POSTGRESQL_PINK --app my-heroku-app ``` -_See code: [src/commands/pg/backups/restore.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/restore.ts)_ +_See code: [src/commands/pg/backups/restore.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/restore.ts)_ ## `heroku pg:backups:schedule [DATABASE]` @@ -230,6 +283,11 @@ schedule daily backups for given database USAGE $ heroku pg:backups:schedule [DATABASE] --at -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -240,7 +298,7 @@ DESCRIPTION schedule daily backups for given database ``` -_See code: [src/commands/pg/backups/schedule.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/schedule.ts)_ +_See code: [src/commands/pg/backups/schedule.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/schedule.ts)_ ## `heroku pg:backups:schedules` @@ -258,7 +316,7 @@ DESCRIPTION list backup schedule ``` -_See code: [src/commands/pg/backups/schedules.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/schedules.ts)_ +_See code: [src/commands/pg/backups/schedules.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/schedules.ts)_ ## `heroku pg:backups:unschedule [DATABASE]` @@ -268,6 +326,11 @@ stop daily backups USAGE $ heroku pg:backups:unschedule [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use a + random database attached to the app. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -276,7 +339,7 @@ DESCRIPTION stop daily backups ``` -_See code: [src/commands/pg/backups/unschedule.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/unschedule.ts)_ +_See code: [src/commands/pg/backups/unschedule.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/unschedule.ts)_ ## `heroku pg:backups:url [BACKUP_ID]` @@ -286,6 +349,9 @@ get secret but publicly accessible URL of a backup USAGE $ heroku pg:backups:url [BACKUP_ID] -a [-r ] +ARGUMENTS + BACKUP_ID ID of the backup. If omitted, we use the last backup ID. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -294,7 +360,7 @@ DESCRIPTION get secret but publicly accessible URL of a backup ``` -_See code: [src/commands/pg/backups/url.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/backups/url.ts)_ +_See code: [src/commands/pg/backups/url.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/backups/url.ts)_ ## `heroku pg:bloat [DATABASE]` @@ -304,6 +370,11 @@ show table and index bloat in your database ordered by most wasteful USAGE $ heroku pg:bloat [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -312,7 +383,7 @@ DESCRIPTION show table and index bloat in your database ordered by most wasteful ``` -_See code: [src/commands/pg/bloat.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/bloat.ts)_ +_See code: [src/commands/pg/bloat.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/bloat.ts)_ ## `heroku pg:blocking [DATABASE]` @@ -322,6 +393,11 @@ display queries holding locks other queries are waiting to be released USAGE $ heroku pg:blocking [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -330,7 +406,7 @@ DESCRIPTION display queries holding locks other queries are waiting to be released ``` -_See code: [src/commands/pg/blocking.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/blocking.ts)_ +_See code: [src/commands/pg/blocking.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/blocking.ts)_ ## `heroku pg:connection-pooling:attach [DATABASE]` @@ -340,6 +416,11 @@ add an attachment to a database using connection pooling USAGE $ heroku pg:connection-pooling:attach [DATABASE] -a [--as ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -352,7 +433,7 @@ EXAMPLES $ heroku pg:connection-pooling:attach postgresql-something-12345 ``` -_See code: [src/commands/pg/connection-pooling/attach.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/connection-pooling/attach.ts)_ +_See code: [src/commands/pg/connection-pooling/attach.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/connection-pooling/attach.ts)_ ## `heroku pg:copy SOURCE TARGET` @@ -363,6 +444,10 @@ USAGE $ heroku pg:copy SOURCE TARGET -a [--wait-interval ] [--verbose] [--confirm ] [-r ] +ARGUMENTS + SOURCE config var exposed to the owning app containing the source database URL + TARGET config var exposed to the owning app containing the target database URL + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -374,7 +459,7 @@ DESCRIPTION copy all data from source db to target ``` -_See code: [src/commands/pg/copy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/copy.ts)_ +_See code: [src/commands/pg/copy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/copy.ts)_ ## `heroku pg:credentials [DATABASE]` @@ -384,6 +469,11 @@ show information on credentials in the database USAGE $ heroku pg:credentials [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -392,7 +482,7 @@ DESCRIPTION show information on credentials in the database ``` -_See code: [src/commands/pg/credentials.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/credentials.ts)_ +_See code: [src/commands/pg/credentials.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/credentials.ts)_ ## `heroku pg:credentials:create [DATABASE]` @@ -402,6 +492,11 @@ create credential within database USAGE $ heroku pg:credentials:create [DATABASE] -n -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -n, --name= (required) name of the new credential within the database @@ -414,7 +509,7 @@ DESCRIPTION heroku pg:credentials:create postgresql-something-12345 --name new-cred-name ``` -_See code: [src/commands/pg/credentials/create.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/credentials/create.ts)_ +_See code: [src/commands/pg/credentials/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/credentials/create.ts)_ ## `heroku pg:credentials:destroy [DATABASE]` @@ -424,6 +519,11 @@ destroy credential within database USAGE $ heroku pg:credentials:destroy [DATABASE] -n -a [-c ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -437,7 +537,7 @@ EXAMPLES $ heroku pg:credentials:destroy postgresql-transparent-56874 --name cred-name -a woodstock-production ``` -_See code: [src/commands/pg/credentials/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/credentials/destroy.ts)_ +_See code: [src/commands/pg/credentials/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/credentials/destroy.ts)_ ## `heroku pg:credentials:repair-default [DATABASE]` @@ -447,6 +547,11 @@ repair the permissions of the default credential within database USAGE $ heroku pg:credentials:repair-default [DATABASE] -a [-c ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -459,7 +564,7 @@ EXAMPLES $ heroku pg:credentials:repair-default postgresql-something-12345 ``` -_See code: [src/commands/pg/credentials/repair-default.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/credentials/repair-default.ts)_ +_See code: [src/commands/pg/credentials/repair-default.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/credentials/repair-default.ts)_ ## `heroku pg:credentials:rotate [DATABASE]` @@ -469,6 +574,11 @@ rotate the database credentials USAGE $ heroku pg:credentials:rotate [DATABASE] -a [--all | -n ] [-c ] [--force] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -481,7 +591,7 @@ DESCRIPTION rotate the database credentials ``` -_See code: [src/commands/pg/credentials/rotate.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/credentials/rotate.ts)_ +_See code: [src/commands/pg/credentials/rotate.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/credentials/rotate.ts)_ ## `heroku pg:credentials:url [DATABASE]` @@ -491,6 +601,11 @@ show information on a database credential USAGE $ heroku pg:credentials:url [DATABASE] -a [-n ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -n, --name= [default: default] which credential to show (default credentials if not specified) @@ -500,7 +615,7 @@ DESCRIPTION show information on a database credential ``` -_See code: [src/commands/pg/credentials/url.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/credentials/url.ts)_ +_See code: [src/commands/pg/credentials/url.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/credentials/url.ts)_ ## `heroku pg:diagnose [DATABASE|REPORT_ID]` @@ -510,6 +625,9 @@ run or view diagnostics report USAGE $ heroku pg:diagnose [DATABASE|REPORT_ID] -a [--json] [-r ] +ARGUMENTS + DATABASE|REPORT_ID config var exposed to the owning app containing the database URL or the report ID + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -521,7 +639,7 @@ DESCRIPTION if REPORT_ID is specified instead, a previous report is displayed ``` -_See code: [src/commands/pg/diagnose.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/diagnose.ts)_ +_See code: [src/commands/pg/diagnose.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/diagnose.ts)_ ## `heroku pg:info [DATABASE]` @@ -531,6 +649,11 @@ show database information USAGE $ heroku pg:info [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use all + databases. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -542,7 +665,7 @@ ALIASES $ heroku pg ``` -_See code: [src/commands/pg/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/info.ts)_ +_See code: [src/commands/pg/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/info.ts)_ ## `heroku pg:kill PID [DATABASE]` @@ -552,6 +675,12 @@ kill a query USAGE $ heroku pg:kill PID [DATABASE] -a [-f] [-r ] +ARGUMENTS + PID ID of the process + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -f, --force @@ -561,7 +690,7 @@ DESCRIPTION kill a query ``` -_See code: [src/commands/pg/kill.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/kill.ts)_ +_See code: [src/commands/pg/kill.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/kill.ts)_ ## `heroku pg:killall [DATABASE]` @@ -571,6 +700,11 @@ terminates all connections for all credentials USAGE $ heroku pg:killall [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -579,7 +713,7 @@ DESCRIPTION terminates all connections for all credentials ``` -_See code: [src/commands/pg/killall.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/killall.ts)_ +_See code: [src/commands/pg/killall.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/killall.ts)_ ## `heroku pg:links [DATABASE]` @@ -589,6 +723,11 @@ lists all databases and information on link USAGE $ heroku pg:links [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -597,7 +736,7 @@ DESCRIPTION lists all databases and information on link ``` -_See code: [src/commands/pg/links/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/links/index.ts)_ +_See code: [src/commands/pg/links/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/links/index.ts)_ ## `heroku pg:links:create REMOTE DATABASE` @@ -607,6 +746,12 @@ create a link between data stores USAGE $ heroku pg:links:create REMOTE DATABASE -a [--as ] [-r ] +ARGUMENTS + REMOTE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -618,7 +763,7 @@ DESCRIPTION heroku pg:links:create HEROKU_REDIS_RED HEROKU_POSTGRESQL_CERULEAN ``` -_See code: [src/commands/pg/links/create.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/links/create.ts)_ +_See code: [src/commands/pg/links/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/links/create.ts)_ ## `heroku pg:links:destroy DATABASE LINK` @@ -628,6 +773,11 @@ destroys a link between data stores USAGE $ heroku pg:links:destroy DATABASE LINK -a [-c ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` + LINK name of the linked data store + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -640,7 +790,7 @@ EXAMPLES $ heroku pg:links:destroy HEROKU_POSTGRESQL_CERULEAN redis-symmetrical-100 ``` -_See code: [src/commands/pg/links/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/links/destroy.ts)_ +_See code: [src/commands/pg/links/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/links/destroy.ts)_ ## `heroku pg:locks [DATABASE]` @@ -650,6 +800,11 @@ display queries with active locks USAGE $ heroku pg:locks [DATABASE] -a [-t] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -659,7 +814,7 @@ DESCRIPTION display queries with active locks ``` -_See code: [src/commands/pg/locks.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/locks.ts)_ +_See code: [src/commands/pg/locks.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/locks.ts)_ ## `heroku pg:maintenance [DATABASE]` @@ -669,6 +824,11 @@ show current maintenance information USAGE $ heroku pg:maintenance [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -677,7 +837,7 @@ DESCRIPTION show current maintenance information ``` -_See code: [src/commands/pg/maintenance/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/maintenance/index.ts)_ +_See code: [src/commands/pg/maintenance/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/maintenance/index.ts)_ ## `heroku pg:maintenance:run [DATABASE]` @@ -687,6 +847,11 @@ start maintenance USAGE $ heroku pg:maintenance:run [DATABASE] -a [-f] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -f, --force @@ -696,7 +861,7 @@ DESCRIPTION start maintenance ``` -_See code: [src/commands/pg/maintenance/run.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/maintenance/run.ts)_ +_See code: [src/commands/pg/maintenance/run.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/maintenance/run.ts)_ ## `heroku pg:maintenance:window WINDOW [DATABASE]` @@ -706,6 +871,12 @@ Set weekly maintenance window. USAGE $ heroku pg:maintenance:window WINDOW [DATABASE] -a [-r ] +ARGUMENTS + WINDOW timestamp of the maintenance window + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -719,7 +890,7 @@ EXAMPLES $ heroku pg:maintenance:window "Sunday 06:00" postgres-slippery-100 ``` -_See code: [src/commands/pg/maintenance/window.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/maintenance/window.ts)_ +_See code: [src/commands/pg/maintenance/window.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/maintenance/window.ts)_ ## `heroku pg:outliers [DATABASE]` @@ -729,6 +900,11 @@ show 10 queries that have longest execution time in aggregate USAGE $ heroku pg:outliers [DATABASE] -a [--reset] [-t] [-n ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -n, --num= the number of queries to display (default: 10) @@ -740,7 +916,7 @@ DESCRIPTION show 10 queries that have longest execution time in aggregate ``` -_See code: [src/commands/pg/outliers.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/outliers.ts)_ +_See code: [src/commands/pg/outliers.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/outliers.ts)_ ## `heroku pg:promote DATABASE` @@ -750,6 +926,10 @@ sets DATABASE as your DATABASE_URL USAGE $ heroku pg:promote DATABASE -a [-f] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` + FLAGS -a, --app= (required) app to run command against -f, --force @@ -759,7 +939,7 @@ DESCRIPTION sets DATABASE as your DATABASE_URL ``` -_See code: [src/commands/pg/promote.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/promote.ts)_ +_See code: [src/commands/pg/promote.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/promote.ts)_ ## `heroku pg:ps [DATABASE]` @@ -769,6 +949,11 @@ view active queries with execution time USAGE $ heroku pg:ps [DATABASE] -a [-v] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -778,7 +963,7 @@ DESCRIPTION view active queries with execution time ``` -_See code: [src/commands/pg/ps.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/ps.ts)_ +_See code: [src/commands/pg/ps.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/ps.ts)_ ## `heroku pg:psql [DATABASE]` @@ -788,6 +973,11 @@ open a psql shell to the database USAGE $ heroku pg:psql [DATABASE] -a [-c ] [-f ] [--credential ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -c, --command= SQL command to run @@ -802,7 +992,7 @@ ALIASES $ heroku psql ``` -_See code: [src/commands/pg/psql.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/psql.ts)_ +_See code: [src/commands/pg/psql.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/psql.ts)_ ## `heroku pg:pull SOURCE TARGET` @@ -812,6 +1002,12 @@ pull Heroku database into local or remote database USAGE $ heroku pg:pull SOURCE TARGET -a [--exclude-table-data ] [-r ] +ARGUMENTS + SOURCE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + TARGET PostgreSQL connection string for the target database + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -841,7 +1037,7 @@ EXAMPLES $ heroku pg:pull postgresql-swimmingly-100 postgres://myhost/mydb --app sushi ``` -_See code: [src/commands/pg/pull.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/pull.ts)_ +_See code: [src/commands/pg/pull.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/pull.ts)_ ## `heroku pg:push SOURCE TARGET` @@ -851,6 +1047,12 @@ push local or remote into Heroku database USAGE $ heroku pg:push SOURCE TARGET -a [--exclude-table-data ] [-r ] +ARGUMENTS + SOURCE PostgreSQL connection string for the source database + TARGET config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -876,7 +1078,7 @@ EXAMPLES $ heroku pg:push postgres://myhost/mydb postgresql-swimmingly-100 --app sushi ``` -_See code: [src/commands/pg/push.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/push.ts)_ +_See code: [src/commands/pg/push.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/push.ts)_ ## `heroku pg:reset [DATABASE]` @@ -886,6 +1088,11 @@ delete all data in DATABASE USAGE $ heroku pg:reset [DATABASE] -a [-e ] [-c ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -896,7 +1103,7 @@ DESCRIPTION delete all data in DATABASE ``` -_See code: [src/commands/pg/reset.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/reset.ts)_ +_See code: [src/commands/pg/reset.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/reset.ts)_ ## `heroku pg:settings [DATABASE]` @@ -906,6 +1113,11 @@ show your current database settings USAGE $ heroku pg:settings [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -914,7 +1126,7 @@ DESCRIPTION show your current database settings ``` -_See code: [src/commands/pg/settings/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/index.ts)_ +_See code: [src/commands/pg/settings/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/index.ts)_ ## `heroku pg:settings:auto-explain [DATABASE] [VALUE]` @@ -924,6 +1136,12 @@ Automatically log execution plans of queries without running EXPLAIN by hand. USAGE $ heroku pg:settings:auto-explain [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if execution plans of queries will be logged for future connections + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -934,7 +1152,7 @@ DESCRIPTION Restart your Heroku app and/or restart existing connections for logging to start taking place. ``` -_See code: [src/commands/pg/settings/auto-explain.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain.ts)_ +_See code: [src/commands/pg/settings/auto-explain.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain.ts)_ ## `heroku pg:settings:auto-explain:log-analyze [DATABASE] [VALUE]` @@ -944,6 +1162,12 @@ Shows actual run times on the execution plan. USAGE $ heroku pg:settings:auto-explain:log-analyze [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if execution plans get logged + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -956,7 +1180,7 @@ DESCRIPTION impacts to your database and should be used with caution. ``` -_See code: [src/commands/pg/settings/auto-explain/log-analyze.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain/log-analyze.ts)_ +_See code: [src/commands/pg/settings/auto-explain/log-analyze.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain/log-analyze.ts)_ ## `heroku pg:settings:auto-explain:log-buffers [DATABASE] [VALUE]` @@ -966,6 +1190,12 @@ Includes buffer usage statistics when execution plans are logged. USAGE $ heroku pg:settings:auto-explain:log-buffers [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if the database has buffer statistics enabled + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -976,7 +1206,7 @@ DESCRIPTION pg:settings:auto-explain:log-analyze turned on. ``` -_See code: [src/commands/pg/settings/auto-explain/log-buffers.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain/log-buffers.ts)_ +_See code: [src/commands/pg/settings/auto-explain/log-buffers.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain/log-buffers.ts)_ ## `heroku pg:settings:auto-explain:log-format [DATABASE] [VALUE]` @@ -986,6 +1216,13 @@ selects the EXPLAIN output format to be used USAGE $ heroku pg:settings:auto-explain:log-format [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE (text|json|yaml|xml) format of the log output + + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -995,7 +1232,7 @@ DESCRIPTION The allowed values are text, xml, json, and yaml. The default is text. ``` -_See code: [src/commands/pg/settings/auto-explain/log-format.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain/log-format.ts)_ +_See code: [src/commands/pg/settings/auto-explain/log-format.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain/log-format.ts)_ ## `heroku pg:settings:auto-explain:log-min-duration [DATABASE] [VALUE]` @@ -1005,6 +1242,13 @@ Sets the minimum execution time in milliseconds for a statement's plan to be log USAGE $ heroku pg:settings:auto-explain:log-min-duration [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE minimum duration in milliseconds for queries before logging execution plans. A value of -1 disables it. A + value of 0 logs all query execution plans. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1014,7 +1258,7 @@ DESCRIPTION Setting this value to 0 will log all queries. Setting this value to -1 will disable logging entirely. ``` -_See code: [src/commands/pg/settings/auto-explain/log-min-duration.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain/log-min-duration.ts)_ +_See code: [src/commands/pg/settings/auto-explain/log-min-duration.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain/log-min-duration.ts)_ ## `heroku pg:settings:auto-explain:log-nested-statements [DATABASE] [VALUE]` @@ -1024,6 +1268,12 @@ Nested statements are included in the execution plan's log. USAGE $ heroku pg:settings:auto-explain:log-nested-statements [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if execution plan logs include nested statements + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1032,7 +1282,7 @@ DESCRIPTION Nested statements are included in the execution plan's log. ``` -_See code: [src/commands/pg/settings/auto-explain/log-nested-statements.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain/log-nested-statements.ts)_ +_See code: [src/commands/pg/settings/auto-explain/log-nested-statements.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain/log-nested-statements.ts)_ ## `heroku pg:settings:auto-explain:log-triggers [DATABASE] [VALUE]` @@ -1042,6 +1292,12 @@ Includes trigger execution statistics in execution plan logs. USAGE $ heroku pg:settings:auto-explain:log-triggers [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if the database has trigger execution statistics enabled + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1051,7 +1307,7 @@ DESCRIPTION This parameter can only be used in conjunction with pg:settings:auto-explain:log-analyze turned on. ``` -_See code: [src/commands/pg/settings/auto-explain/log-triggers.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain/log-triggers.ts)_ +_See code: [src/commands/pg/settings/auto-explain/log-triggers.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain/log-triggers.ts)_ ## `heroku pg:settings:auto-explain:log-verbose [DATABASE] [VALUE]` @@ -1061,6 +1317,12 @@ Include verbose details in execution plans. USAGE $ heroku pg:settings:auto-explain:log-verbose [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if the database has verbose execution plan logging enabled + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1070,7 +1332,7 @@ DESCRIPTION This is equivalent to calling EXPLAIN VERBOSE. ``` -_See code: [src/commands/pg/settings/auto-explain/log-verbose.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/auto-explain/log-verbose.ts)_ +_See code: [src/commands/pg/settings/auto-explain/log-verbose.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/auto-explain/log-verbose.ts)_ ## `heroku pg:settings:explain-data-connector-details [DATABASE] [VALUE]` @@ -1080,6 +1342,12 @@ displays stats on replication slots on your database, the default value is "off" USAGE $ heroku pg:settings:explain-data-connector-details [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if data replication slot details get logged + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1088,7 +1356,7 @@ DESCRIPTION displays stats on replication slots on your database, the default value is "off" ``` -_See code: [src/commands/pg/settings/explain-data-connector-details.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/explain-data-connector-details.ts)_ +_See code: [src/commands/pg/settings/explain-data-connector-details.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/explain-data-connector-details.ts)_ ## `heroku pg:settings:log-connections [DATABASE] [VALUE]` @@ -1098,6 +1366,12 @@ Controls whether a log message is produced when a login attempt is made. Default USAGE $ heroku pg:settings:log-connections [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if database login attempts get logged + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1107,7 +1381,7 @@ DESCRIPTION Setting log_connections to false stops emitting log messages for all attempts to login to the database. ``` -_See code: [src/commands/pg/settings/log-connections.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/log-connections.ts)_ +_See code: [src/commands/pg/settings/log-connections.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/log-connections.ts)_ ## `heroku pg:settings:log-lock-waits [DATABASE] [VALUE]` @@ -1117,6 +1391,13 @@ Controls whether a log message is produced when a session waits longer than the USAGE $ heroku pg:settings:log-lock-waits [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE boolean indicating if a message gets logged when a session waits longer than the deadlock_timeout to acquire + a lock + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1130,7 +1411,7 @@ DESCRIPTION transaction. ``` -_See code: [src/commands/pg/settings/log-lock-waits.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/log-lock-waits.ts)_ +_See code: [src/commands/pg/settings/log-lock-waits.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/log-lock-waits.ts)_ ## `heroku pg:settings:log-min-duration-statement [DATABASE] [VALUE]` @@ -1140,6 +1421,12 @@ The duration of each completed statement will be logged if the statement complet USAGE $ heroku pg:settings:log-min-duration-statement [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE milliseconds to wait for a statement to complete before logging it + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1151,7 +1438,7 @@ DESCRIPTION durations. ``` -_See code: [src/commands/pg/settings/log-min-duration-statement.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/log-min-duration-statement.ts)_ +_See code: [src/commands/pg/settings/log-min-duration-statement.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/log-min-duration-statement.ts)_ ## `heroku pg:settings:log-min-error-statement [DATABASE] [VALUE]` @@ -1161,6 +1448,12 @@ log-min-error-statement controls the logging of SQL statements that cause an err USAGE $ heroku pg:settings:log-min-error-statement [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE (error|log|fatal|panic) + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1171,7 +1464,7 @@ DESCRIPTION Use this setting to prevent logging SQL queries that contain sensitive information. Default is "error". ``` -_See code: [src/commands/pg/settings/log-min-error-statement.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/log-min-error-statement.ts)_ +_See code: [src/commands/pg/settings/log-min-error-statement.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/log-min-error-statement.ts)_ ## `heroku pg:settings:log-statement [DATABASE] [VALUE]` @@ -1181,6 +1474,13 @@ log_statement controls which SQL statements are logged. USAGE $ heroku pg:settings:log-statement [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE (none|ddl|mod|all) type of SQL statements to log + + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1195,7 +1495,7 @@ DESCRIPTION all - All statements are logged ``` -_See code: [src/commands/pg/settings/log-statement.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/log-statement.ts)_ +_See code: [src/commands/pg/settings/log-statement.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/log-statement.ts)_ ## `heroku pg:settings:track-functions [DATABASE] [VALUE]` @@ -1205,6 +1505,13 @@ track_functions controls tracking of function call counts and time used. Default USAGE $ heroku pg:settings:track-functions [DATABASE] [VALUE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + VALUE (none|pl|all) function type to track + + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1218,7 +1525,7 @@ DESCRIPTION not tracked ``` -_See code: [src/commands/pg/settings/track-functions.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/settings/track-functions.ts)_ +_See code: [src/commands/pg/settings/track-functions.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/settings/track-functions.ts)_ ## `heroku pg:unfollow DATABASE` @@ -1228,6 +1535,10 @@ stop a replica from following and make it a writeable database USAGE $ heroku pg:unfollow DATABASE -a [-c ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -1237,7 +1548,7 @@ DESCRIPTION stop a replica from following and make it a writeable database ``` -_See code: [src/commands/pg/unfollow.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/unfollow.ts)_ +_See code: [src/commands/pg/unfollow.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/unfollow.ts)_ ## `heroku pg:upgrade [DATABASE]` @@ -1247,6 +1558,11 @@ For an Essential-* plan, this command upgrades the database's PostgreSQL version USAGE $ heroku pg:upgrade [DATABASE] -a [-c ] [-v ] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -1259,7 +1575,7 @@ DESCRIPTION To upgrade to another PostgreSQL version, use pg:copy instead ``` -_See code: [src/commands/pg/upgrade.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/upgrade.ts)_ +_See code: [src/commands/pg/upgrade.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/upgrade.ts)_ ## `heroku pg:vacuum-stats [DATABASE]` @@ -1269,6 +1585,11 @@ show dead rows and whether an automatic vacuum is expected to be triggered USAGE $ heroku pg:vacuum-stats [DATABASE] -a [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use + DATABASE_URL. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1277,7 +1598,7 @@ DESCRIPTION show dead rows and whether an automatic vacuum is expected to be triggered ``` -_See code: [src/commands/pg/vacuum-stats.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/vacuum-stats.ts)_ +_See code: [src/commands/pg/vacuum-stats.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/vacuum-stats.ts)_ ## `heroku pg:wait [DATABASE]` @@ -1287,6 +1608,11 @@ blocks until database is available USAGE $ heroku pg:wait [DATABASE] -a [--wait-interval ] [--no-notify] [-r ] +ARGUMENTS + DATABASE config var containing the connection string, unique name, ID, or alias of the database. To access another + app's database, prepend the app name to the config var or alias with `APP_NAME::` . If omitted, we use all + databases. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -1297,4 +1623,4 @@ DESCRIPTION blocks until database is available ``` -_See code: [src/commands/pg/wait.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pg/wait.ts)_ +_See code: [src/commands/pg/wait.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pg/wait.ts)_ diff --git a/docs/pipelines.md b/docs/pipelines.md index 0a6958f8f9..6e5b72937a 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -36,7 +36,7 @@ EXAMPLES $ heroku pipelines ``` -_See code: [src/commands/pipelines/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/index.ts)_ +_See code: [src/commands/pipelines/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/index.ts)_ ## `heroku pipelines:add PIPELINE` @@ -63,7 +63,7 @@ EXAMPLES $ heroku pipelines:add my-pipeline -a my-app -s production ``` -_See code: [src/commands/pipelines/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/add.ts)_ +_See code: [src/commands/pipelines/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/add.ts)_ ## `heroku pipelines:connect NAME` @@ -86,7 +86,7 @@ EXAMPLES $ heroku pipelines:connect my-pipeline -r githuborg/reponame ``` -_See code: [src/commands/pipelines/connect.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/connect.ts)_ +_See code: [src/commands/pipelines/connect.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/connect.ts)_ ## `heroku pipelines:create [NAME]` @@ -118,7 +118,7 @@ EXAMPLES $ heroku pipelines:create my-pipeline -a my-app-staging ``` -_See code: [src/commands/pipelines/create.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/create.ts)_ +_See code: [src/commands/pipelines/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/create.ts)_ ## `heroku pipelines:destroy PIPELINE` @@ -138,7 +138,7 @@ EXAMPLES $ heroku pipelines:destroy my-pipeline ``` -_See code: [src/commands/pipelines/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/destroy.ts)_ +_See code: [src/commands/pipelines/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/destroy.ts)_ ## `heroku pipelines:diff` @@ -159,7 +159,7 @@ EXAMPLES $ heroku pipelines:diff -a my-app-staging ``` -_See code: [src/commands/pipelines/diff.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/diff.ts)_ +_See code: [src/commands/pipelines/diff.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/diff.ts)_ ## `heroku pipelines:info PIPELINE` @@ -182,7 +182,7 @@ EXAMPLES $ heroku pipelines:info my-pipeline ``` -_See code: [src/commands/pipelines/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/info.ts)_ +_See code: [src/commands/pipelines/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/info.ts)_ ## `heroku pipelines:open PIPELINE` @@ -202,7 +202,7 @@ EXAMPLES $ heroku pipelines:open my-pipeline ``` -_See code: [src/commands/pipelines/open.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/open.ts)_ +_See code: [src/commands/pipelines/open.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/open.ts)_ ## `heroku pipelines:promote` @@ -224,7 +224,7 @@ EXAMPLES $ heroku pipelines:promote -a my-app-staging ``` -_See code: [src/commands/pipelines/promote.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/promote.ts)_ +_See code: [src/commands/pipelines/promote.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/promote.ts)_ ## `heroku pipelines:remove` @@ -245,7 +245,7 @@ EXAMPLES $ heroku pipelines:remove -a my-app ``` -_See code: [src/commands/pipelines/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/remove.ts)_ +_See code: [src/commands/pipelines/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/remove.ts)_ ## `heroku pipelines:rename PIPELINE NAME` @@ -266,7 +266,7 @@ EXAMPLES $ heroku pipelines:rename my-pipeline new-pipeline-name ``` -_See code: [src/commands/pipelines/rename.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/rename.ts)_ +_See code: [src/commands/pipelines/rename.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/rename.ts)_ ## `heroku pipelines:setup [NAME] [REPO]` @@ -292,7 +292,7 @@ EXAMPLES $ heroku pipelines:setup my-pipeline githuborg/reponame -t my-team ``` -_See code: [src/commands/pipelines/setup.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/setup.ts)_ +_See code: [src/commands/pipelines/setup.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/setup.ts)_ ## `heroku pipelines:transfer OWNER` @@ -318,7 +318,7 @@ EXAMPLES $ heroku pipelines:transfer admin-team -p my-pipeline ``` -_See code: [src/commands/pipelines/transfer.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/transfer.ts)_ +_See code: [src/commands/pipelines/transfer.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/transfer.ts)_ ## `heroku pipelines:update` @@ -340,4 +340,4 @@ EXAMPLES $ heroku pipelines:update -s staging -a my-app ``` -_See code: [src/commands/pipelines/update.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/pipelines/update.ts)_ +_See code: [src/commands/pipelines/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/pipelines/update.ts)_ diff --git a/docs/ps.md b/docs/ps.md index 8f328d8943..11f60ef3d6 100644 --- a/docs/ps.md +++ b/docs/ps.md @@ -46,7 +46,7 @@ EXAMPLES run.1: up for 5m: bash ``` -_See code: [src/commands/ps/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/index.ts)_ +_See code: [src/commands/ps/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/index.ts)_ ## `heroku ps:autoscale:disable` @@ -64,7 +64,7 @@ DESCRIPTION disable web dyno autoscaling ``` -_See code: [src/commands/ps/autoscale/disable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/autoscale/disable.ts)_ +_See code: [src/commands/ps/autoscale/disable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/autoscale/disable.ts)_ ## `heroku ps:autoscale:enable` @@ -86,7 +86,7 @@ DESCRIPTION enable web dyno autoscaling ``` -_See code: [src/commands/ps/autoscale/enable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/autoscale/enable.ts)_ +_See code: [src/commands/ps/autoscale/enable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/autoscale/enable.ts)_ ## `heroku ps:copy FILE` @@ -164,6 +164,9 @@ stop app dyno USAGE $ heroku ps:kill DYNO -a [-r ] +ARGUMENTS + DYNO ID of the dyno + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -217,6 +220,9 @@ restart app dynos USAGE $ heroku ps:restart [DYNO] -a [-r ] +ARGUMENTS + DYNO ID of the dyno + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -235,7 +241,7 @@ EXAMPLES $ heroku ps:restart ``` -_See code: [src/commands/ps/restart.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/restart.ts)_ +_See code: [src/commands/ps/restart.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/restart.ts)_ ## `heroku ps:scale` @@ -268,7 +274,7 @@ EXAMPLES web=3:Standard-2X worker=1:Standard-1X ``` -_See code: [src/commands/ps/scale.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/scale.ts)_ +_See code: [src/commands/ps/scale.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/scale.ts)_ ## `heroku ps:socks` @@ -301,6 +307,9 @@ stop app dyno USAGE $ heroku ps:stop DYNO -a [-r ] +ARGUMENTS + DYNO ID of the dyno + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -319,7 +328,7 @@ EXAMPLES $ heroku ps:stop run ``` -_See code: [src/commands/ps/stop.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/stop.ts)_ +_See code: [src/commands/ps/stop.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/stop.ts)_ ## `heroku ps:type` @@ -348,7 +357,7 @@ ALIASES $ heroku dyno:resize ``` -_See code: [src/commands/ps/type.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/type.ts)_ +_See code: [src/commands/ps/type.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/type.ts)_ ## `heroku ps:wait` @@ -369,4 +378,4 @@ DESCRIPTION wait for all dynos to be running latest version after a release ``` -_See code: [src/commands/ps/wait.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/ps/wait.ts)_ +_See code: [src/commands/ps/wait.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/ps/wait.ts)_ diff --git a/docs/redis.md b/docs/redis.md index 547c2a57f1..51d74b1ffa 100644 --- a/docs/redis.md +++ b/docs/redis.md @@ -24,6 +24,10 @@ gets information about redis USAGE $ heroku redis [DATABASE] -a [-r ] [-j] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -j, --json output in json format @@ -44,6 +48,10 @@ opens a redis prompt USAGE $ heroku redis:cli [DATABASE] -a [-c ] [-r ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -58,7 +66,7 @@ EXAMPLES $ heroku redis:cli --app=my-app --confirm my-database ``` -_See code: [src/commands/redis/cli.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/cli.ts)_ +_See code: [src/commands/redis/cli.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/cli.ts)_ ## `heroku redis:credentials [DATABASE]` @@ -68,6 +76,10 @@ display credentials information USAGE $ heroku redis:credentials [DATABASE] -a [-r ] [--reset] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -77,7 +89,7 @@ DESCRIPTION display credentials information ``` -_See code: [src/commands/redis/credentials.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/credentials.ts)_ +_See code: [src/commands/redis/credentials.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/credentials.ts)_ ## `heroku redis:info [DATABASE]` @@ -87,6 +99,10 @@ gets information about redis USAGE $ heroku redis:info [DATABASE] -a [-r ] [-j] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -j, --json output in json format @@ -99,7 +115,7 @@ ALIASES $ heroku redis ``` -_See code: [src/commands/redis/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/info.ts)_ +_See code: [src/commands/redis/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/info.ts)_ ## `heroku redis:keyspace-notifications [DATABASE]` @@ -109,6 +125,10 @@ set the keyspace notifications configuration USAGE $ heroku redis:keyspace-notifications [DATABASE] -a -c [-r ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -c, --config= (required) set keyspace notifications configuration @@ -134,7 +154,7 @@ DESCRIPTION pass an empty string ('') to disable keyspace notifications ``` -_See code: [src/commands/redis/keyspace-notifications.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/keyspace-notifications.ts)_ +_See code: [src/commands/redis/keyspace-notifications.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/keyspace-notifications.ts)_ ## `heroku redis:maintenance [DATABASE]` @@ -144,6 +164,10 @@ manage maintenance windows USAGE $ heroku redis:maintenance [DATABASE] -a [-r ] [-w ] [--run] [-f] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -f, --force start maintenance without entering application maintenance mode @@ -156,7 +180,7 @@ DESCRIPTION Set or change the maintenance window for your Redis instance ``` -_See code: [src/commands/redis/maintenance.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/maintenance.ts)_ +_See code: [src/commands/redis/maintenance.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/maintenance.ts)_ ## `heroku redis:maxmemory [DATABASE]` @@ -166,6 +190,10 @@ set the key eviction policy when instances reach their storage limit USAGE $ heroku redis:maxmemory [DATABASE] -a -p [-r ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -p, --policy= (required) set policy name @@ -185,7 +213,7 @@ DESCRIPTION volatile-ttl # only evicts keys with an expiry set and a short TTL ``` -_See code: [src/commands/redis/maxmemory.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/maxmemory.ts)_ +_See code: [src/commands/redis/maxmemory.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/maxmemory.ts)_ ## `heroku redis:promote [DATABASE]` @@ -195,6 +223,10 @@ sets DATABASE as your REDIS_URL USAGE $ heroku redis:promote [DATABASE] -a [-r ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -203,7 +235,7 @@ DESCRIPTION sets DATABASE as your REDIS_URL ``` -_See code: [src/commands/redis/promote.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/promote.ts)_ +_See code: [src/commands/redis/promote.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/promote.ts)_ ## `heroku redis:stats-reset [DATABASE]` @@ -213,6 +245,10 @@ reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat USAGE $ heroku redis:stats-reset [DATABASE] -a [-r ] [-c ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -222,7 +258,7 @@ DESCRIPTION reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat) ``` -_See code: [src/commands/redis/stats-reset.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/stats-reset.ts)_ +_See code: [src/commands/redis/stats-reset.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/stats-reset.ts)_ ## `heroku redis:timeout [DATABASE]` @@ -232,6 +268,10 @@ set the number of seconds to wait before killing idle connections USAGE $ heroku redis:timeout [DATABASE] -a -s [-r ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -242,7 +282,7 @@ DESCRIPTION A value of zero means that connections will not be closed. ``` -_See code: [src/commands/redis/timeout.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/timeout.ts)_ +_See code: [src/commands/redis/timeout.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/timeout.ts)_ ## `heroku redis:upgrade [DATABASE]` @@ -252,6 +292,10 @@ perform in-place version upgrade USAGE $ heroku redis:upgrade [DATABASE] -a -v [-r ] [-c ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -c, --confirm= @@ -262,7 +306,7 @@ DESCRIPTION perform in-place version upgrade ``` -_See code: [src/commands/redis/upgrade.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/upgrade.ts)_ +_See code: [src/commands/redis/upgrade.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/upgrade.ts)_ ## `heroku redis:wait [DATABASE]` @@ -272,6 +316,10 @@ wait for Redis instance to be available USAGE $ heroku redis:wait [DATABASE] -a [--wait-interval ] [-r ] +ARGUMENTS + DATABASE name of the Key-Value Store database. If omitted, it defaults to the primary database associated with the + app. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -281,4 +329,4 @@ DESCRIPTION wait for Redis instance to be available ``` -_See code: [src/commands/redis/wait.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/redis/wait.ts)_ +_See code: [src/commands/redis/wait.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/redis/wait.ts)_ diff --git a/docs/regions.md b/docs/regions.md index e4991065b7..81d4873f93 100644 --- a/docs/regions.md +++ b/docs/regions.md @@ -22,4 +22,4 @@ DESCRIPTION list available regions for deployment ``` -_See code: [src/commands/regions.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/regions.ts)_ +_See code: [src/commands/regions.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/regions.ts)_ diff --git a/docs/releases.md b/docs/releases.md index 9df2952ca8..92bc90757f 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -33,7 +33,7 @@ EXAMPLES v3 Config add BAZ_QUX email@example.com 2015/11/17 17:37:41 (~ 1h ago) ``` -_See code: [src/commands/releases/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/releases/index.ts)_ +_See code: [src/commands/releases/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/releases/index.ts)_ ## `heroku releases:info [RELEASE]` @@ -43,6 +43,9 @@ view detailed information for a release USAGE $ heroku releases:info [RELEASE] -a [--json] [-s] [-r ] +ARGUMENTS + RELEASE ID of the release. If omitted, we use the last release ID. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -53,7 +56,7 @@ DESCRIPTION view detailed information for a release ``` -_See code: [src/commands/releases/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/releases/info.ts)_ +_See code: [src/commands/releases/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/releases/info.ts)_ ## `heroku releases:output [RELEASE]` @@ -63,6 +66,9 @@ View the release command output USAGE $ heroku releases:output [RELEASE] -a [-r ] +ARGUMENTS + RELEASE ID of the release. If omitted, we use the last release ID. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -71,7 +77,7 @@ DESCRIPTION View the release command output ``` -_See code: [src/commands/releases/output.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/releases/output.ts)_ +_See code: [src/commands/releases/output.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/releases/output.ts)_ ## `heroku releases:rollback [RELEASE]` @@ -81,6 +87,9 @@ Roll back to a previous release. USAGE $ heroku releases:rollback [RELEASE] -a [-r ] +ARGUMENTS + RELEASE ID of the release. If omitted, we use the last release ID. + FLAGS -a, --app= (required) app to run command against -r, --remote= git remote of app to use @@ -91,4 +100,4 @@ DESCRIPTION If RELEASE is not specified, it will roll back one release. ``` -_See code: [src/commands/releases/rollback.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/releases/rollback.ts)_ +_See code: [src/commands/releases/rollback.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/releases/rollback.ts)_ diff --git a/docs/reviewapps.md b/docs/reviewapps.md index 3e9e7eac3b..96c71b5c2a 100644 --- a/docs/reviewapps.md +++ b/docs/reviewapps.md @@ -30,7 +30,7 @@ EXAMPLES $ heroku reviewapps:disable -p my-pipeline -a my-app --no-autodeploy ``` -_See code: [src/commands/reviewapps/disable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/reviewapps/disable.ts)_ +_See code: [src/commands/reviewapps/disable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/reviewapps/disable.ts)_ ## `heroku reviewapps:enable` @@ -55,4 +55,4 @@ EXAMPLES $ heroku reviewapps:enable -p my-pipeline -a my-app --autodeploy --autodestroy ``` -_See code: [src/commands/reviewapps/enable.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/reviewapps/enable.ts)_ +_See code: [src/commands/reviewapps/enable.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/reviewapps/enable.ts)_ diff --git a/docs/run.md b/docs/run.md index 3a64e72f63..76bba172f3 100644 --- a/docs/run.md +++ b/docs/run.md @@ -35,7 +35,7 @@ EXAMPLES $ heroku run -s standard-2x -- myscript.sh -a arg1 -s arg2 ``` -_See code: [src/commands/run/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/run/index.ts)_ +_See code: [src/commands/run/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/run/index.ts)_ ## `heroku run:detached` @@ -60,4 +60,4 @@ EXAMPLES $ heroku run:detached ls ``` -_See code: [src/commands/run/detached.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/run/detached.ts)_ +_See code: [src/commands/run/detached.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/run/detached.ts)_ diff --git a/docs/sessions.md b/docs/sessions.md index 2d744fa400..0bb70aa35d 100644 --- a/docs/sessions.md +++ b/docs/sessions.md @@ -21,7 +21,7 @@ DESCRIPTION list your OAuth sessions ``` -_See code: [src/commands/sessions/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/sessions/index.ts)_ +_See code: [src/commands/sessions/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/sessions/index.ts)_ ## `heroku sessions:destroy ID` @@ -31,8 +31,11 @@ delete (logout) OAuth session by ID USAGE $ heroku sessions:destroy ID +ARGUMENTS + ID ID of the OAuth session + DESCRIPTION delete (logout) OAuth session by ID ``` -_See code: [src/commands/sessions/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/sessions/destroy.ts)_ +_See code: [src/commands/sessions/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/sessions/destroy.ts)_ diff --git a/docs/spaces.md b/docs/spaces.md index 20d500bf65..e1c426ae19 100644 --- a/docs/spaces.md +++ b/docs/spaces.md @@ -43,7 +43,7 @@ DESCRIPTION list available spaces ``` -_See code: [src/commands/spaces/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/index.ts)_ +_See code: [src/commands/spaces/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/index.ts)_ ## `heroku spaces:create` @@ -78,7 +78,7 @@ EXAMPLES Created at: 2016-01-06T03:23:13Z ``` -_See code: [src/commands/spaces/create.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/create.ts)_ +_See code: [src/commands/spaces/create.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/create.ts)_ ## `heroku spaces:destroy` @@ -101,7 +101,7 @@ EXAMPLES Destroying my-space... done ``` -_See code: [src/commands/spaces/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/destroy.ts)_ +_See code: [src/commands/spaces/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/destroy.ts)_ ## `heroku spaces:info` @@ -122,7 +122,7 @@ EXAMPLES $ heroku spaces:info my-space ``` -_See code: [src/commands/spaces/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/info.ts)_ +_See code: [src/commands/spaces/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/info.ts)_ ## `heroku spaces:peerings` @@ -140,7 +140,7 @@ DESCRIPTION list peering connections for a space ``` -_See code: [src/commands/spaces/peerings/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/peerings/index.ts)_ +_See code: [src/commands/spaces/peerings/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/peerings/index.ts)_ ## `heroku spaces:peerings:accept` @@ -162,7 +162,7 @@ EXAMPLES Accepting and configuring peering connection pcx-4bd27022 ``` -_See code: [src/commands/spaces/peerings/accept.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/peerings/accept.ts)_ +_See code: [src/commands/spaces/peerings/accept.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/peerings/accept.ts)_ ## `heroku spaces:peerings:destroy` @@ -185,7 +185,7 @@ EXAMPLES Tearing down peering connection pcx-4bd27022... done ``` -_See code: [src/commands/spaces/peerings/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/peerings/destroy.ts)_ +_See code: [src/commands/spaces/peerings/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/peerings/destroy.ts)_ ## `heroku spaces:peerings:info` @@ -226,7 +226,7 @@ EXAMPLES Unavailable CIDRs: 10.1.0.0/16 ``` -_See code: [src/commands/spaces/peerings/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/peerings/info.ts)_ +_See code: [src/commands/spaces/peerings/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/peerings/info.ts)_ ## `heroku spaces:ps` @@ -244,7 +244,7 @@ DESCRIPTION list dynos for a space ``` -_See code: [src/commands/spaces/ps.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/ps.ts)_ +_See code: [src/commands/spaces/ps.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/ps.ts)_ ## `heroku spaces:rename` @@ -266,7 +266,7 @@ EXAMPLES Renaming space old-space-name to new-space-name... done ``` -_See code: [src/commands/spaces/rename.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/rename.ts)_ +_See code: [src/commands/spaces/rename.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/rename.ts)_ ## `heroku spaces:topology` @@ -284,7 +284,7 @@ DESCRIPTION show space topology ``` -_See code: [src/commands/spaces/topology.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/topology.ts)_ +_See code: [src/commands/spaces/topology.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/topology.ts)_ ## `heroku spaces:transfer` @@ -306,7 +306,7 @@ EXAMPLES Transferring space-name to team-name... done ``` -_See code: [src/commands/spaces/transfer.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/transfer.ts)_ +_See code: [src/commands/spaces/transfer.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/transfer.ts)_ ## `heroku spaces:trusted-ips` @@ -329,7 +329,7 @@ DESCRIPTION a time to the commands listed below. For example 1.2.3.4/20 and 5.6.7.8/20 can be added with: ``` -_See code: [src/commands/spaces/trusted-ips/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/trusted-ips/index.ts)_ +_See code: [src/commands/spaces/trusted-ips/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/trusted-ips/index.ts)_ ## `heroku spaces:trusted-ips:add SOURCE` @@ -339,6 +339,9 @@ Add one range to the list of trusted IP ranges USAGE $ heroku spaces:trusted-ips:add SOURCE -s [--confirm ] +ARGUMENTS + SOURCE IP address in CIDR notation + FLAGS -s, --space= (required) space to add rule to --confirm= set to space name to bypass confirm prompt @@ -352,7 +355,7 @@ EXAMPLES Added 192.168.0.1/24 to trusted IP ranges on my-space ``` -_See code: [src/commands/spaces/trusted-ips/add.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/trusted-ips/add.ts)_ +_See code: [src/commands/spaces/trusted-ips/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/trusted-ips/add.ts)_ ## `heroku spaces:trusted-ips:remove SOURCE` @@ -362,6 +365,9 @@ Remove a range from the list of trusted IP ranges USAGE $ heroku spaces:trusted-ips:remove SOURCE -s [--confirm ] +ARGUMENTS + SOURCE IP address in CIDR notation + FLAGS -s, --space= (required) space to remove rule from --confirm= set to space name to bypass confirm prompt @@ -375,7 +381,7 @@ EXAMPLES Removed 192.168.2.0/24 from trusted IP ranges on my-space ``` -_See code: [src/commands/spaces/trusted-ips/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/trusted-ips/remove.ts)_ +_See code: [src/commands/spaces/trusted-ips/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/trusted-ips/remove.ts)_ ## `heroku spaces:vpn:config NAME` @@ -412,7 +418,7 @@ EXAMPLES Tunnel 2 104.196.121.200 52.44.7.216 fedcba54321 10.0.0.0/16 1 ``` -_See code: [src/commands/spaces/vpn/config.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/vpn/config.ts)_ +_See code: [src/commands/spaces/vpn/config.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/vpn/config.ts)_ ## `heroku spaces:vpn:connect NAME` @@ -443,7 +449,7 @@ EXAMPLES ▸ Use spaces:vpn:wait to track allocation. ``` -_See code: [src/commands/spaces/vpn/connect.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/vpn/connect.ts)_ +_See code: [src/commands/spaces/vpn/connect.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/vpn/connect.ts)_ ## `heroku spaces:vpn:connections` @@ -468,7 +474,7 @@ EXAMPLES office active UP/UP ``` -_See code: [src/commands/spaces/vpn/connections.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/vpn/connections.ts)_ +_See code: [src/commands/spaces/vpn/connections.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/vpn/connections.ts)_ ## `heroku spaces:vpn:destroy NAME` @@ -492,7 +498,7 @@ EXAMPLES Tearing down VPN Connection vpn-connection-name in space example-space ``` -_See code: [src/commands/spaces/vpn/destroy.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/vpn/destroy.ts)_ +_See code: [src/commands/spaces/vpn/destroy.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/vpn/destroy.ts)_ ## `heroku spaces:vpn:info NAME` @@ -528,7 +534,7 @@ EXAMPLES Tunnel 2 52.44.146.197 UP 2016-10-25T22:09:05Z status message ``` -_See code: [src/commands/spaces/vpn/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/vpn/info.ts)_ +_See code: [src/commands/spaces/vpn/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/vpn/info.ts)_ ## `heroku spaces:vpn:update NAME` @@ -557,7 +563,7 @@ EXAMPLES Updating VPN Connection in space my-space... done ``` -_See code: [src/commands/spaces/vpn/update.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/vpn/update.ts)_ +_See code: [src/commands/spaces/vpn/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/vpn/update.ts)_ ## `heroku spaces:vpn:wait NAME` @@ -589,7 +595,7 @@ EXAMPLES Tunnel 2 104.196.121.200 52.44.7.216 fedcba54321 10.0.0.0/16 1 ``` -_See code: [src/commands/spaces/vpn/wait.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/vpn/wait.ts)_ +_See code: [src/commands/spaces/vpn/wait.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/vpn/wait.ts)_ ## `heroku spaces:wait` @@ -609,4 +615,4 @@ DESCRIPTION wait for a space to be created ``` -_See code: [src/commands/spaces/wait.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/spaces/wait.ts)_ +_See code: [src/commands/spaces/wait.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/spaces/wait.ts)_ diff --git a/docs/status.md b/docs/status.md index 6eb7bb6d04..8b04320580 100644 --- a/docs/status.md +++ b/docs/status.md @@ -20,4 +20,4 @@ DESCRIPTION display current status of the Heroku platform ``` -_See code: [src/commands/status.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/status.ts)_ +_See code: [src/commands/status.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/status.ts)_ diff --git a/docs/teams.md b/docs/teams.md index 96fdb04893..119c4a1c4f 100644 --- a/docs/teams.md +++ b/docs/teams.md @@ -22,4 +22,4 @@ DESCRIPTION Use heroku members:* to manage team members. ``` -_See code: [src/commands/teams/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/teams/index.ts)_ +_See code: [src/commands/teams/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/teams/index.ts)_ diff --git a/docs/webhooks.md b/docs/webhooks.md index be6951bfa2..855424b0d8 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -32,7 +32,7 @@ EXAMPLES $ heroku webhooks ``` -_See code: [src/commands/webhooks/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/webhooks/index.ts)_ +_See code: [src/commands/webhooks/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/index.ts)_ ## `heroku webhooks:add` @@ -58,7 +58,7 @@ 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/v9.3.2/packages/cli/src/commands/webhooks/add.ts)_ +_See code: [src/commands/webhooks/add.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/add.ts)_ ## `heroku webhooks:deliveries` @@ -80,7 +80,7 @@ EXAMPLES $ heroku webhooks:deliveries ``` -_See code: [src/commands/webhooks/deliveries/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/webhooks/deliveries/index.ts)_ +_See code: [src/commands/webhooks/deliveries/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/deliveries/index.ts)_ ## `heroku webhooks:deliveries:info ID` @@ -90,6 +90,9 @@ info for a webhook event on an app USAGE $ heroku webhooks:deliveries:info ID [-a ] [-r ] +ARGUMENTS + ID ID of the webhook event + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -101,7 +104,7 @@ EXAMPLES $ heroku webhooks:deliveries:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/deliveries/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/webhooks/deliveries/info.ts)_ +_See code: [src/commands/webhooks/deliveries/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/deliveries/info.ts)_ ## `heroku webhooks:events` @@ -122,7 +125,7 @@ EXAMPLES $ heroku webhooks:events ``` -_See code: [src/commands/webhooks/events/index.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/webhooks/events/index.ts)_ +_See code: [src/commands/webhooks/events/index.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/events/index.ts)_ ## `heroku webhooks:events:info ID` @@ -132,6 +135,9 @@ info for a webhook event on an app USAGE $ heroku webhooks:events:info ID [-a ] [-r ] +ARGUMENTS + ID ID of the webhook event + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -143,7 +149,7 @@ EXAMPLES $ heroku webhooks:events:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/events/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/webhooks/events/info.ts)_ +_See code: [src/commands/webhooks/events/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/events/info.ts)_ ## `heroku webhooks:info ID` @@ -153,6 +159,9 @@ info for a webhook on an app USAGE $ heroku webhooks:info ID [-a ] [-r ] +ARGUMENTS + ID ID of the webhook + FLAGS -a, --app= app to run command against -r, --remote= git remote of app to use @@ -164,7 +173,7 @@ EXAMPLES $ heroku webhooks:info 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/info.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/webhooks/info.ts)_ +_See code: [src/commands/webhooks/info.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/info.ts)_ ## `heroku webhooks:remove ID` @@ -188,7 +197,7 @@ EXAMPLES $ heroku webhooks:remove 99999999-9999-9999-9999-999999999999 ``` -_See code: [src/commands/webhooks/remove.ts](https://github.com/heroku/cli/blob/v9.3.2/packages/cli/src/commands/webhooks/remove.ts)_ +_See code: [src/commands/webhooks/remove.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/remove.ts)_ ## `heroku webhooks:update ID` @@ -198,6 +207,9 @@ updates a webhook in an app USAGE $ heroku webhooks:update ID -i -l -u [-a ] [-r ] [-s ] [-t ] +ARGUMENTS + ID ID of the webhook + FLAGS -a, --app= app to run command against -i, --include= (required) comma delimited event types your server will receive @@ -214,4 +226,4 @@ 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/v9.3.2/packages/cli/src/commands/webhooks/update.ts)_ +_See code: [src/commands/webhooks/update.ts](https://github.com/heroku/cli/blob/v9.4.0/packages/cli/src/commands/webhooks/update.ts)_ diff --git a/lerna.json b/lerna.json index e569f7fc86..fc8a53b61c 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "9.3.2", + "version": "9.4.0", "useWorkspaces": true, "npmClient": "yarn", "command": { diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index cfedc6c425..eeff84103d 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [9.4.0](https://github.com/heroku/cli/compare/v9.3.2...v9.4.0) (2024-11-11) + + +### Bug Fixes + +* access command error handling ([#3077](https://github.com/heroku/cli/issues/3077)) ([79188e5](https://github.com/heroku/cli/commit/79188e571b3b7cdbca85ce9012be92a93938dee3)) + + +### Features + +* **cli:** Adding disclaimer for plugin AI install ([#3065](https://github.com/heroku/cli/issues/3065)) ([80ab352](https://github.com/heroku/cli/commit/80ab352a5b68e96dba6d5a0ed900f6e1c166d98f)) + + + + + ## [9.3.2](https://github.com/heroku/cli/compare/v9.3.1...v9.3.2) (2024-10-23) **Note:** Version bump only for package heroku diff --git a/packages/cli/package.json b/packages/cli/package.json index 79c5e9928b..0c189b91e2 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,7 +1,7 @@ { "name": "heroku", "description": "CLI to interact with Heroku", - "version": "9.3.2", + "version": "9.4.0", "author": "Heroku", "bin": "./bin/run", "bugs": "https://github.com/heroku/cli/issues",