1 | Heroku Orgs CLI
|
2 | ===========
|
3 | [![npm version](https://badge.fury.io/js/heroku-orgs.svg)](http://badge.fury.io/js/heroku-orgs)
|
4 | [![Build Status](https://travis-ci.org/heroku/heroku-orgs.svg?branch=master)](https://travis-ci.org/heroku/heroku-orgs)
|
5 |
|
6 |
|
7 | ### Usage
|
8 |
|
9 | ```bash
|
10 | $ heroku orgs
|
11 | Usage: heroku orgs
|
12 |
|
13 | list the organizations that you are a member of
|
14 |
|
15 | --json # output in json format
|
16 | ```
|
17 |
|
18 | ```bash
|
19 | $ heroku orgs:open -o ORG
|
20 | Usage: heroku orgs:open
|
21 |
|
22 | open the organization interface in a browser window
|
23 |
|
24 | -o, --org ORG # organization to use
|
25 | ```
|
26 |
|
27 | ```bash
|
28 | $ heroku apps:join [--app APP]
|
29 | Usage: heroku apps:join
|
30 |
|
31 | add yourself to an organization app
|
32 |
|
33 | -a, --app APP # app to run command against
|
34 | -r, --remote REMOTE # git remote of app to run command against
|
35 | ```
|
36 |
|
37 | ```bash
|
38 | $ heroku apps:leave [--app APP]
|
39 | Usage: heroku apps:leave
|
40 |
|
41 | remove yourself from an organization app
|
42 |
|
43 | -a, --app APP # app to run command against
|
44 | -r, --remote REMOTE # git remote of app to run command against
|
45 | ```
|
46 |
|
47 | ```bash
|
48 | $ heroku apps:lock [--app APP]
|
49 | Usage: heroku apps:lock
|
50 |
|
51 | prevent organization members from joining an app
|
52 |
|
53 | -a, --app APP # app to run command against
|
54 | -r, --remote REMOTE # git remote of app to run command against
|
55 | ```
|
56 |
|
57 | ```bash
|
58 | $ heroku apps:unlock [--app APP]
|
59 | Usage: heroku apps:unlock
|
60 |
|
61 | unlock an app so any organization member can join
|
62 |
|
63 | -a, --app APP # app to run command against
|
64 | -r, --remote REMOTE # git remote of app to run command against
|
65 | ```
|
66 |
|
67 | ```bash
|
68 | $ heroku members
|
69 | list members of an organization
|
70 |
|
71 | -r, --role ROLE # filter by role
|
72 | --json # output in json format
|
73 | -o, --org ORG # organization to use
|
74 |
|
75 | Additional commands, type "heroku help COMMAND" for more details:
|
76 |
|
77 | members:add EMAIL [--org ORG] [--role ROLE] # adds a new member to an org
|
78 | members:remove EMAIL [--org ORG] # removes a member from an org
|
79 | members:set NAME [--org ORG] [--role ROLE] # change role of member in org
|
80 | ```
|
81 |
|
82 | ```bash
|
83 | $ heroku members:add EMAIL -o ORG
|
84 | Usage: heroku members:add EMAIL
|
85 |
|
86 | adds a user to an organization
|
87 |
|
88 | -r, --role ROLE # member role (admin, collaborator, member, owner)
|
89 | -o, --org ORG # organization to use
|
90 | ```
|
91 |
|
92 | ```bash
|
93 | $ heroku members:set EMAIL -r ROLE -o ORG
|
94 | Usage: heroku members:set EMAIL
|
95 |
|
96 | sets a members role in an organization
|
97 |
|
98 | -r, --role ROLE # member role (admin, collaborator, member, owner)
|
99 | -o, --org ORG # organization to use
|
100 | ```
|
101 |
|
102 | ```bash
|
103 | $ heroku members:remove EMAIL -o ORG
|
104 | Usage: heroku members:remove EMAIL
|
105 |
|
106 | removes a user from an organization
|
107 |
|
108 | -o, --org ORG # organization to use
|
109 | ```
|
110 |
|
111 | ```bash
|
112 | $ heroku apps:transfer RECIPIENT [--app APP]
|
113 | Usage: heroku apps:transfer RECIPIENT
|
114 |
|
115 | transfer an app to another user or organization
|
116 |
|
117 | -l, --locked # lock the app upon transfer
|
118 | -a, --app APP # app to run command against
|
119 | -r, --remote REMOTE # git remote of app to run command against
|
120 |
|
121 | Examples:
|
122 |
|
123 | $ heroku apps:transfer collaborator@example.com
|
124 | Transferring example to collaborator@example.com... done
|
125 |
|
126 | $ heroku apps:transfer acme-widgets
|
127 | Transferring example to acme-widgets... done
|
128 | ```
|
129 |
|
130 | ```bash
|
131 | $ heroku access [--app APP]
|
132 | Usage: heroku access
|
133 |
|
134 | list who has access to an application
|
135 |
|
136 | --json # output in json format
|
137 | -a, --app APP # app to run command against
|
138 | -r, --remote REMOTE # git remote of app to run command against
|
139 | ```
|
140 |
|
141 |
|
142 | ```bash
|
143 | $ heroku access:update EMAIL [--app APP]
|
144 |
|
145 | Usage: heroku access:update EMAIL
|
146 | Update existing collaborators in an org app
|
147 |
|
148 | --privileges PRIVILEGES # comma-delimited list of privileges to update (deploy,manage,operate,view)
|
149 | -a, --app APP # app to run command against
|
150 | -r, --remote REMOTE # git remote of app to run command against
|
151 |
|
152 | heroku access:update user@email.com --app APP --privileges deploy,manage,operate,view
|
153 | ```
|
154 |
|
155 | ```bash
|
156 | $ heroku access:add EMAIL [--app APP] [--privileges view,deploy,manage,operate]
|
157 | Usage: heroku access:add EMAIL
|
158 |
|
159 | Add new users to your app
|
160 |
|
161 | --privileges PRIVILEGES # list of privileges comma separated
|
162 | -a, --app APP # app to run command against
|
163 | -r, --remote REMOTE # git remote of app to run command against
|
164 |
|
165 | heroku access:add user@email.com --app APP # Add a collaborator to your app
|
166 |
|
167 | heroku access:add user@email.com --app APP --privileges view,deploy,manage,operate # privileges must be comma separated
|
168 | ```
|
169 |
|
170 | ```bash
|
171 | $ heroku access:remove EMAIL [--app APP]
|
172 | Usage: heroku access:remove EMAIL
|
173 |
|
174 | Remove users from your app
|
175 |
|
176 | -a, --app APP # app to run command against
|
177 | -r, --remote REMOTE # git remote of app to run command against
|
178 |
|
179 | heroku access:remove user@email.com --app APP
|
180 | ```
|
181 |
|
182 | ### Development
|
183 |
|
184 | First, please read [Developing CLI Plugins on Heroku's DevCenter](https://devcenter.heroku.com/articles/developing-toolbelt-plug-ins).
|
185 |
|
186 | #### Run Tests
|
187 |
|
188 | ```
|
189 | $ npm test
|
190 | ```
|
191 |
|
192 | #### Deploy
|
193 |
|
194 | ```
|
195 | $ npm version patch
|
196 | ```
|
197 |
|