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

* chore: unhide multi-organization cli commands

Multi-org is going into GA, unhide cli commands
This commit is contained in:
Steven Masley
2024-09-17 10:22:20 -05:00
committed by GitHub
parent 370f0b9020
commit be516f9686
38 changed files with 725 additions and 7 deletions
+1
View File
@@ -32,6 +32,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
| [<code>logout</code>](./logout.md) | Unauthenticate your local session |
| [<code>netcheck</code>](./netcheck.md) | Print network debug information for DERP and STUN |
| [<code>notifications</code>](./notifications.md) | Manage Coder notifications |
| [<code>organizations</code>](./organizations.md) | Organization related commands |
| [<code>port-forward</code>](./port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
| [<code>publickey</code>](./publickey.md) | Output your Coder public key used for Git operations |
| [<code>reset-password</code>](./reset-password.md) | Directly connect to the database to reset a user's password |
+37
View File
@@ -0,0 +1,37 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations
Organization related commands
Aliases:
- organization
- org
- orgs
## Usage
```console
coder organizations [flags] [subcommand]
```
## Subcommands
| Name | Purpose |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [<code>show</code>](./organizations_show.md) | 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. |
| [<code>create</code>](./organizations_create.md) | Create a new organization. |
| [<code>members</code>](./organizations_members.md) | Manage organization members |
| [<code>roles</code>](./organizations_roles.md) | Manage organization roles. |
## Options
### -O, --org
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
+21
View File
@@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations create
Create a new organization.
## Usage
```console
coder organizations create [flags] <organization name>
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.
+24
View File
@@ -0,0 +1,24 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members
Manage organization members
Aliases:
- member
## Usage
```console
coder organizations members
```
## Subcommands
| Name | Purpose |
| ---------------------------------------------------------------- | ----------------------------------------------- |
| [<code>list</code>](./organizations_members_list.md) | List all organization members |
| [<code>edit-roles</code>](./organizations_members_edit-roles.md) | Edit organization member's roles |
| [<code>add</code>](./organizations_members_add.md) | Add a new member to the current organization |
| [<code>remove</code>](./organizations_members_remove.md) | Remove a new member to the current organization |
+11
View File
@@ -0,0 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members add
Add a new member to the current organization
## Usage
```console
coder organizations members add <username | user_id>
```
+15
View File
@@ -0,0 +1,15 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members edit-roles
Edit organization member's roles
Aliases:
- edit-role
## Usage
```console
coder organizations members edit-roles <username | user_id> [roles...]
```
+31
View File
@@ -0,0 +1,31 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members list
List all organization members
## Usage
```console
coder organizations members list [flags]
```
## Options
### -c, --column
| | |
| ------- | --------------------------------------------------------------------------------------------------- |
| Type | <code>[username\|name\|user id\|organization id\|created at\|updated at\|organization roles]</code> |
| Default | <code>username,organization roles</code> |
Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
+15
View File
@@ -0,0 +1,15 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members remove
Remove a new member to the current organization
Aliases:
- rm
## Usage
```console
coder organizations members remove <username | user_id>
```
+22
View File
@@ -0,0 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles
Manage organization roles.
Aliases:
- role
## Usage
```console
coder organizations roles
```
## Subcommands
| Name | Purpose |
| -------------------------------------------------- | -------------------------------- |
| [<code>show</code>](./organizations_roles_show.md) | Show role(s) |
| [<code>edit</code>](./organizations_roles_edit.md) | Edit an organization custom role |
+63
View File
@@ -0,0 +1,63 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles edit
Edit an organization custom role
## Usage
```console
coder organizations roles edit [flags] <role_name>
```
## Description
```console
- Run with an input.json file:
$ coder roles edit --stdin < role.json
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.
### --dry-run
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Does all the work, but does not submit the final updated role.
### --stdin
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Reads stdin for the json role definition to upload.
### -c, --column
| | |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
+31
View File
@@ -0,0 +1,31 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles show
Show role(s)
## Usage
```console
coder organizations roles show [flags] [role_names ...]
```
## Options
### -c, --column
| | |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
+59
View File
@@ -0,0 +1,59 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations 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.
## Usage
```console
coder organizations show [flags] ["selected"|"me"|uuid|org_name]
```
## Description
```console
- 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
### --only-id
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Only print the organization ID.
### -c, --column
| | |
| ------- | ----------------------------------------------------------------------------------------- |
| Type | <code>[id\|name\|display name\|icon\|description\|created at\|updated at\|default]</code> |
| Default | <code>id,name,default</code> |
Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------------ |
| Type | <code>text\|table\|json</code> |
| Default | <code>text</code> |
Output format.
+1
View File
@@ -19,3 +19,4 @@ coder provisionerd
| Name | Purpose |
| --------------------------------------------- | ------------------------ |
| [<code>start</code>](./provisionerd_start.md) | Run a provisioner daemon |
| [<code>keys</code>](./provisionerd_keys.md) | Manage provisioner keys |
+23
View File
@@ -0,0 +1,23 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys
Manage provisioner keys
Aliases:
- key
## Usage
```console
coder provisionerd keys
```
## Subcommands
| Name | Purpose |
| ---------------------------------------------------- | ---------------------------------------- |
| [<code>create</code>](./provisionerd_keys_create.md) | Create a new provisioner key |
| [<code>list</code>](./provisionerd_keys_list.md) | List provisioner keys in an organization |
| [<code>delete</code>](./provisionerd_keys_delete.md) | Delete a provisioner key |
+31
View File
@@ -0,0 +1,31 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys create
Create a new provisioner key
## Usage
```console
coder provisionerd keys create [flags] <name>
```
## Options
### -t, --tag
| | |
| ----------- | ------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
Tags to filter provisioner jobs by.
### -O, --org
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
+34
View File
@@ -0,0 +1,34 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys delete
Delete a provisioner key
Aliases:
- rm
## Usage
```console
coder provisionerd keys delete [flags] <name>
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.
### -O, --org
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
+26
View File
@@ -0,0 +1,26 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys list
List provisioner keys in an organization
Aliases:
- ls
## Usage
```console
coder provisionerd keys list [flags]
```
## Options
### -O, --org
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.