synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): rework CLI docs (#6312)

Browse Source
This commit is contained in:
Ammar Bandukwala
2023-02-22 19:53:21 -06:00
committed by GitHub
parent 43e8ba0811
commit f6a8c360e5
71 changed files with 2342 additions and 2087 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/cli/coder_users.md
View File

@ -1,41 +1,21 @@
## coder users
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder users
Manage users
```
## Usage
```console
coder users [flags]
```
### Options
## Subcommands
```
-h, --help help for users
```
### Options inherited from parent commands
```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
```
### SEE ALSO
- [coder](coder.md) -
- [coder users activate](coder_users_activate.md) - Update a user's status to 'active'. Active users can fully interact with the platform
- [coder users create](coder_users_create.md) -
- [coder users list](coder_users_list.md) -
- [coder users show](coder_users_show.md) - Show a single user. Use 'me' to indicate the currently authenticated user.
- [coder users suspend](coder_users_suspend.md) - Update a user's status to 'suspended'. A suspended user cannot log into the platform
| Name | Purpose |
| ----------------------------------------------- | ------------------------------------------------------------------------------------- |
| [<code>activate</code>](./coder_users_activate) | Update a user's status to 'active'. Active users can fully interact with the platform |
| [<code>create</code>](./coder_users_create) | |
| [<code>list</code>](./coder_users_list) | |
| [<code>show</code>](./coder_users_show) | Show a single user. Use 'me' to indicate the currently authenticated user. |
| [<code>suspend</code>](./coder_users_suspend) | Update a user's status to 'suspended'. A suspended user cannot log into the platform |