# @heroku-cli/plugin-orgs-v5

> CLI to manage Heroku Organizations

Latest version **8.11.2** (published 2024-04-11) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @heroku-cli/plugin-orgs-v5
pnpm add @heroku-cli/plugin-orgs-v5
yarn add @heroku-cli/plugin-orgs-v5
bun add @heroku-cli/plugin-orgs-v5
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 8.11.2 |
| Published | 2024-04-11 |
| First published | 2018-06-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 56.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 888 |
| Author | Raul Barroso @raulb |
| Maintainers | sbosio_sf, hillzbot2000, kdreyeroren, beanieboi, beckychen, xx-sfdc-npm, kpremkumar, abhinavkoul, daniel.bright, justinwilaby-sf, cv88, jlopezdan, jmonreal, jondaniel-sfdc, dhagberg-sf, jmorrell-sfdc, elzoona, cmarcojos, gkommineni, vlazuka, nlanatta, lucaszhou, mars, mimen, wchrisjohnson, cbaxtersf, heroku-front-end, bsperlingsf, zli-sf, 7ftz, joanneyeung, montes_heroku, jwadsworthsf, jheikes, lmckenzie, sarassassin, pfuente, reidmix, mbuschheroku, k.plenty, eblack, sheax0r, k80bowman, rdagg-hero, grundy.g, robinson.m, tcareysmith-sfdc, ptemporini, paulaprado18, harish.457, ntonollier |
| Keywords | heroku-plugin |

## Links

