Skip to content

Commit eaefc14

Browse files
committed
docs: update with alumni command
1 parent 6fb2e8d commit eaefc14

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,12 @@ The following commands are available to work with users in the Compiler domain:
114114
115115
```bash
116116
$ compiler-admin user -h
117-
usage: compiler-admin user [-h] {create,convert,delete,offboard,reset,restore,signout} ...
117+
usage: compiler-admin user [-h] {alumni,create,convert,delete,offboard,reset,restore,signout} ...
118118
119119
positional arguments:
120-
{create,convert,delete,offboard,reset,restore,signout}
120+
{alumni,create,convert,delete,offboard,reset,restore,signout}
121121
The user command to run.
122+
alumni Convert a user account to a Compiler alumni.
122123
create Create a new user in the Compiler domain.
123124
convert Convert a user account to a new type.
124125
delete Delete a user account.
@@ -151,15 +152,17 @@ Additional options are passed through to GAM, see more about [GAM user create](h
151152
152153
```bash
153154
$ compiler-admin user convert -h
154-
usage: compiler-admin user convert [-h] username {contractor,partner,staff}
155+
usage: compiler-admin user convert [-h] [--force] [--notify NOTIFY] username {alumni,contractor,partner,staff}
155156
156157
positional arguments:
157158
username A Compiler user account name, sans domain.
158-
{contractor,partner,staff}
159+
{alumni,contractor,partner,staff}
159160
Target account type for this conversion.
160161
161162
options:
162163
-h, --help show this help message and exit
164+
--force Don't ask for confirmation before conversion.
165+
--notify NOTIFY An email address to send the alumni's new password.
163166
```
164167
165168
### Offboarding a user

0 commit comments

Comments
 (0)