@heroku-cli/plugin-enterprise v5.0.0

Heroku CLI Enterprise Plugin

CLI to manage Heroku Enterprise Accounts

• Usage
• Commands

Usage

$ heroku plugins:install @heroku-cli/plugin-enterprise
$ heroku COMMAND
running command...
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Commands

• heroku enterprise
• heroku enterprise:audits
• heroku enterprise:audits:export [LOG]
• heroku enterprise:members
• heroku enterprise:members-add EMAIL
• heroku enterprise:members-remove EMAIL
• heroku enterprise:members:add EMAIL
• heroku enterprise:members:permissions:add EMAIL
• heroku enterprise:members:permissions:remove EMAIL
• heroku enterprise:members:remove EMAIL
• heroku enterprise:rename NEWACCOUNTNAME
• heroku enterprise:teams
• heroku enterprise:teams:create TEAM
• heroku enterprise:teams:remove TEAM
• heroku enterprise:usage:daily
• heroku enterprise:usage:monthly

heroku enterprise

list your enterprise accounts

USAGE
  $ heroku enterprise

DESCRIPTION
  list your enterprise accounts

EXAMPLES
  $ heroku enterprise

See code: src/commands/enterprise/index.ts

heroku enterprise:audits

list available audit logs for an enterprise account

USAGE
  $ heroku enterprise:audits -e <value> [--json] [-x | ]

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name
  -x, --extended                    show extra columns
      --json                        display as json

DESCRIPTION
  list available audit logs for an enterprise account

EXAMPLES
  $ heroku enterprise:audits --enterprise-account=account-name

See code: src/commands/enterprise/audits/index.ts

heroku enterprise:audits:export [LOG]

export an audit log for an enterprise account

USAGE
  $ heroku enterprise:audits:export [LOG] -e <value> [-d <value>] [-f]

ARGUMENTS
  LOG  audit log date (YYYY-MM)

FLAGS
  -d, --dest=<value>                download destination for the exported audit log
  -e, --enterprise-account=<value>  (required) enterprise account name
  -f, --force                       overwrite existing file during download

DESCRIPTION
  export an audit log for an enterprise account

EXAMPLES
  $ heroku enterprise:audits:export 2024-11 --enterprise-account=account-name

  $ heroku enterprise:audits:export 2024-11 --enterprise-account=account-name --dest=/tmp

  $ heroku enterprise:audits:export 2024-11 --enterprise-account=account-name --dest=/tmp/audit_report.json.gz

  $ heroku enterprise:audits:export 2024-11 --enterprise-account=account-name --dest=/tmp/audit_report.json.gz --force

See code: src/commands/enterprise/audits/export.ts

heroku enterprise:members

list members of the enterprise account and their permissions

