@@ -10,23 +10,17 @@ Built on top of [GAMADV-XTD3](https://github.com/taers232c/GAMADV-XTD3) and [GYB
1010
1111``` bash
1212$ compiler-admin -h
13- usage: compiler-admin [-h] [-v] {info,init,create,convert,delete,offboard,reset-password,restore,signout } ...
13+ usage: compiler-admin [-h] [-v] {info,init,user } ...
1414
1515positional arguments:
16- {info,init,create,convert,delete,offboard,reset-password,restore,signout}
17- info Print configuration and debugging information.
18- init Initialize a new admin project. This command should be run once before any others.
19- create Create a new user in the Compiler domain.
20- convert Convert a user account to a new type.
21- delete Delete a user account.
22- offboard Offboard a user account.
23- reset-password Reset a user' s password to a randomly generated string.
24- restore Restore an email backup from a prior offboarding.
25- signout Signs a user out from all active sessions.
16+ {info,init,user} The command to run
17+ info Print configuration and debugging information.
18+ init Initialize a new admin project. This command should be run once before any others.
19+ user Work with users in the Compiler org.
2620
2721options:
28- -h, --help show this help message and exit
29- -v, --version show program' s version number and exit
22+ -h, --help show this help message and exit
23+ -v, --version show program' s version number and exit
3024```
3125
3226## Getting started
@@ -60,11 +54,34 @@ The `init` commands follows the steps in the [GAMADV-XTD3 Wiki](https://github.c
6054
6155Additionally, GYB is used for Gmail backup/restore. See the [GYB Wiki](https://github.com/GAM-team/got-your-back/wiki) for more information.
6256
63- ## Creating a user
57+ ## Working with users
58+
59+ The following commands are available to work with users in the Compiler domain:
60+
61+ ```bash
62+ $ compiler-admin user -h
63+ usage: compiler-admin user [-h] {create,convert,delete,offboard,reset-password,restore,signout} ...
64+
65+ positional arguments:
66+ {create,convert,delete,offboard,reset-password,restore,signout}
67+ The user command to run.
68+ create Create a new user in the Compiler domain.
69+ convert Convert a user account to a new type.
70+ delete Delete a user account.
71+ offboard Offboard a user account.
72+ reset-password Reset a user' s password to a randomly generated string.
73+ restore Restore an email backup from a prior offboarding.
74+ signout Signs a user out from all active sessions.
75+
76+ options:
77+ -h, --help show this help message and exit
78+ ```
79+
80+ ### Creating a user
6481
6582``` bash
66- $ compiler-admin create -h
67- usage: compiler-admin create [-h] [--notify NOTIFY] username
83+ $ compiler-admin user create -h
84+ usage: compiler-admin user create [-h] [--notify NOTIFY] username
6885
6986positional arguments:
7087 username A Compiler user account name, sans domain.
@@ -76,11 +93,11 @@ options:
7693
7794Additional options are passed through to GAM, see more about [ GAM user create] ( https://github.com/taers232c/GAMADV-XTD3/wiki/Users#create-a-user )
7895
79- ## Convert a user
96+ ### Convert a user
8097
8198``` bash
82- $ compiler-admin convert -h
83- usage: compiler-admin convert [-h] username {contractor,partner,staff}
99+ $ compiler-admin user convert -h
100+ usage: compiler-admin user convert [-h] username {contractor,partner,staff}
84101
85102positional arguments:
86103 username A Compiler user account name, sans domain.
@@ -91,11 +108,11 @@ options:
91108 -h, --help show this help message and exit
92109```
93110
94- ## Offboarding a user
111+ ### Offboarding a user
95112
96113``` bash
97- $ compiler-admin offboard -h
98- usage: compiler-admin offboard [-h] [--alias ALIAS] [--force] username
114+ $ compiler-admin user offboard -h
115+ usage: compiler-admin user offboard [-h] [--alias ALIAS] [--force] username
99116
100117positional arguments:
101118 username A Compiler user account name, sans domain.
@@ -108,13 +125,13 @@ options:
108125
109126This script creates a local backup of `USER`' s inbox, see [Restore](# restore-an-email-backup)
110127
111- # # Restore an email backup
128+ # ## Restore an email backup
112129
113130Retore a backup from a prior [Offboarding](
# offboarding-a-user) into the `[email protected] ` account.114131
115132` ` ` bash
116- $ compiler-admin restore -h
117- usage: compiler-admin restore [-h] username
133+ $ compiler-admin user restore -h
134+ usage: compiler-admin user restore [-h] username
118135
119136positional arguments:
120137 username The user' s account name, sans domain.
0 commit comments