chore: unhide multi-organization cli commands (#14693)

* chore: unhide multi-organization cli commands Multi-org is going into GA, unhide cli commands
2026-09-24 15:04:27 +08:00 · 2024-09-17 10:22:20 -05:00
parent 370f0b9020
commit be516f9686
38 changed files with 725 additions and 7 deletions
@@ -31,6 +31,7 @@ SUBCOMMANDS:
    netcheck          Print network debug information for DERP and STUN
    notifications     Manage Coder notifications
    open              Open a workspace
+    organizations     Organization related commands
    ping              Ping a workspace
    port-forward      Forward ports from a workspace to the local machine. For
                      reverse port forwarding, use "coder ssh -R".
@@ -0,0 +1,23 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations [flags] [subcommand]
+
+  Organization related commands
+
+  Aliases: organization, org, orgs
+
+SUBCOMMANDS:
+    create     Create a new organization.
+    members    Manage organization members
+    roles      Manage organization roles.
+    show       Show the organization. Using "selected" will show the selected
+               organization from the "--org" flag. Using "me" will show all
+               organizations you are a member of.
+
+OPTIONS:
+  -O, --org string, $CODER_ORGANIZATION
+          Select which organization (uuid or name) to use.
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,13 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations create [flags] <organization name>
+
+  Create a new organization.
+
+OPTIONS:
+  -y, --yes bool
+          Bypass prompts.
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,17 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations members
+
+  Manage organization members
+
+  Aliases: member
+
+SUBCOMMANDS:
+    add           Add a new member to the current organization
+    edit-roles    Edit organization member's roles
+    list          List all organization members
+    remove        Remove a new member to the current organization
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,9 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations members add <username | user_id>
+
+  Add a new member to the current organization
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,11 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations members edit-roles <username | user_id> [roles...]
+
+  Edit organization member's roles
+
+  Aliases: edit-role
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,16 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations members list [flags]
+
+  List all organization members
+
+OPTIONS:
+  -c, --column [username|name|user id|organization id|created at|updated at|organization roles] (default: username,organization roles)
+          Columns to display in table output.
+
+  -o, --output table|json (default: table)
+          Output format.
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,11 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations members remove <username | user_id>
+
+  Remove a new member to the current organization
+
+  Aliases: rm
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,15 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations roles
+
+  Manage organization roles.
+
+  Aliases: role
+
+SUBCOMMANDS:
+    edit    Edit an organization custom role
+    show    Show role(s)
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,29 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations roles edit [flags] <role_name>
+
+  Edit an organization custom role
+
+    - Run with an input.json file:
+  
+       $ coder roles edit --stdin < role.json
+
+OPTIONS:
+  -c, --column [name|display name|organization id|site permissions|organization permissions|user permissions] (default: name,display name,site permissions,organization permissions,user permissions)
+          Columns to display in table output.
+
+      --dry-run bool
+          Does all the work, but does not submit the final updated role.
+
+  -o, --output table|json (default: table)
+          Output format.
+
+      --stdin bool
+          Reads stdin for the json role definition to upload.
+
+  -y, --yes bool
+          Bypass prompts.
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,16 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations roles show [flags] [role_names ...]
+
+  Show role(s)
+
+OPTIONS:
+  -c, --column [name|display name|organization id|site permissions|organization permissions|user permissions] (default: name,display name,site permissions,organization permissions,user permissions)
+          Columns to display in table output.
+
+  -o, --output table|json (default: table)
+          Output format.
+
+———
+Run `coder --help` for a list of global options.
@@ -0,0 +1,38 @@
+coder v0.0.0-devel
+
+USAGE:
+  coder organizations show [flags] ["selected"|"me"|uuid|org_name]
+
+  Show the organization. Using "selected" will show the selected organization
+  from the "--org" flag. Using "me" will show all organizations you are a member
+  of.
+
+    - coder org show selected:
+  
+       $ Shows the organizations selected with '--org=<org_name>'. This
+  organization is the organization used by the cli.
+  
+    - coder org show me:
+  
+       $ List of all organizations you are a member of.
+  
+    - coder org show developers:
+  
+       $ Show organization with name 'developers'
+  
+    - coder org show 90ee1875-3db5-43b3-828e-af3687522e43:
+  
+       $ Show organization with the given ID.
+
+OPTIONS:
+  -c, --column [id|name|display name|icon|description|created at|updated at|default] (default: id,name,default)
+          Columns to display in table output.
+
+      --only-id bool
+          Only print the organization ID.
+
+  -o, --output text|table|json (default: text)
+          Output format.
+
+———
+Run `coder --help` for a list of global options.