mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat(docs): rework CLI docs (#6312)
This commit is contained in:
@@ -1,43 +1,27 @@
|
||||
## coder users show
|
||||
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
||||
|
||||
# coder users show
|
||||
|
||||
Show a single user. Use 'me' to indicate the currently authenticated user.
|
||||
|
||||
```
|
||||
## Usage
|
||||
|
||||
```console
|
||||
coder users show <username|user_id|'me'> [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
## Examples
|
||||
|
||||
```
|
||||
```console
|
||||
$ coder users show me
|
||||
```
|
||||
|
||||
### Options
|
||||
## Flags
|
||||
|
||||
```
|
||||
-h, --help help for show
|
||||
-o, --output string Output format. Available formats: table, json (default "table")
|
||||
```
|
||||
### --output, -o
|
||||
|
||||
### 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 users](coder_users.md) - Manage users
|
||||
Output format. Available formats: table, json
|
||||
<br/>
|
||||
| | |
|
||||
| --- | --- |
|
||||
| Default | <code>table</code> |
|
||||
|
||||
Reference in New Issue
Block a user