USAGE
  $ heroku enterprise:members -e <value> [--columns <value> | ] [--sort <value>] [--filter <value>] [--output
    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name
      --columns=<value>             only show provided columns (comma-separated)
      --csv                         output is csv format [alias: --output=csv]
      --filter=<value>              filter property by partial string matching, ex: name=foo
      --no-header                   hide table header from output
      --no-truncate                 do not truncate output to fit screen
      --output=<option>             output in a more machine friendly format
                                    <options: csv|json|yaml>
      --sort=<value>                property to sort by (prepend '-' for descending)

DESCRIPTION
  list members of the enterprise account and their permissions

EXAMPLES
  $ heroku enterprise:members --enterprise-account=account-name

See code: src/commands/enterprise/members/index.ts

heroku enterprise:members-add EMAIL

add a member to an enterprise account

USAGE
  $ heroku enterprise:members-add EMAIL -e <value> -p <value>

ARGUMENTS
  EMAIL  email address of the team member

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name
  -p, --permissions=<value>         (required) permissions to grant the member (comma-separated)

DESCRIPTION
  add a member to an enterprise account

ALIASES
  $ heroku enterprise:members-add

EXAMPLES
  $ heroku enterprise:members:add member-email --enterprise-account=account-name --permissions=billing,create,manage,view

heroku enterprise:members-remove EMAIL

remove a member from an enterprise account

USAGE
  $ heroku enterprise:members-remove EMAIL -e <value>

ARGUMENTS
  EMAIL  email address of the team member

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name

DESCRIPTION
  remove a member from an enterprise account

ALIASES
  $ heroku enterprise:members-remove

EXAMPLES
  $ heroku enterprise:members:remove member-name --enterprise-account=account-name

heroku enterprise:members:add EMAIL

add a member to an enterprise account

USAGE
  $ heroku enterprise:members:add EMAIL -e <value> -p <value>

ARGUMENTS
  EMAIL  email address of the team member

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name
  -p, --permissions=<value>         (required) permissions to grant the member (comma-separated)

DESCRIPTION
  add a member to an enterprise account

ALIASES
  $ heroku enterprise:members-add

EXAMPLES
  $ heroku enterprise:members:add member-email --enterprise-account=account-name --permissions=billing,create,manage,view

See code: src/commands/enterprise/members/add.ts

heroku enterprise:members:permissions:add EMAIL

adds permissions to the member of an enterprise account

USAGE
  $ heroku enterprise:members:permissions:add EMAIL -e <value> -p <value>

ARGUMENTS
  EMAIL  email address of the member

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name
  -p, --permissions=<value>         (required) permissions to grant the member (comma-separated)

DESCRIPTION
  adds permissions to the member of an enterprise account

EXAMPLES
  $ heroku enterprise:members:permissions:add member-email --enterprise-account=account-name --permissions=billing,create,manage,view

See code: src/commands/enterprise/members/permissions/add.ts

heroku enterprise:members:permissions:remove EMAIL

removes permissions from the member of an enterprise account

USAGE
  $ heroku enterprise:members:permissions:remove EMAIL -e <value> -p <value>

ARGUMENTS
  EMAIL  email address of the member

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name
  -p, --permissions=<value>         (required) permissions to remove from the member (comma-separated)

DESCRIPTION
  removes permissions from the member of an enterprise account

EXAMPLES
  $ heroku enterprise:members:permissions:remove member-name --enterprise-account=account-name --permissions=billing,create,manage,view

See code: src/commands/enterprise/members/permissions/remove.ts

heroku enterprise:members:remove EMAIL

remove a member from an enterprise account

USAGE
  $ heroku enterprise:members:remove EMAIL -e <value>

ARGUMENTS
  EMAIL  email address of the team member

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name

DESCRIPTION
  remove a member from an enterprise account

ALIASES
  $ heroku enterprise:members-remove

EXAMPLES
  $ heroku enterprise:members:remove member-name --enterprise-account=account-name

See code: src/commands/enterprise/members/remove.ts

heroku enterprise:rename NEWACCOUNTNAME

rename the enterprise account

USAGE
  $ heroku enterprise:rename NEWACCOUNTNAME -e <value>

ARGUMENTS
  NEWACCOUNTNAME  new enterprise account name

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name

DESCRIPTION
  rename the enterprise account

EXAMPLES
  $ heroku enterprise:rename new-account-name --enterprise-account=account-name

See code: src/commands/enterprise/rename.ts

heroku enterprise:teams

list teams within an enterprise account

USAGE
  $ heroku enterprise:teams -e <value> [--columns <value> | ] [--sort <value>] [--filter <value>] [--output
    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name
      --columns=<value>             only show provided columns (comma-separated)
      --csv                         output is csv format [alias: --output=csv]
      --filter=<value>              filter property by partial string matching, ex: name=foo
      --no-header                   hide table header from output
      --no-truncate                 do not truncate output to fit screen
      --output=<option>             output in a more machine friendly format
                                    <options: csv|json|yaml>
      --sort=<value>                property to sort by (prepend '-' for descending)

DESCRIPTION
  list teams within an enterprise account

EXAMPLES
  $ heroku enterprise:teams --enterprise-account=account-name

See code: src/commands/enterprise/teams/index.ts

heroku enterprise:teams:create TEAM

create a team in an enterprise account

USAGE
  $ heroku enterprise:teams:create TEAM -e <value>

ARGUMENTS
  TEAM  name of the team to create

FLAGS
  -e, --enterprise-account=<value>  (required) enterprise account name

DESCRIPTION
  create a team in an enterprise account

EXAMPLES
  $ heroku enterprise:teams:create team-name --enterprise-account=account-name

See code: src/commands/enterprise/teams/create.ts

heroku enterprise:teams:remove TEAM

remove a team from an enterprise account

USAGE
  $ heroku enterprise:teams:remove TEAM

ARGUMENTS
  TEAM  name of the team to remove

DESCRIPTION
  remove a team from an enterprise account

EXAMPLES
  $ heroku enterprise:teams:remove team-name

See code: src/commands/enterprise/teams/remove.ts

heroku enterprise:usage:daily

list the daily usage for an enterprise account or team

USAGE
  $ heroku enterprise:usage:daily (--end-date <value> --start-date <value>) [-e <value> | -t <value>] [--columns <value> | ]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml | --no-truncate | --csv] [--no-header | ]

FLAGS
  -e, --enterprise-account=<value>  enterprise account name
  -t, --team=<value>                team name
      --columns=<value>             only show provided columns (comma-separated)
      --csv                         output is csv format
      --end-date=<value>            (required) end date of the usage period, inclusive, cannot be more than 31 days
                                    after the start date (YYYY-MM-DD)
      --filter=<value>              filter property by partial string matching, ex: name=foo
      --no-header                   hide table header from output
      --no-truncate                 do not truncate output to fit screen
      --output=<option>             output in a more machine friendly format
                                    <options: csv|json|yaml>
      --sort=<value>                property to sort by (prepend '-' for descending)
      --start-date=<value>          (required) start date of the usage period, cannot be more than 6 months prior to
                                    today (YYYY-MM-DD)

DESCRIPTION
  list the daily usage for an enterprise account or team
  Displays the daily usage data for an enterprise account or team.

  NOTE: While we strive to provide the most accurate usage information, the data
  presented here may not reflect license usage or billing for your account.

EXAMPLES
  $ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15

  $ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='team,app,dyno,data'

  $ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='team,app,dyno,data' --sort='-data,app'

  $ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='team,app,dyno,data' --filter='app=myapp'

  $ heroku enterprise:usage:daily --enterprise-account=account-name --start-date=2019-01-01 --end-date=2019-01-15 --csv

  $ heroku enterprise:usage:daily --team=team-name --start-date=2019-01-01 --end-date=2019-01-15

  $ heroku enterprise:usage:daily --team=team-name --start-date=2019-01-01 --end-date=2019-01-15 --columns='app,dyno,data' --sort='-data,app'

  $ heroku enterprise:usage:daily --team=team-name --start-date=2019-01-01 --end-date=2019-01-15 --csv

See code: src/commands/enterprise/usage/daily.ts

heroku enterprise:usage:monthly

list the monthly usage for an enterprise account or team

USAGE
  $ heroku enterprise:usage:monthly [-e <value> | -t <value>] [--end-date <value> --start-date <value>] [--columns <value> | ]
    [--sort <value>] [--filter <value>] [--output csv|json|yaml | --no-truncate | --csv] [--no-header | ]

FLAGS
  -e, --enterprise-account=<value>  enterprise account name
  -t, --team=<value>                team name
      --columns=<value>             only show provided columns (comma-separated)
      --csv                         output is csv format
      --end-date=<value>            end date of the usage period, inclusive (YYYY-MM)
      --filter=<value>              filter property by partial string matching, ex: name=foo
      --no-header                   hide table header from output
      --no-truncate                 do not truncate output to fit screen
      --output=<option>             output in a more machine friendly format
                                    <options: csv|json|yaml>
      --sort=<value>                property to sort by (prepend '-' for descending)
      --start-date=<value>          start date of the usage period, defaults to current month if not provided (YYYY-MM)

DESCRIPTION
  list the monthly usage for an enterprise account or team
  Displays the monthly usage data for an enterprise account or team.

  NOTE: While we strive to provide the most accurate usage information, the data
  presented here may not reflect license usage or billing for your account.

EXAMPLES
  $ heroku enterprise:usage:monthly --enterprise-account=account-name

  $ heroku enterprise:usage:monthly --enterprise-account=account-name --columns='team,app,dyno,data'

  $ heroku enterprise:usage:monthly --enterprise-account=account-name --columns='team,app,dyno,data' --sort='-data,app'

  $ heroku enterprise:usage:monthly --enterprise-account=account-name --columns='team,app,dyno,data' --filter='app=myapp'

  $ heroku enterprise:usage:monthly --enterprise-account=account-name --csv

  $ heroku enterprise:usage:monthly --team=team-name --start-date 2019-01

  $ heroku enterprise:usage:monthly --team=team-name --start-date 2019-01 --end-date 2019-03

  $ heroku enterprise:usage:monthly --team=team-name --columns='app,dyno,data' --sort='-data,app'

  $ heroku enterprise:usage:monthly --team=team-name --csv

See code: src/commands/enterprise/usage/monthly.ts