15577: Add a way to skip SDK building to streamline doc writing
[arvados.git] / doc / install / cheat_sheet.html.textile.liquid
index 115c62e0d3107722e484d181a5ec4b5f057ea05a..ef0c80e71c27d250b2ac5df21b0bd4b45e5abeff 100644 (file)
@@ -1,8 +1,13 @@
 ---
 layout: default
-navsection: installguide
-title: Cheat Sheet
+navsection: admin
+title: User management at the CLI
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
 h3. Workbench: user management
 
@@ -23,12 +28,32 @@ arv virtual_machine create --virtual-machine '{"hostname":"xxxxxxxchangeme.examp
 
 h3. CLI: Activate user
 
+Note this bypasses user agreements checks, and does not set up the user with a default git repository or VM login.
+
 <pre>
 user_uuid=xxxxxxxchangeme
 
 arv user update --uuid "$user_uuid" --user '{"is_active":true}'
 </pre>
 
+h3. CLI: Setup a user
+
+This creates a default git repository and VM login.
+
+<pre>
+user_uuid=xxxxxxxchangeme
+
+arv user setup --uuid "$user_uuid"
+</pre>
+
+h3. CLI: Deactivate user
+
+<pre>
+user_uuid=xxxxxxxchangeme
+
+arv user unsetup --uuid "$user_uuid"
+</pre>
+
 h3. User &rarr; VM
 
 Give @$user_uuid@ permission to log in to @$vm_uuid@ as @$target_username@