- npm: https://www.npmjs.com/package/@heroku-cli/plugin-orgs-v5
- Repository: https://github.com/heroku/cli
- Homepage: https://github.com/heroku/cli/tree/main/packages/orgs-v5
- Issues: https://github.com/heroku/cli/issues
- npm.io page: https://npm.io/package/@heroku-cli/plugin-orgs-v5

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.6
- [lodash.flatten](https://npm.io/package/lodash.flatten.md) ^4.4.0
- [heroku-cli-util](https://npm.io/package/heroku-cli-util.md) ^8.0.11
- [@heroku-cli/command](https://npm.io/package/@heroku-cli/command.md) ^9.0.2

## Recent versions

- 8.11.2 (latest) — 2024-04-11
- 8.11.1-beta.6 (beta) — 2024-03-25
- 9.0.0-dev.0 (dev) — 2023-11-08
- 9.0.0-alpha.0 (alpha) — 2023-10-04
- 8.11.1 — 2024-03-25
- 8.11.0 — 2024-03-21
- 8.11.0-beta.3 — 2024-03-19
- 8.11.0-beta.2 — 2024-03-15
- 8.11.0-beta.1 — 2024-03-15
- 8.11.0-beta.0 — 2024-03-13
- 8.10.1-beta.0 — 2024-03-12
- 8.10.0 — 2024-02-20
- 8.9.1-beta.0 — 2024-02-16
- 8.8.0 — 2024-02-08
- 8.7.2-beta.3 — 2024-01-22
- … 66 more at https://npm.io/package/@heroku-cli/plugin-orgs-v5/versions

## README

Heroku Orgs CLI [![CircleCI](https://circleci.com/gh/heroku/heroku-orgs/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/heroku-orgs/tree/master)
===========
[![Code Climate](https://codeclimate.com/github/heroku/heroku-orgs/badges/gpa.svg)](https://codeclimate.com/github/heroku/heroku-orgs)
[![npm version](https://badge.fury.io/js/heroku-orgs.svg)](https://badge.fury.io/js/heroku-orgs)
[![License](https://img.shields.io/github/license/heroku/heroku-orgs.svg)](https://github.com/heroku/heroku-orgs/blob/master/LICENSE)

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

### Available commands

https://github.com/heroku/heroku-orgs/blob/master/index.js.

### Development

First, please read [Developing CLI Plugins on Heroku's DevCenter](https://devcenter.heroku.com/articles/developing-toolbelt-plug-ins).

#### Run Tests

```
$ npm test
```

#### Deploy

1. Release a new version of this npm package.

  ```
  $ npm version patch/minor/major
  ```

2. Open a new pr in https://github.com/heroku/cli/blob/master/package.json, updating to the appropriate heroku-orgs version.

#### Commands

<!-- commands -->
* [`heroku access`](#heroku-access)
* [`heroku access:add EMAIL`](#heroku-accessadd-email)
* [`heroku access:remove EMAIL`](#heroku-accessremove-email)
* [`heroku access:update EMAIL`](#heroku-accessupdate-email)
* [`heroku apps:join`](#heroku-appsjoin)
* [`heroku apps:leave`](#heroku-appsleave)
* [`heroku apps:lock`](#heroku-appslock)
* [`heroku apps:transfer RECIPIENT`](#heroku-appstransfer-recipient)
* [`heroku apps:unlock`](#heroku-appsunlock)
* [`heroku join`](#heroku-join)
* [`heroku leave`](#heroku-leave)
* [`heroku lock`](#heroku-lock)
* [`heroku members`](#heroku-members)
* [`heroku members:add EMAIL`](#heroku-membersadd-email)
* [`heroku members:remove EMAIL`](#heroku-membersremove-email)
* [`heroku members:set EMAIL`](#heroku-membersset-email)
* [`heroku orgs`](#heroku-orgs)
* [`heroku orgs:open`](#heroku-orgsopen)
* [`heroku teams`](#heroku-teams)
* [`heroku unlock`](#heroku-unlock)

## `heroku access`

list who has access to an app

```
USAGE
  $ heroku access -a <value> [--json] [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
  --json                output in json format

DESCRIPTION
  list who has access to an app
```

## `heroku access:add EMAIL`

add new users to your app

```
USAGE
  $ heroku access:add EMAIL -a <value> [-p <value>] [-r <value>]

FLAGS
  -a, --app=<value>          (required) app to run command against
  -p, --permissions=<value>  list of permissions comma separated
  -r, --remote=<value>       git remote of app to use

DESCRIPTION
  add new users to your app


EXAMPLES
  $ heroku access:add user@email.com --app APP # add a collaborator to your app

  $ heroku access:add user@email.com --app APP --permissions deploy,manage,operate # permissions must be comma separated
```

## `heroku access:remove EMAIL`

remove users from a team app

```
USAGE
  $ heroku access:remove EMAIL -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  remove users from a team app


EXAMPLES
  $ heroku access:remove user@email.com --app APP
```

## `heroku access:update EMAIL`

update existing collaborators on an team app

```
USAGE
  $ heroku access:update EMAIL -a <value> [-p <value>] [-r <value>]

FLAGS
  -a, --app=<value>          (required) app to run command against
  -p, --permissions=<value>  comma-delimited list of permissions to update (deploy,manage,operate)
  -r, --remote=<value>       git remote of app to use

DESCRIPTION
  update existing collaborators on an team app


EXAMPLES
  $ heroku access:update user@email.com --app APP --permissions deploy,manage,operate
```

## `heroku apps:join`

add yourself to a team app

```
USAGE
  $ heroku apps:join -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  add yourself to a team app
```

## `heroku apps:leave`

remove yourself from a team app

```
USAGE
  $ heroku apps:leave -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  remove yourself from a team app
```

## `heroku apps:lock`

prevent team members from joining an app

```
USAGE
  $ heroku apps:lock -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  prevent team members from joining an app
```

## `heroku apps:transfer RECIPIENT`

transfer applications to another user or team

```
USAGE
  $ heroku apps:transfer RECIPIENT [-l] [--bulk] [-a <value>] [-r <value>]

ARGUMENTS
  RECIPIENT  user or team to transfer applications to

FLAGS
  -a, --app=<value>     app to run command against
  -l, --locked          lock the app upon transfer
  -r, --remote=<value>  git remote of app to use
  --bulk                transfer applications in bulk

DESCRIPTION
  transfer applications to another user or team


EXAMPLES
  $ heroku apps:transfer collaborator@example.com
  Transferring example to collaborator@example.com... done
  $ heroku apps:transfer acme-widgets
  Transferring example to acme-widgets... done
  $ heroku apps:transfer --bulk acme-widgets
  ...
```

## `heroku apps:unlock`

unlock an app so any team member can join

```
USAGE
  $ heroku apps:unlock -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  unlock an app so any team member can join
```

## `heroku join`

add yourself to a team app

```
USAGE
  $ heroku join -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  add yourself to a team app
```

## `heroku leave`

remove yourself from a team app

```
USAGE
  $ heroku leave -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  remove yourself from a team app
```

## `heroku lock`

prevent team members from joining an app

```
USAGE
  $ heroku lock -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  prevent team members from joining an app
```

## `heroku members`

list members of a team

```
USAGE
  $ heroku members [-r <value>] [--pending] [--json] [-t <value>]

FLAGS
  -r, --role=<value>  filter by role
  -t, --team=<value>  team to use
  --json              output in json format
  --pending           filter by pending team invitations

DESCRIPTION
  list members of a team
```

## `heroku members:add EMAIL`

adds a user to a team

```
USAGE
  $ heroku members:add EMAIL -r <value> [-t <value>]

FLAGS
  -r, --role=<value>  (required) member role (admin, collaborator, member, owner)
  -t, --team=<value>  team to use

DESCRIPTION
  adds a user to a team
```

## `heroku members:remove EMAIL`

removes a user from a team

```
USAGE
  $ heroku members:remove EMAIL [-t <value>]

FLAGS
  -t, --team=<value>  team to use

DESCRIPTION
  removes a user from a team
```

## `heroku members:set EMAIL`

sets a members role in a team

```
USAGE
  $ heroku members:set EMAIL -r <value> [-t <value>]

FLAGS
  -r, --role=<value>  (required) member role (admin, collaborator, member, owner)
  -t, --team=<value>  team to use

DESCRIPTION
  sets a members role in a team
```

## `heroku orgs`

list the teams that you are a member of

```
USAGE
  $ heroku orgs [--json] [--enterprise]

FLAGS
  --enterprise  filter by enterprise teams
  --json        output in json format

DESCRIPTION
  list the teams that you are a member of
```

## `heroku orgs:open`

open the team interface in a browser window

```
USAGE
  $ heroku orgs:open [-t <value>]

FLAGS
  -t, --team=<value>  team to use

DESCRIPTION
  open the team interface in a browser window
```

## `heroku teams`

list the teams that you are a member of

```
USAGE
  $ heroku teams [--json]

FLAGS
  --json  output in json format

DESCRIPTION
  list the teams that you are a member of

  Use heroku members:* to manage team members.
```

## `heroku unlock`

unlock an app so any team member can join

```
USAGE
  $ heroku unlock -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  unlock an app so any team member can join
```
<!-- commandsstop -->

---
_Source: https://npm.io/package/@heroku-cli/plugin-orgs-v5 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
