synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-08 11:39: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

73
docs/cli/coder_server_create-admin-user.md
View File

@ -1,41 +1,54 @@
## coder server create-admin-user
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder server create-admin-user
Create a new admin user with the given username, email and password and adds it to every organization.
```
## Usage
```console
coder server create-admin-user [flags]
```
### Options
## Flags
```
--email string The email of the new user. If not specified, you will be prompted via stdin. Consumes $CODER_EMAIL.
-h, --help help for create-admin-user
--password string The password of the new user. If not specified, you will be prompted via stdin. Consumes $CODER_PASSWORD.
--postgres-url string URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will be used (Coder must not be already running in this case). Consumes $CODER_POSTGRES_URL.
--ssh-keygen-algorithm string The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". Consumes $CODER_SSH_KEYGEN_ALGORITHM. (default "ed25519")
--username string The username of the new user. If not specified, you will be prompted via stdin. Consumes $CODER_USERNAME.
```
### --email
### Options inherited from parent commands
The email of the new user. If not specified, you will be prompted via stdin.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_EMAIL</code> |
```
--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
```
### --password
### SEE ALSO
The password of the new user. If not specified, you will be prompted via stdin.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PASSWORD</code> |
- [coder server](coder_server.md) - Start a Coder server
### --postgres-url
URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will be used (Coder must not be already running in this case).
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_POSTGRES_URL</code> |
### --ssh-keygen-algorithm
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
| Default | <code>ed25519</code> |
### --username
The username of the new user. If not specified, you will be prompted via stdin.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_USERNAME</code> |