mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore(cli): replace clibase with external coder/serpent (#12252)
This commit is contained in:
Ammar Bandukwala
Generated
+268
-268
@@ -529,260 +529,6 @@
|
||||
| ----------------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------ |
|
||||
| `report_interval` | integer | false | | Report interval is the duration after which the agent should send stats again. |
|
||||
|
||||
## clibase.Annotations
|
||||
|
||||
```json
|
||||
{
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ---------------- | ------ | -------- | ------------ | ----------- |
|
||||
| `[any property]` | string | false | | |
|
||||
|
||||
## clibase.Group
|
||||
|
||||
```json
|
||||
{
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {},
|
||||
"yaml": "string"
|
||||
},
|
||||
"yaml": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------- | ------------------------------ | -------- | ------------ | ----------- |
|
||||
| `description` | string | false | | |
|
||||
| `name` | string | false | | |
|
||||
| `parent` | [clibase.Group](#clibasegroup) | false | | |
|
||||
| `yaml` | string | false | | |
|
||||
|
||||
## clibase.HostPort
|
||||
|
||||
```json
|
||||
{
|
||||
"host": "string",
|
||||
"port": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------ | ------ | -------- | ------------ | ----------- |
|
||||
| `host` | string | false | | |
|
||||
| `port` | string | false | | |
|
||||
|
||||
## clibase.Option
|
||||
|
||||
```json
|
||||
{
|
||||
"annotations": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
},
|
||||
"default": "string",
|
||||
"description": "string",
|
||||
"env": "string",
|
||||
"flag": "string",
|
||||
"flag_shorthand": "string",
|
||||
"group": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {},
|
||||
"yaml": "string"
|
||||
},
|
||||
"yaml": "string"
|
||||
},
|
||||
"hidden": true,
|
||||
"name": "string",
|
||||
"required": true,
|
||||
"use_instead": [
|
||||
{
|
||||
"annotations": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
},
|
||||
"default": "string",
|
||||
"description": "string",
|
||||
"env": "string",
|
||||
"flag": "string",
|
||||
"flag_shorthand": "string",
|
||||
"group": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {},
|
||||
"yaml": "string"
|
||||
},
|
||||
"yaml": "string"
|
||||
},
|
||||
"hidden": true,
|
||||
"name": "string",
|
||||
"required": true,
|
||||
"use_instead": [],
|
||||
"value": null,
|
||||
"value_source": "",
|
||||
"yaml": "string"
|
||||
}
|
||||
],
|
||||
"value": null,
|
||||
"value_source": "",
|
||||
"yaml": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ---------------- | ------------------------------------------ | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `annotations` | [clibase.Annotations](#clibaseannotations) | false | | Annotations enable extensions to clibase higher up in the stack. It's useful for help formatting and documentation generation. |
|
||||
| `default` | string | false | | Default is parsed into Value if set. |
|
||||
| `description` | string | false | | |
|
||||
| `env` | string | false | | Env is the environment variable used to configure this option. If unset, environment configuring is disabled. |
|
||||
| `flag` | string | false | | Flag is the long name of the flag used to configure this option. If unset, flag configuring is disabled. |
|
||||
| `flag_shorthand` | string | false | | Flag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used. |
|
||||
| `group` | [clibase.Group](#clibasegroup) | false | | Group is a group hierarchy that helps organize this option in help, configs and other documentation. |
|
||||
| `hidden` | boolean | false | | |
|
||||
| `name` | string | false | | |
|
||||
| `required` | boolean | false | | Required means this value must be set by some means. It requires `ValueSource != ValueSourceNone` If `Default` is set, then `Required` is ignored. |
|
||||
| `use_instead` | array of [clibase.Option](#clibaseoption) | false | | Use instead is a list of options that should be used instead of this one. The field is used to generate a deprecation warning. |
|
||||
| `value` | any | false | | Value includes the types listed in values.go. |
|
||||
| `value_source` | [clibase.ValueSource](#clibasevaluesource) | false | | |
|
||||
| `yaml` | string | false | | Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled. |
|
||||
|
||||
## clibase.Regexp
|
||||
|
||||
```json
|
||||
{}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
_None_
|
||||
|
||||
## clibase.Struct-array_codersdk_ExternalAuthConfig
|
||||
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"app_install_url": "string",
|
||||
"app_installations_url": "string",
|
||||
"auth_url": "string",
|
||||
"client_id": "string",
|
||||
"device_code_url": "string",
|
||||
"device_flow": true,
|
||||
"display_icon": "string",
|
||||
"display_name": "string",
|
||||
"extra_token_keys": ["string"],
|
||||
"id": "string",
|
||||
"no_refresh": true,
|
||||
"regex": "string",
|
||||
"scopes": ["string"],
|
||||
"token_url": "string",
|
||||
"type": "string",
|
||||
"validate_url": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------- | ------------------------------------------------------------------- | -------- | ------------ | ----------- |
|
||||
| `value` | array of [codersdk.ExternalAuthConfig](#codersdkexternalauthconfig) | false | | |
|
||||
|
||||
## clibase.Struct-array_codersdk_LinkConfig
|
||||
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"icon": "bug",
|
||||
"name": "string",
|
||||
"target": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------- | --------------------------------------------------- | -------- | ------------ | ----------- |
|
||||
| `value` | array of [codersdk.LinkConfig](#codersdklinkconfig) | false | | |
|
||||
|
||||
## clibase.URL
|
||||
|
||||
```json
|
||||
{
|
||||
"forceQuery": true,
|
||||
"fragment": "string",
|
||||
"host": "string",
|
||||
"omitHost": true,
|
||||
"opaque": "string",
|
||||
"path": "string",
|
||||
"rawFragment": "string",
|
||||
"rawPath": "string",
|
||||
"rawQuery": "string",
|
||||
"scheme": "string",
|
||||
"user": {}
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------- | ---------------------------- | -------- | ------------ | -------------------------------------------------- |
|
||||
| `forceQuery` | boolean | false | | append a query ('?') even if RawQuery is empty |
|
||||
| `fragment` | string | false | | fragment for references, without '#' |
|
||||
| `host` | string | false | | host or host:port |
|
||||
| `omitHost` | boolean | false | | do not emit empty host (authority) |
|
||||
| `opaque` | string | false | | encoded opaque data |
|
||||
| `path` | string | false | | path (relative paths may omit leading slash) |
|
||||
| `rawFragment` | string | false | | encoded fragment hint (see EscapedFragment method) |
|
||||
| `rawPath` | string | false | | encoded path hint (see EscapedPath method) |
|
||||
| `rawQuery` | string | false | | encoded query values, without '?' |
|
||||
| `scheme` | string | false | | |
|
||||
| `user` | [url.Userinfo](#urluserinfo) | false | | username and password information |
|
||||
|
||||
## clibase.ValueSource
|
||||
|
||||
```json
|
||||
""
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
#### Enumerated Values
|
||||
|
||||
| Value |
|
||||
| --------- |
|
||||
| `` |
|
||||
| `flag` |
|
||||
| `env` |
|
||||
| `yaml` |
|
||||
| `default` |
|
||||
|
||||
## coderd.SCIMUser
|
||||
|
||||
```json
|
||||
@@ -2507,7 +2253,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| `region_code` | string | false | | |
|
||||
| `region_id` | integer | false | | |
|
||||
| `region_name` | string | false | | |
|
||||
| `relay_url` | [clibase.URL](#clibaseurl) | false | | |
|
||||
| `relay_url` | [serpent.URL](#serpenturl) | false | | |
|
||||
| `stun_addresses` | array of string | false | | |
|
||||
|
||||
## codersdk.DangerousConfig
|
||||
@@ -2916,7 +2662,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| --------- | ------------------------------------------------------ | -------- | ------------ | ----------- |
|
||||
| `config` | [codersdk.DeploymentValues](#codersdkdeploymentvalues) | false | | |
|
||||
| `options` | array of [clibase.Option](#clibaseoption) | false | | |
|
||||
| `options` | array of [serpent.Option](#serpentoption) | false | | |
|
||||
|
||||
## codersdk.DeploymentStats
|
||||
|
||||
@@ -3252,9 +2998,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------------------------------ | ---------------------------------------------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------ |
|
||||
| `access_url` | [clibase.URL](#clibaseurl) | false | | |
|
||||
| `address` | [clibase.HostPort](#clibasehostport) | false | | Address Use HTTPAddress or TLS.Address instead. |
|
||||
| `agent_fallback_troubleshooting_url` | [clibase.URL](#clibaseurl) | false | | |
|
||||
| `access_url` | [serpent.URL](#serpenturl) | false | | |
|
||||
| `address` | [serpent.HostPort](#serpenthostport) | false | | Address Use HTTPAddress or TLS.Address instead. |
|
||||
| `agent_fallback_troubleshooting_url` | [serpent.URL](#serpenturl) | false | | |
|
||||
| `agent_stat_refresh_interval` | integer | false | | |
|
||||
| `allow_workspace_renames` | boolean | false | | |
|
||||
| `autobuild_poll_interval` | integer | false | | |
|
||||
@@ -3269,10 +3015,10 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| `disable_password_auth` | boolean | false | | |
|
||||
| `disable_path_apps` | boolean | false | | |
|
||||
| `disable_session_expiry_refresh` | boolean | false | | |
|
||||
| `docs_url` | [clibase.URL](#clibaseurl) | false | | |
|
||||
| `docs_url` | [serpent.URL](#serpenturl) | false | | |
|
||||
| `enable_terraform_debug_mode` | boolean | false | | |
|
||||
| `experiments` | array of string | false | | |
|
||||
| `external_auth` | [clibase.Struct-array_codersdk_ExternalAuthConfig](#clibasestruct-array_codersdk_externalauthconfig) | false | | |
|
||||
| `external_auth` | [serpent.Struct-array_codersdk_ExternalAuthConfig](#serpentstruct-array_codersdk_externalauthconfig) | false | | |
|
||||
| `external_token_encryption_keys` | array of string | false | | |
|
||||
| `healthcheck` | [codersdk.HealthcheckConfig](#codersdkhealthcheckconfig) | false | | |
|
||||
| `http_address` | string | false | | Http address is a string because it may be set to zero to disable. |
|
||||
@@ -4615,9 +4361,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| `group_allow_list` | array of string | false | | |
|
||||
| `group_auto_create` | boolean | false | | |
|
||||
| `group_mapping` | object | false | | |
|
||||
| `group_regex_filter` | [clibase.Regexp](#clibaseregexp) | false | | |
|
||||
| `group_regex_filter` | [serpent.Regexp](#serpentregexp) | false | | |
|
||||
| `groups_field` | string | false | | |
|
||||
| `icon_url` | [clibase.URL](#clibaseurl) | false | | |
|
||||
| `icon_url` | [serpent.URL](#serpenturl) | false | | |
|
||||
| `ignore_email_verified` | boolean | false | | |
|
||||
| `ignore_user_info` | boolean | false | | |
|
||||
| `issuer_url` | string | false | | |
|
||||
@@ -4774,7 +4520,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| --------- | ------------------------------------ | -------- | ------------ | ----------- |
|
||||
| `address` | [clibase.HostPort](#clibasehostport) | false | | |
|
||||
| `address` | [serpent.HostPort](#serpenthostport) | false | | |
|
||||
| `enable` | boolean | false | | |
|
||||
|
||||
## codersdk.PrometheusConfig
|
||||
@@ -4796,7 +4542,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| -------------------------- | ------------------------------------ | -------- | ------------ | ----------- |
|
||||
| `address` | [clibase.HostPort](#clibasehostport) | false | | |
|
||||
| `address` | [serpent.HostPort](#serpenthostport) | false | | |
|
||||
| `aggregate_agent_stats_by` | array of string | false | | |
|
||||
| `collect_agent_stats` | boolean | false | | |
|
||||
| `collect_db_metrics` | boolean | false | | |
|
||||
@@ -5540,7 +5286,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------- | ------------------------------------------------------------------------------------ | -------- | ------------ | ----------- |
|
||||
| `links` | [clibase.Struct-array_codersdk_LinkConfig](#clibasestruct-array_codersdk_linkconfig) | false | | |
|
||||
| `links` | [serpent.Struct-array_codersdk_LinkConfig](#serpentstruct-array_codersdk_linkconfig) | false | | |
|
||||
|
||||
## codersdk.SwaggerConfig
|
||||
|
||||
@@ -5582,7 +5328,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------------------ | ------------------------------------ | -------- | ------------ | ----------- |
|
||||
| `address` | [clibase.HostPort](#clibasehostport) | false | | |
|
||||
| `address` | [serpent.HostPort](#serpenthostport) | false | | |
|
||||
| `allow_insecure_ciphers` | boolean | false | | |
|
||||
| `cert_file` | array of string | false | | |
|
||||
| `client_auth` | string | false | | |
|
||||
@@ -5623,7 +5369,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| -------- | -------------------------- | -------- | ------------ | ----------- |
|
||||
| `enable` | boolean | false | | |
|
||||
| `trace` | boolean | false | | |
|
||||
| `url` | [clibase.URL](#clibaseurl) | false | | |
|
||||
| `url` | [serpent.URL](#serpenturl) | false | | |
|
||||
|
||||
## codersdk.Template
|
||||
|
||||
@@ -8810,6 +8556,260 @@ _None_
|
||||
| `refresh_token` | string | false | | Refresh token is a token that's used by the application (as opposed to the user) to refresh the access token if it expires. |
|
||||
| `token_type` | string | false | | Token type is the type of token. The Type method returns either this or "Bearer", the default. |
|
||||
|
||||
## serpent.Annotations
|
||||
|
||||
```json
|
||||
{
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ---------------- | ------ | -------- | ------------ | ----------- |
|
||||
| `[any property]` | string | false | | |
|
||||
|
||||
## serpent.Group
|
||||
|
||||
```json
|
||||
{
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {},
|
||||
"yaml": "string"
|
||||
},
|
||||
"yaml": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------- | ------------------------------ | -------- | ------------ | ----------- |
|
||||
| `description` | string | false | | |
|
||||
| `name` | string | false | | |
|
||||
| `parent` | [serpent.Group](#serpentgroup) | false | | |
|
||||
| `yaml` | string | false | | |
|
||||
|
||||
## serpent.HostPort
|
||||
|
||||
```json
|
||||
{
|
||||
"host": "string",
|
||||
"port": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------ | ------ | -------- | ------------ | ----------- |
|
||||
| `host` | string | false | | |
|
||||
| `port` | string | false | | |
|
||||
|
||||
## serpent.Option
|
||||
|
||||
```json
|
||||
{
|
||||
"annotations": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
},
|
||||
"default": "string",
|
||||
"description": "string",
|
||||
"env": "string",
|
||||
"flag": "string",
|
||||
"flag_shorthand": "string",
|
||||
"group": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {},
|
||||
"yaml": "string"
|
||||
},
|
||||
"yaml": "string"
|
||||
},
|
||||
"hidden": true,
|
||||
"name": "string",
|
||||
"required": true,
|
||||
"use_instead": [
|
||||
{
|
||||
"annotations": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
},
|
||||
"default": "string",
|
||||
"description": "string",
|
||||
"env": "string",
|
||||
"flag": "string",
|
||||
"flag_shorthand": "string",
|
||||
"group": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {
|
||||
"description": "string",
|
||||
"name": "string",
|
||||
"parent": {},
|
||||
"yaml": "string"
|
||||
},
|
||||
"yaml": "string"
|
||||
},
|
||||
"hidden": true,
|
||||
"name": "string",
|
||||
"required": true,
|
||||
"use_instead": [],
|
||||
"value": null,
|
||||
"value_source": "",
|
||||
"yaml": "string"
|
||||
}
|
||||
],
|
||||
"value": null,
|
||||
"value_source": "",
|
||||
"yaml": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ---------------- | ------------------------------------------ | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `annotations` | [serpent.Annotations](#serpentannotations) | false | | Annotations enable extensions to serpent higher up in the stack. It's useful for help formatting and documentation generation. |
|
||||
| `default` | string | false | | Default is parsed into Value if set. |
|
||||
| `description` | string | false | | |
|
||||
| `env` | string | false | | Env is the environment variable used to configure this option. If unset, environment configuring is disabled. |
|
||||
| `flag` | string | false | | Flag is the long name of the flag used to configure this option. If unset, flag configuring is disabled. |
|
||||
| `flag_shorthand` | string | false | | Flag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used. |
|
||||
| `group` | [serpent.Group](#serpentgroup) | false | | Group is a group hierarchy that helps organize this option in help, configs and other documentation. |
|
||||
| `hidden` | boolean | false | | |
|
||||
| `name` | string | false | | |
|
||||
| `required` | boolean | false | | Required means this value must be set by some means. It requires `ValueSource != ValueSourceNone` If `Default` is set, then `Required` is ignored. |
|
||||
| `use_instead` | array of [serpent.Option](#serpentoption) | false | | Use instead is a list of options that should be used instead of this one. The field is used to generate a deprecation warning. |
|
||||
| `value` | any | false | | Value includes the types listed in values.go. |
|
||||
| `value_source` | [serpent.ValueSource](#serpentvaluesource) | false | | |
|
||||
| `yaml` | string | false | | Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled. |
|
||||
|
||||
## serpent.Regexp
|
||||
|
||||
```json
|
||||
{}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
_None_
|
||||
|
||||
## serpent.Struct-array_codersdk_ExternalAuthConfig
|
||||
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"app_install_url": "string",
|
||||
"app_installations_url": "string",
|
||||
"auth_url": "string",
|
||||
"client_id": "string",
|
||||
"device_code_url": "string",
|
||||
"device_flow": true,
|
||||
"display_icon": "string",
|
||||
"display_name": "string",
|
||||
"extra_token_keys": ["string"],
|
||||
"id": "string",
|
||||
"no_refresh": true,
|
||||
"regex": "string",
|
||||
"scopes": ["string"],
|
||||
"token_url": "string",
|
||||
"type": "string",
|
||||
"validate_url": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------- | ------------------------------------------------------------------- | -------- | ------------ | ----------- |
|
||||
| `value` | array of [codersdk.ExternalAuthConfig](#codersdkexternalauthconfig) | false | | |
|
||||
|
||||
## serpent.Struct-array_codersdk_LinkConfig
|
||||
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"icon": "bug",
|
||||
"name": "string",
|
||||
"target": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------- | --------------------------------------------------- | -------- | ------------ | ----------- |
|
||||
| `value` | array of [codersdk.LinkConfig](#codersdklinkconfig) | false | | |
|
||||
|
||||
## serpent.URL
|
||||
|
||||
```json
|
||||
{
|
||||
"forceQuery": true,
|
||||
"fragment": "string",
|
||||
"host": "string",
|
||||
"omitHost": true,
|
||||
"opaque": "string",
|
||||
"path": "string",
|
||||
"rawFragment": "string",
|
||||
"rawPath": "string",
|
||||
"rawQuery": "string",
|
||||
"scheme": "string",
|
||||
"user": {}
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------- | ---------------------------- | -------- | ------------ | -------------------------------------------------- |
|
||||
| `forceQuery` | boolean | false | | append a query ('?') even if RawQuery is empty |
|
||||
| `fragment` | string | false | | fragment for references, without '#' |
|
||||
| `host` | string | false | | host or host:port |
|
||||
| `omitHost` | boolean | false | | do not emit empty host (authority) |
|
||||
| `opaque` | string | false | | encoded opaque data |
|
||||
| `path` | string | false | | path (relative paths may omit leading slash) |
|
||||
| `rawFragment` | string | false | | encoded fragment hint (see EscapedFragment method) |
|
||||
| `rawPath` | string | false | | encoded path hint (see EscapedPath method) |
|
||||
| `rawQuery` | string | false | | encoded query values, without '?' |
|
||||
| `scheme` | string | false | | |
|
||||
| `user` | [url.Userinfo](#urluserinfo) | false | | username and password information |
|
||||
|
||||
## serpent.ValueSource
|
||||
|
||||
```json
|
||||
""
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
#### Enumerated Values
|
||||
|
||||
| Value |
|
||||
| --------- |
|
||||
| `` |
|
||||
| `flag` |
|
||||
| `env` |
|
||||
| `yaml` |
|
||||
| `default` |
|
||||
|
||||
## tailcfg.DERPHomeParams
|
||||
|
||||
```json
|
||||
|
||||
@@ -37,7 +37,7 @@
|
||||
- Add parameter to force healthcheck in `/api/v2//debug/health` (#10677) (@johnstcn)
|
||||
- Allow configuring database health check threshold (#10623) (@johnstcn)
|
||||
- Add stop and start batch actions (#10565) (@BrunoQuaresma)
|
||||
- Add annotation to display values of type clibase.Duration correctly (#10667) (@johnstcn)
|
||||
- Add annotation to display values of type serpent.Duration correctly (#10667) (@johnstcn)
|
||||
- Add refresh button on health page (#10719) (@johnstcn)
|
||||
|
||||
### Bug fixes
|
||||
|
||||
+71
-71
@@ -25,46 +25,55 @@ Coder — A tool for provisioning self-hosted development environments with Terr
|
||||
|
||||
| Name | Purpose |
|
||||
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| [<code>dotfiles</code>](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
|
||||
| [<code>external-auth</code>](./cli/external-auth.md) | Manage external authentication |
|
||||
| [<code>login</code>](./cli/login.md) | Authenticate with Coder deployment |
|
||||
| [<code>logout</code>](./cli/logout.md) | Unauthenticate your local session |
|
||||
| [<code>netcheck</code>](./cli/netcheck.md) | Print network debug information for DERP and STUN |
|
||||
| [<code>port-forward</code>](./cli/port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
|
||||
| [<code>publickey</code>](./cli/publickey.md) | Output your Coder public key used for Git operations |
|
||||
| [<code>reset-password</code>](./cli/reset-password.md) | Directly connect to the database to reset a user's password |
|
||||
| [<code>state</code>](./cli/state.md) | Manually manage Terraform state to fix broken workspaces |
|
||||
| [<code>templates</code>](./cli/templates.md) | Manage templates |
|
||||
| [<code>tokens</code>](./cli/tokens.md) | Manage personal access tokens |
|
||||
| [<code>users</code>](./cli/users.md) | Manage users |
|
||||
| [<code>version</code>](./cli/version.md) | Show coder version |
|
||||
| [<code>autoupdate</code>](./cli/autoupdate.md) | Toggle auto-update policy for a workspace |
|
||||
| [<code>config-ssh</code>](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
|
||||
| [<code>create</code>](./cli/create.md) | Create a workspace |
|
||||
| [<code>delete</code>](./cli/delete.md) | Delete a workspace |
|
||||
| [<code>dotfiles</code>](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
|
||||
| [<code>external-auth</code>](./cli/external-auth.md) | Manage external authentication |
|
||||
| [<code>favorite</code>](./cli/favorite.md) | Add a workspace to your favorites |
|
||||
| [<code>features</code>](./cli/features.md) | List Enterprise features |
|
||||
| [<code>groups</code>](./cli/groups.md) | Manage groups |
|
||||
| [<code>licenses</code>](./cli/licenses.md) | Add, delete, and list licenses |
|
||||
| [<code>list</code>](./cli/list.md) | List workspaces |
|
||||
| [<code>login</code>](./cli/login.md) | Authenticate with Coder deployment |
|
||||
| [<code>logout</code>](./cli/logout.md) | Unauthenticate your local session |
|
||||
| [<code>netcheck</code>](./cli/netcheck.md) | Print network debug information for DERP and STUN |
|
||||
| [<code>open</code>](./cli/open.md) | Open a workspace |
|
||||
| [<code>ping</code>](./cli/ping.md) | Ping a workspace |
|
||||
| [<code>port-forward</code>](./cli/port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
|
||||
| [<code>provisionerd</code>](./cli/provisionerd.md) | Manage provisioner daemons |
|
||||
| [<code>publickey</code>](./cli/publickey.md) | Output your Coder public key used for Git operations |
|
||||
| [<code>rename</code>](./cli/rename.md) | Rename a workspace |
|
||||
| [<code>reset-password</code>](./cli/reset-password.md) | Directly connect to the database to reset a user's password |
|
||||
| [<code>restart</code>](./cli/restart.md) | Restart a workspace |
|
||||
| [<code>schedule</code>](./cli/schedule.md) | Schedule automated start and stop times for workspaces |
|
||||
| [<code>server</code>](./cli/server.md) | Start a Coder server |
|
||||
| [<code>show</code>](./cli/show.md) | Display details of a workspace's resources and agents |
|
||||
| [<code>speedtest</code>](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace |
|
||||
| [<code>ssh</code>](./cli/ssh.md) | Start a shell into a workspace |
|
||||
| [<code>start</code>](./cli/start.md) | Start a workspace |
|
||||
| [<code>stat</code>](./cli/stat.md) | Show resource usage for the current workspace. |
|
||||
| [<code>state</code>](./cli/state.md) | Manually manage Terraform state to fix broken workspaces |
|
||||
| [<code>stop</code>](./cli/stop.md) | Stop a workspace |
|
||||
| [<code>templates</code>](./cli/templates.md) | Manage templates |
|
||||
| [<code>tokens</code>](./cli/tokens.md) | Manage personal access tokens |
|
||||
| [<code>unfavorite</code>](./cli/unfavorite.md) | Remove a workspace from your favorites |
|
||||
| [<code>update</code>](./cli/update.md) | Will update and start a given workspace if it is out of date |
|
||||
| [<code>users</code>](./cli/users.md) | Manage users |
|
||||
| [<code>version</code>](./cli/version.md) | Show coder version |
|
||||
| [<code>server</code>](./cli/server.md) | Start a Coder server |
|
||||
| [<code>features</code>](./cli/features.md) | List Enterprise features |
|
||||
| [<code>licenses</code>](./cli/licenses.md) | Add, delete, and list licenses |
|
||||
| [<code>groups</code>](./cli/groups.md) | Manage groups |
|
||||
| [<code>provisionerd</code>](./cli/provisionerd.md) | Manage provisioner daemons |
|
||||
|
||||
## Options
|
||||
|
||||
### --url
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------- |
|
||||
| Type | <code>url</code> |
|
||||
| Environment | <code>$CODER_URL</code> |
|
||||
|
||||
URL to a deployment.
|
||||
|
||||
### --debug-options
|
||||
|
||||
| | |
|
||||
@@ -73,24 +82,33 @@ Coder — A tool for provisioning self-hosted development environments with Terr
|
||||
|
||||
Print all options, how they're set, then exit.
|
||||
|
||||
### --disable-direct-connections
|
||||
### --token
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_DISABLE_DIRECT_CONNECTIONS</code> |
|
||||
| | |
|
||||
| ----------- | --------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SESSION_TOKEN</code> |
|
||||
|
||||
Disable direct (P2P) connections to workspaces.
|
||||
Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
|
||||
### --global-config
|
||||
### --no-version-warning
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------ |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_CONFIG_DIR</code> |
|
||||
| Default | <code>~/.config/coderv2</code> |
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_NO_VERSION_WARNING</code> |
|
||||
|
||||
Path to the global `coder` config directory.
|
||||
Suppress warning when client and server versions do not match.
|
||||
|
||||
### --no-feature-warning
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_NO_FEATURE_WARNING</code> |
|
||||
|
||||
Suppress warnings about unlicensed features.
|
||||
|
||||
### --header
|
||||
|
||||
@@ -112,23 +130,33 @@ specified multiple times.
|
||||
An external command that outputs additional HTTP headers added to all requests.
|
||||
The command must output each header as `key=value` on its own line.
|
||||
|
||||
### --no-feature-warning
|
||||
### -v, --verbose
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_NO_FEATURE_WARNING</code> |
|
||||
| | |
|
||||
| ----------- | --------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_VERBOSE</code> |
|
||||
|
||||
Suppress warnings about unlicensed features.
|
||||
Enable verbose output.
|
||||
|
||||
### --no-version-warning
|
||||
### --disable-direct-connections
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_NO_VERSION_WARNING</code> |
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_DISABLE_DIRECT_CONNECTIONS</code> |
|
||||
|
||||
Suppress warning when client and server versions do not match.
|
||||
Disable direct (P2P) connections to workspaces.
|
||||
|
||||
### --global-config
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------ |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_CONFIG_DIR</code> |
|
||||
| Default | <code>~/.config/coderv2</code> |
|
||||
|
||||
Path to the global `coder` config directory.
|
||||
|
||||
### -z, --organization
|
||||
|
||||
@@ -139,31 +167,3 @@ Suppress warning when client and server versions do not match.
|
||||
|
||||
Select which organization (uuid or name) to use This overrides what is present
|
||||
in the config file.
|
||||
|
||||
### --token
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SESSION_TOKEN</code> |
|
||||
|
||||
Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
|
||||
### --url
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------- |
|
||||
| Type | <code>url</code> |
|
||||
| Environment | <code>$CODER_URL</code> |
|
||||
|
||||
URL to a deployment.
|
||||
|
||||
### -v, --verbose
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_VERBOSE</code> |
|
||||
|
||||
Enable verbose output.
|
||||
|
||||
Generated
+34
-34
@@ -25,34 +25,6 @@ workspaces:
|
||||
|
||||
## Options
|
||||
|
||||
### --coder-binary-path
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------------ |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
|
||||
|
||||
Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.
|
||||
|
||||
### --disable-autostart
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Disable starting the workspace automatically when connecting via SSH.
|
||||
|
||||
### -n, --dry-run
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
|
||||
|
||||
Perform a trial run with no changes made, showing a diff at the end.
|
||||
|
||||
### --ssh-config-file
|
||||
|
||||
| | |
|
||||
@@ -63,14 +35,14 @@ Perform a trial run with no changes made, showing a diff at the end.
|
||||
|
||||
Specifies the path to an SSH config.
|
||||
|
||||
### --ssh-host-prefix
|
||||
### --coder-binary-path
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
|
||||
| | |
|
||||
| ----------- | ------------------------------------------ |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
|
||||
|
||||
Override the default host prefix.
|
||||
Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.
|
||||
|
||||
### -o, --ssh-option
|
||||
|
||||
@@ -81,6 +53,15 @@ Override the default host prefix.
|
||||
|
||||
Specifies additional SSH options to embed in each host stanza.
|
||||
|
||||
### -n, --dry-run
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
|
||||
|
||||
Perform a trial run with no changes made, showing a diff at the end.
|
||||
|
||||
### --use-previous-options
|
||||
|
||||
| | |
|
||||
@@ -90,6 +71,15 @@ Specifies additional SSH options to embed in each host stanza.
|
||||
|
||||
Specifies whether or not to keep options from previous run of config-ssh.
|
||||
|
||||
### --ssh-host-prefix
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
|
||||
|
||||
Override the default host prefix.
|
||||
|
||||
### --wait
|
||||
|
||||
| | |
|
||||
@@ -100,6 +90,16 @@ Specifies whether or not to keep options from previous run of config-ssh.
|
||||
|
||||
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
|
||||
|
||||
### --disable-autostart
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Disable starting the workspace automatically when connecting via SSH.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
|
||||
Generated
+40
-40
@@ -20,42 +20,14 @@ coder create [flags] [name]
|
||||
|
||||
## Options
|
||||
|
||||
### --automatic-updates
|
||||
### -t, --template
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
|
||||
| Default | <code>never</code> |
|
||||
| | |
|
||||
| ----------- | --------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
|
||||
|
||||
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
|
||||
|
||||
### --copy-parameters-from
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
|
||||
|
||||
Specify the source workspace name to copy parameters from.
|
||||
|
||||
### --parameter
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_RICH_PARAMETER</code> |
|
||||
|
||||
Rich parameter value in the format "name=value".
|
||||
|
||||
### --rich-parameter-file
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
|
||||
|
||||
Specify a file path with values for rich parameters defined in the template.
|
||||
Specify a template name.
|
||||
|
||||
### --start-at
|
||||
|
||||
@@ -75,14 +47,24 @@ Specify the workspace autostart schedule. Check coder schedule start --help for
|
||||
|
||||
Specify a duration after which the workspace should shut down (e.g. 8h).
|
||||
|
||||
### -t, --template
|
||||
### --automatic-updates
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
|
||||
| | |
|
||||
| ----------- | ----------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
|
||||
| Default | <code>never</code> |
|
||||
|
||||
Specify a template name.
|
||||
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
|
||||
|
||||
### --copy-parameters-from
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
|
||||
|
||||
Specify the source workspace name to copy parameters from.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
@@ -91,3 +73,21 @@ Specify a template name.
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
|
||||
### --parameter
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_RICH_PARAMETER</code> |
|
||||
|
||||
Rich parameter value in the format "name=value".
|
||||
|
||||
### --rich-parameter-file
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
|
||||
|
||||
Specify a file path with values for rich parameters defined in the template.
|
||||
|
||||
Generated
+9
-9
@@ -20,6 +20,15 @@ coder dotfiles [flags] <git_repo_url>
|
||||
|
||||
## Options
|
||||
|
||||
### --symlink-dir
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SYMLINK_DIR</code> |
|
||||
|
||||
Specifies the directory for the dotfiles symlink destinations. If empty, will use $HOME.
|
||||
|
||||
### -b, --branch
|
||||
|
||||
| | |
|
||||
@@ -38,15 +47,6 @@ Specifies which branch to clone. If empty, will default to cloning the default b
|
||||
|
||||
Specifies the directory for the dotfiles repository, relative to global config directory.
|
||||
|
||||
### --symlink-dir
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SYMLINK_DIR</code> |
|
||||
|
||||
Specifies the directory for the dotfiles symlink destinations. If empty, will use $HOME.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
|
||||
Generated
+2
-2
@@ -19,6 +19,6 @@ coder groups
|
||||
| Name | Purpose |
|
||||
| ----------------------------------------- | ------------------- |
|
||||
| [<code>create</code>](./groups_create.md) | Create a user group |
|
||||
| [<code>delete</code>](./groups_delete.md) | Delete a user group |
|
||||
| [<code>edit</code>](./groups_edit.md) | Edit a user group |
|
||||
| [<code>list</code>](./groups_list.md) | List user groups |
|
||||
| [<code>edit</code>](./groups_edit.md) | Edit a user group |
|
||||
| [<code>delete</code>](./groups_delete.md) | Delete a user group |
|
||||
|
||||
Generated
+10
-10
@@ -12,13 +12,13 @@ coder groups edit [flags] <name>
|
||||
|
||||
## Options
|
||||
|
||||
### -a, --add-users
|
||||
### -n, --name
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Add users to the group. Accepts emails or IDs.
|
||||
Update the group name.
|
||||
|
||||
### -u, --avatar-url
|
||||
|
||||
@@ -37,13 +37,13 @@ Update the group avatar.
|
||||
|
||||
Optional human friendly name for the group.
|
||||
|
||||
### -n, --name
|
||||
### -a, --add-users
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Update the group name.
|
||||
Add users to the group. Accepts emails or IDs.
|
||||
|
||||
### -r, --rm-users
|
||||
|
||||
|
||||
Generated
+1
-1
@@ -19,5 +19,5 @@ coder licenses
|
||||
| Name | Purpose |
|
||||
| ------------------------------------------- | --------------------------------- |
|
||||
| [<code>add</code>](./licenses_add.md) | Add license to Coder deployment |
|
||||
| [<code>delete</code>](./licenses_delete.md) | Delete license by ID |
|
||||
| [<code>list</code>](./licenses_list.md) | List licenses (including expired) |
|
||||
| [<code>delete</code>](./licenses_delete.md) | Delete license by ID |
|
||||
|
||||
Generated
+8
-8
@@ -12,14 +12,6 @@ coder licenses add [flags] [-f file | -l license]
|
||||
|
||||
## Options
|
||||
|
||||
### --debug
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Output license claims for debugging.
|
||||
|
||||
### -f, --file
|
||||
|
||||
| | |
|
||||
@@ -35,3 +27,11 @@ Load license from file.
|
||||
| Type | <code>string</code> |
|
||||
|
||||
License string.
|
||||
|
||||
### --debug
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Output license claims for debugging.
|
||||
|
||||
Generated
+9
-9
@@ -24,6 +24,15 @@ coder list [flags]
|
||||
|
||||
Specifies whether all workspaces will be listed or not.
|
||||
|
||||
### --search
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>owner:me</code> |
|
||||
|
||||
Search for a workspace with a query.
|
||||
|
||||
### -c, --column
|
||||
|
||||
| | |
|
||||
@@ -41,12 +50,3 @@ Columns to display in table output. Available columns: favorite, workspace, temp
|
||||
| Default | <code>table</code> |
|
||||
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
### --search
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>owner:me</code> |
|
||||
|
||||
Search for a workspace with a query.
|
||||
|
||||
Generated
+9
-9
@@ -21,6 +21,15 @@ coder login [flags] [<url>]
|
||||
|
||||
Specifies an email address to use if creating the first user for the deployment.
|
||||
|
||||
### --first-user-username
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |
|
||||
|
||||
Specifies a username to use if creating the first user for the deployment.
|
||||
|
||||
### --first-user-password
|
||||
|
||||
| | |
|
||||
@@ -39,15 +48,6 @@ Specifies a password to use if creating the first user for the deployment.
|
||||
|
||||
Specifies whether a trial license should be provisioned for the Coder deployment or not.
|
||||
|
||||
### --first-user-username
|
||||
|
||||
| | |
|
||||
| ----------- | --------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |
|
||||
|
||||
Specifies a username to use if creating the first user for the deployment.
|
||||
|
||||
### --use-token-as-session
|
||||
|
||||
| | |
|
||||
|
||||
Generated
+12
-12
@@ -12,14 +12,14 @@ coder ping [flags] <workspace>
|
||||
|
||||
## Options
|
||||
|
||||
### -n, --num
|
||||
### --wait
|
||||
|
||||
| | |
|
||||
| ------- | ---------------- |
|
||||
| Type | <code>int</code> |
|
||||
| Default | <code>10</code> |
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>1s</code> |
|
||||
|
||||
Specifies the number of pings to perform.
|
||||
Specifies how long to wait between pings.
|
||||
|
||||
### -t, --timeout
|
||||
|
||||
@@ -30,11 +30,11 @@ Specifies the number of pings to perform.
|
||||
|
||||
Specifies how long to wait for a ping to complete.
|
||||
|
||||
### --wait
|
||||
### -n, --num
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>1s</code> |
|
||||
| | |
|
||||
| ------- | ---------------- |
|
||||
| Type | <code>int</code> |
|
||||
| Default | <code>10</code> |
|
||||
|
||||
Specifies how long to wait between pings.
|
||||
Specifies the number of pings to perform.
|
||||
|
||||
Generated
+10
-10
@@ -42,16 +42,6 @@ machine:
|
||||
|
||||
## Options
|
||||
|
||||
### --disable-autostart
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Disable starting the workspace automatically when connecting via SSH.
|
||||
|
||||
### -p, --tcp
|
||||
|
||||
| | |
|
||||
@@ -69,3 +59,13 @@ Forward TCP port(s) from the workspace to the local machine.
|
||||
| Environment | <code>$CODER_PORT_FORWARD_UDP</code> |
|
||||
|
||||
Forward UDP port(s) from the workspace to the local machine. The UDP connection has TCP-like semantics to support stateful UDP protocols.
|
||||
|
||||
### --disable-autostart
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Disable starting the workspace automatically when connecting via SSH.
|
||||
|
||||
Generated
+67
-67
@@ -22,14 +22,62 @@ coder provisionerd start [flags]
|
||||
|
||||
Directory to store cached data.
|
||||
|
||||
### --log-filter
|
||||
### -t, --tag
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOG_FILTER</code> |
|
||||
| | |
|
||||
| ----------- | ------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
|
||||
|
||||
Filter debug logs by matching against a given regex. Use .\* to match all debug logs.
|
||||
Tags to filter provisioner jobs by.
|
||||
|
||||
### --poll-interval
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
|
||||
| Default | <code>1s</code> |
|
||||
|
||||
Deprecated and ignored.
|
||||
|
||||
### --poll-jitter
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
|
||||
| Default | <code>100ms</code> |
|
||||
|
||||
Deprecated and ignored.
|
||||
|
||||
### --psk
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------------ |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
|
||||
|
||||
Pre-shared key to authenticate with Coder server.
|
||||
|
||||
### --name
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_NAME</code> |
|
||||
|
||||
Name of this provisioner daemon. Defaults to the current hostname without FQDN.
|
||||
|
||||
### --verbose
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_VERBOSE</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Output debug-level logs.
|
||||
|
||||
### --log-human
|
||||
|
||||
@@ -59,44 +107,14 @@ Output JSON logs to a given file.
|
||||
|
||||
Output Stackdriver compatible logs to a given file.
|
||||
|
||||
### --name
|
||||
### --log-filter
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_NAME</code> |
|
||||
| | |
|
||||
| ----------- | ------------------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOG_FILTER</code> |
|
||||
|
||||
Name of this provisioner daemon. Defaults to the current hostname without FQDN.
|
||||
|
||||
### --poll-interval
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
|
||||
| Default | <code>1s</code> |
|
||||
|
||||
Deprecated and ignored.
|
||||
|
||||
### --poll-jitter
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
|
||||
| Default | <code>100ms</code> |
|
||||
|
||||
Deprecated and ignored.
|
||||
|
||||
### --prometheus-address
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
|
||||
| Default | <code>127.0.0.1:2112</code> |
|
||||
|
||||
The bind address to serve prometheus metrics.
|
||||
Filter debug logs by matching against a given regex. Use .\* to match all debug logs.
|
||||
|
||||
### --prometheus-enable
|
||||
|
||||
@@ -108,30 +126,12 @@ The bind address to serve prometheus metrics.
|
||||
|
||||
Serve prometheus metrics on the address defined by prometheus address.
|
||||
|
||||
### --psk
|
||||
### --prometheus-address
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------------ |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
|
||||
| Default | <code>127.0.0.1:2112</code> |
|
||||
|
||||
Pre-shared key to authenticate with Coder server.
|
||||
|
||||
### -t, --tag
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
|
||||
|
||||
Tags to filter provisioner jobs by.
|
||||
|
||||
### --verbose
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_PROVISIONER_DAEMON_VERBOSE</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Output debug-level logs.
|
||||
The bind address to serve prometheus metrics.
|
||||
|
||||
Generated
+4
-4
@@ -12,13 +12,13 @@ coder restart [flags] <workspace>
|
||||
|
||||
## Options
|
||||
|
||||
### --always-prompt
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Always prompt all parameters. Does not pull parameter values from existing workspace.
|
||||
Bypass prompts.
|
||||
|
||||
### --build-option
|
||||
|
||||
@@ -55,10 +55,10 @@ Rich parameter value in the format "name=value".
|
||||
|
||||
Specify a file path with values for rich parameters defined in the template.
|
||||
|
||||
### -y, --yes
|
||||
### --always-prompt
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
Always prompt all parameters. Does not pull parameter values from existing workspace.
|
||||
|
||||
Generated
+1
-1
@@ -14,7 +14,7 @@ coder schedule { show | start | stop | override } <workspace>
|
||||
|
||||
| Name | Purpose |
|
||||
| --------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| [<code>override-stop</code>](./schedule_override-stop.md) | Override the stop time of a currently running workspace instance. |
|
||||
| [<code>show</code>](./schedule_show.md) | Show workspace schedules |
|
||||
| [<code>start</code>](./schedule_start.md) | Edit workspace start schedule |
|
||||
| [<code>stop</code>](./schedule_stop.md) | Edit workspace stop schedule |
|
||||
| [<code>override-stop</code>](./schedule_override-stop.md) | Override the stop time of a currently running workspace instance. |
|
||||
|
||||
Generated
+9
-9
@@ -31,6 +31,15 @@ Shows the following information for the given workspace(s):
|
||||
|
||||
Specifies whether all workspaces will be listed or not.
|
||||
|
||||
### --search
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>owner:me</code> |
|
||||
|
||||
Search for a workspace with a query.
|
||||
|
||||
### -c, --column
|
||||
|
||||
| | |
|
||||
@@ -48,12 +57,3 @@ Columns to display in table output. Available columns: workspace, starts at, sta
|
||||
| Default | <code>table</code> |
|
||||
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
### --search
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>owner:me</code> |
|
||||
|
||||
Search for a workspace with a query.
|
||||
|
||||
Generated
+797
-797
File diff suppressed because it is too large
Load Diff
Generated
+26
-26
@@ -12,24 +12,6 @@ coder server create-admin-user [flags]
|
||||
|
||||
## Options
|
||||
|
||||
### --email
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_EMAIL</code> |
|
||||
|
||||
The email of the new user. If not specified, you will be prompted via stdin.
|
||||
|
||||
### --password
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PASSWORD</code> |
|
||||
|
||||
The password of the new user. If not specified, you will be prompted via stdin.
|
||||
|
||||
### --postgres-url
|
||||
|
||||
| | |
|
||||
@@ -39,14 +21,6 @@ The password of the new user. If not specified, you will be prompted via stdin.
|
||||
|
||||
URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will be used (Coder must not be already running in this case).
|
||||
|
||||
### --raw-url
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Output the raw connection URL instead of a psql command.
|
||||
|
||||
### --ssh-keygen-algorithm
|
||||
|
||||
| | |
|
||||
@@ -65,3 +39,29 @@ The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ec
|
||||
| Environment | <code>$CODER_USERNAME</code> |
|
||||
|
||||
The username of the new user. If not specified, you will be prompted via stdin.
|
||||
|
||||
### --email
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_EMAIL</code> |
|
||||
|
||||
The email of the new user. If not specified, you will be prompted via stdin.
|
||||
|
||||
### --password
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PASSWORD</code> |
|
||||
|
||||
The password of the new user. If not specified, you will be prompted via stdin.
|
||||
|
||||
### --raw-url
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Output the raw connection URL instead of a psql command.
|
||||
|
||||
Generated
+9
-9
@@ -12,15 +12,6 @@ coder server dbcrypt decrypt [flags]
|
||||
|
||||
## Options
|
||||
|
||||
### --keys
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS</code> |
|
||||
|
||||
Keys required to decrypt existing data. Must be a comma-separated list of base64-encoded keys.
|
||||
|
||||
### --postgres-url
|
||||
|
||||
| | |
|
||||
@@ -30,6 +21,15 @@ Keys required to decrypt existing data. Must be a comma-separated list of base64
|
||||
|
||||
The connection URL for the Postgres database.
|
||||
|
||||
### --keys
|
||||
|
||||
| | |
|
||||
| ----------- | ---------------------------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS</code> |
|
||||
|
||||
Keys required to decrypt existing data. Must be a comma-separated list of base64-encoded keys.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
|
||||
Generated
+9
-9
@@ -12,6 +12,15 @@ coder server dbcrypt rotate [flags]
|
||||
|
||||
## Options
|
||||
|
||||
### --postgres-url
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
|
||||
|
||||
The connection URL for the Postgres database.
|
||||
|
||||
### --new-key
|
||||
|
||||
| | |
|
||||
@@ -30,15 +39,6 @@ The new external token encryption key. Must be base64-encoded.
|
||||
|
||||
The old external token encryption keys. Must be a comma-separated list of base64-encoded keys.
|
||||
|
||||
### --postgres-url
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
|
||||
|
||||
The connection URL for the Postgres database.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
|
||||
Generated
+8
-8
@@ -29,14 +29,6 @@ Specifies whether to wait for a direct connection before testing speed.
|
||||
|
||||
Specifies whether to run in reverse mode where the client receives and the server sends.
|
||||
|
||||
### --pcap-file
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specifies a file to write a network capture to.
|
||||
|
||||
### -t, --time
|
||||
|
||||
| | |
|
||||
@@ -45,3 +37,11 @@ Specifies a file to write a network capture to.
|
||||
| Default | <code>5s</code> |
|
||||
|
||||
Specifies the duration to monitor traffic.
|
||||
|
||||
### --pcap-file
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specifies a file to write a network capture to.
|
||||
|
||||
Generated
+47
-47
@@ -12,15 +12,14 @@ coder ssh [flags] <workspace>
|
||||
|
||||
## Options
|
||||
|
||||
### --disable-autostart
|
||||
### --stdio
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
|
||||
| Default | <code>false</code> |
|
||||
| | |
|
||||
| ----------- | ----------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_STDIO</code> |
|
||||
|
||||
Disable starting the workspace automatically when connecting via SSH.
|
||||
Specifies whether to emit SSH output over stdin/stdout.
|
||||
|
||||
### -A, --forward-agent
|
||||
|
||||
@@ -49,41 +48,15 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b
|
||||
|
||||
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
|
||||
|
||||
### -l, --log-dir
|
||||
### --workspace-poll-interval
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
|
||||
| | |
|
||||
| ----------- | ------------------------------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
|
||||
| Default | <code>1m</code> |
|
||||
|
||||
Specify the directory containing SSH diagnostic log files.
|
||||
|
||||
### --no-wait
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
|
||||
|
||||
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
|
||||
|
||||
### -R, --remote-forward
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
|
||||
|
||||
Enable remote port forwarding (remote_port:local_address:local_port).
|
||||
|
||||
### --stdio
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_STDIO</code> |
|
||||
|
||||
Specifies whether to emit SSH output over stdin/stdout.
|
||||
Specifies how often to poll for workspace automated shutdown.
|
||||
|
||||
### --wait
|
||||
|
||||
@@ -95,12 +68,39 @@ Specifies whether to emit SSH output over stdin/stdout.
|
||||
|
||||
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
|
||||
|
||||
### --workspace-poll-interval
|
||||
### --no-wait
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
|
||||
| Default | <code>1m</code> |
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
|
||||
|
||||
Specifies how often to poll for workspace automated shutdown.
|
||||
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
|
||||
|
||||
### -l, --log-dir
|
||||
|
||||
| | |
|
||||
| ----------- | ------------------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
|
||||
|
||||
Specify the directory containing SSH diagnostic log files.
|
||||
|
||||
### -R, --remote-forward
|
||||
|
||||
| | |
|
||||
| ----------- | -------------------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
|
||||
|
||||
Enable remote port forwarding (remote_port:local_address:local_port).
|
||||
|
||||
### --disable-autostart
|
||||
|
||||
| | |
|
||||
| ----------- | ----------------------------------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Disable starting the workspace automatically when connecting via SSH.
|
||||
|
||||
Generated
+4
-4
@@ -12,13 +12,13 @@ coder start [flags] <workspace>
|
||||
|
||||
## Options
|
||||
|
||||
### --always-prompt
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Always prompt all parameters. Does not pull parameter values from existing workspace.
|
||||
Bypass prompts.
|
||||
|
||||
### --build-option
|
||||
|
||||
@@ -55,10 +55,10 @@ Rich parameter value in the format "name=value".
|
||||
|
||||
Specify a file path with values for rich parameters defined in the template.
|
||||
|
||||
### -y, --yes
|
||||
### --always-prompt
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
Always prompt all parameters. Does not pull parameter values from existing workspace.
|
||||
|
||||
Generated
+1
-1
@@ -15,8 +15,8 @@ coder stat [flags]
|
||||
| Name | Purpose |
|
||||
| ----------------------------------- | -------------------------------- |
|
||||
| [<code>cpu</code>](./stat_cpu.md) | Show CPU usage, in cores. |
|
||||
| [<code>disk</code>](./stat_disk.md) | Show disk usage, in gigabytes. |
|
||||
| [<code>mem</code>](./stat_mem.md) | Show memory usage, in gigabytes. |
|
||||
| [<code>disk</code>](./stat_disk.md) | Show disk usage, in gigabytes. |
|
||||
|
||||
## Options
|
||||
|
||||
|
||||
Generated
+9
-9
@@ -12,15 +12,6 @@ coder stat disk [flags]
|
||||
|
||||
## Options
|
||||
|
||||
### -o, --output
|
||||
|
||||
| | |
|
||||
| ------- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>text</code> |
|
||||
|
||||
Output format. Available formats: text, json.
|
||||
|
||||
### --path
|
||||
|
||||
| | |
|
||||
@@ -38,3 +29,12 @@ Path for which to check disk usage.
|
||||
| Default | <code>Gi</code> |
|
||||
|
||||
SI Prefix for disk measurement.
|
||||
|
||||
### -o, --output
|
||||
|
||||
| | |
|
||||
| ------- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>text</code> |
|
||||
|
||||
Output format. Available formats: text, json.
|
||||
|
||||
Generated
+9
-9
@@ -20,15 +20,6 @@ coder stat mem [flags]
|
||||
|
||||
Force host memory measurement.
|
||||
|
||||
### -o, --output
|
||||
|
||||
| | |
|
||||
| ------- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>text</code> |
|
||||
|
||||
Output format. Available formats: text, json.
|
||||
|
||||
### --prefix
|
||||
|
||||
| | |
|
||||
@@ -37,3 +28,12 @@ Output format. Available formats: text, json.
|
||||
| Default | <code>Gi</code> |
|
||||
|
||||
SI Prefix for memory measurement.
|
||||
|
||||
### -o, --output
|
||||
|
||||
| | |
|
||||
| ------- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>text</code> |
|
||||
|
||||
Output format. Available formats: text, json.
|
||||
|
||||
Generated
+3
-3
@@ -32,12 +32,12 @@ workspaces:
|
||||
|
||||
| Name | Purpose |
|
||||
| ------------------------------------------------ | -------------------------------------------------------------------------------- |
|
||||
| [<code>archive</code>](./templates_archive.md) | Archive unused or failed template versions from a given template(s) |
|
||||
| [<code>create</code>](./templates_create.md) | DEPRECATED: Create a template from the current directory or as specified by flag |
|
||||
| [<code>delete</code>](./templates_delete.md) | Delete templates |
|
||||
| [<code>edit</code>](./templates_edit.md) | Edit the metadata of a template by name. |
|
||||
| [<code>init</code>](./templates_init.md) | Get started with a templated template. |
|
||||
| [<code>list</code>](./templates_list.md) | List all the templates available for the organization |
|
||||
| [<code>pull</code>](./templates_pull.md) | Download the active, latest, or specified version of a template to a path. |
|
||||
| [<code>push</code>](./templates_push.md) | Create or update a template from the current directory or as specified by flag |
|
||||
| [<code>versions</code>](./templates_versions.md) | Manage different versions of the specified template |
|
||||
| [<code>delete</code>](./templates_delete.md) | Delete templates |
|
||||
| [<code>pull</code>](./templates_pull.md) | Download the active, latest, or specified version of a template to a path. |
|
||||
| [<code>archive</code>](./templates_archive.md) | Archive unused or failed template versions from a given template(s) |
|
||||
|
||||
Generated
+8
-8
@@ -12,14 +12,6 @@ coder templates archive [flags] [template-name...]
|
||||
|
||||
## Options
|
||||
|
||||
### --all
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Include all unused template versions. By default, only failed template versions are archived.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
@@ -27,3 +19,11 @@ Include all unused template versions. By default, only failed template versions
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
|
||||
### --all
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Include all unused template versions. By default, only failed template versions are archived.
|
||||
|
||||
Generated
+81
-81
@@ -12,6 +12,46 @@ coder templates create [flags] [name]
|
||||
|
||||
## Options
|
||||
|
||||
### --private
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
|
||||
|
||||
### --variables-file
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a file path with values for Terraform-managed variables.
|
||||
|
||||
### --variable
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of values for Terraform-managed variables.
|
||||
|
||||
### --var
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Alias of --variable.
|
||||
|
||||
### --provisioner-tag
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of tags to target provisioner daemons.
|
||||
|
||||
### --default-ttl
|
||||
|
||||
| | |
|
||||
@@ -21,33 +61,6 @@ coder templates create [flags] [name]
|
||||
|
||||
Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
|
||||
|
||||
### -d, --directory
|
||||
|
||||
| | |
|
||||
| ------- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>.</code> |
|
||||
|
||||
Specify the directory to create from, use '-' to read tar from stdin.
|
||||
|
||||
### --dormancy-auto-deletion
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
|
||||
|
||||
### --dormancy-threshold
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
|
||||
|
||||
### --failure-ttl
|
||||
|
||||
| | |
|
||||
@@ -57,14 +70,23 @@ Specify a duration workspaces may be inactive prior to being moved to the dorman
|
||||
|
||||
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup"in the UI.
|
||||
|
||||
### --ignore-lockfile
|
||||
### --dormancy-threshold
|
||||
|
||||
| | |
|
||||
| ------- | ------------------ |
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>false</code> |
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Ignore warnings about not having a .terraform.lock.hcl file present in the template.
|
||||
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
|
||||
|
||||
### --dormancy-auto-deletion
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
|
||||
|
||||
### --max-ttl
|
||||
|
||||
@@ -74,30 +96,6 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
|
||||
|
||||
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting. This is an enterprise-only feature.
|
||||
|
||||
### -m, --message
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
|
||||
|
||||
### --private
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
|
||||
|
||||
### --provisioner-tag
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of tags to target provisioner daemons.
|
||||
|
||||
### --require-active-version
|
||||
|
||||
| | |
|
||||
@@ -107,30 +105,6 @@ Specify a set of tags to target provisioner daemons.
|
||||
|
||||
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
|
||||
|
||||
### --var
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Alias of --variable.
|
||||
|
||||
### --variable
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of values for Terraform-managed variables.
|
||||
|
||||
### --variables-file
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a file path with values for Terraform-managed variables.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
@@ -138,3 +112,29 @@ Specify a file path with values for Terraform-managed variables.
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
|
||||
### -d, --directory
|
||||
|
||||
| | |
|
||||
| ------- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>.</code> |
|
||||
|
||||
Specify the directory to create from, use '-' to read tar from stdin.
|
||||
|
||||
### --ignore-lockfile
|
||||
|
||||
| | |
|
||||
| ------- | ------------------ |
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Ignore warnings about not having a .terraform.lock.hcl file present in the template.
|
||||
|
||||
### -m, --message
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
|
||||
|
||||
Generated
+106
-106
@@ -12,6 +12,54 @@ coder templates edit [flags] <template>
|
||||
|
||||
## Options
|
||||
|
||||
### --name
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template name.
|
||||
|
||||
### --display-name
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template display name.
|
||||
|
||||
### --description
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template description.
|
||||
|
||||
### --deprecated
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
|
||||
|
||||
### --icon
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template icon path.
|
||||
|
||||
### --default-ttl
|
||||
|
||||
| | |
|
||||
| ---- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
|
||||
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
|
||||
|
||||
### --activity-bump
|
||||
|
||||
| | |
|
||||
@@ -20,6 +68,58 @@ coder templates edit [flags] <template>
|
||||
|
||||
Edit the template activity bump - workspaces created from this template will have their shutdown time bumped by this value when activity is detected. Maps to "Activity bump" in the UI.
|
||||
|
||||
### --max-ttl
|
||||
|
||||
| | |
|
||||
| ---- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
|
||||
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to "Max lifetime" in the UI.
|
||||
|
||||
### --autostart-requirement-weekdays
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.
|
||||
|
||||
### --failure-ttl
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
|
||||
|
||||
### --dormancy-threshold
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
|
||||
|
||||
### --dormancy-auto-deletion
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
|
||||
|
||||
### --allow-user-cancel-workspace-jobs
|
||||
|
||||
| | |
|
||||
| ------- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>true</code> |
|
||||
|
||||
Allow users to cancel in-progress workspace jobs.
|
||||
|
||||
### --allow-user-autostart
|
||||
|
||||
| | |
|
||||
@@ -38,105 +138,14 @@ Allow users to configure autostart for workspaces on this template. This can onl
|
||||
|
||||
Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled in enterprise.
|
||||
|
||||
### --allow-user-cancel-workspace-jobs
|
||||
### --require-active-version
|
||||
|
||||
| | |
|
||||
| ------- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>true</code> |
|
||||
| | |
|
||||
| ------- | ------------------ |
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Allow users to cancel in-progress workspace jobs.
|
||||
|
||||
### --autostart-requirement-weekdays
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.
|
||||
|
||||
### --default-ttl
|
||||
|
||||
| | |
|
||||
| ---- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
|
||||
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
|
||||
|
||||
### --deprecated
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
|
||||
|
||||
### --description
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template description.
|
||||
|
||||
### --display-name
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template display name.
|
||||
|
||||
### --dormancy-auto-deletion
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
|
||||
|
||||
### --dormancy-threshold
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
|
||||
|
||||
### --failure-ttl
|
||||
|
||||
| | |
|
||||
| ------- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
| Default | <code>0h</code> |
|
||||
|
||||
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
|
||||
|
||||
### --icon
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template icon path.
|
||||
|
||||
### --max-ttl
|
||||
|
||||
| | |
|
||||
| ---- | --------------------- |
|
||||
| Type | <code>duration</code> |
|
||||
|
||||
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to "Max lifetime" in the UI.
|
||||
|
||||
### --name
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Edit the template name.
|
||||
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
|
||||
|
||||
### --private
|
||||
|
||||
@@ -147,15 +156,6 @@ Edit the template name.
|
||||
|
||||
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
|
||||
|
||||
### --require-active-version
|
||||
|
||||
| | |
|
||||
| ------- | ------------------ |
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
|
||||
Generated
+8
-8
@@ -20,6 +20,14 @@ coder templates pull [flags] <name> [destination]
|
||||
|
||||
Output the template as a tar archive to stdout.
|
||||
|
||||
### --zip
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Output the template as a zip archive to stdout.
|
||||
|
||||
### --version
|
||||
|
||||
| | |
|
||||
@@ -35,11 +43,3 @@ The name of the template version to pull. Use 'active' to pull the active versio
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
|
||||
### --zip
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Output the template as a zip archive to stdout.
|
||||
|
||||
Generated
+50
-50
@@ -12,6 +12,54 @@ coder templates push [flags] [template]
|
||||
|
||||
## Options
|
||||
|
||||
### --variables-file
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a file path with values for Terraform-managed variables.
|
||||
|
||||
### --variable
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of values for Terraform-managed variables.
|
||||
|
||||
### --var
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Alias of --variable.
|
||||
|
||||
### --provisioner-tag
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of tags to target provisioner daemons.
|
||||
|
||||
### --name
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a name for the new template version. It will be automatically generated if not provided.
|
||||
|
||||
### --always-prompt
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Always prompt all parameters. Does not pull parameter values from active template version.
|
||||
|
||||
### --activate
|
||||
|
||||
| | |
|
||||
@@ -21,13 +69,13 @@ coder templates push [flags] [template]
|
||||
|
||||
Whether the new template will be marked active.
|
||||
|
||||
### --always-prompt
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Always prompt all parameters. Does not pull parameter values from active template version.
|
||||
Bypass prompts.
|
||||
|
||||
### -d, --directory
|
||||
|
||||
@@ -54,51 +102,3 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
|
||||
|
||||
### --name
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a name for the new template version. It will be automatically generated if not provided.
|
||||
|
||||
### --provisioner-tag
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of tags to target provisioner daemons.
|
||||
|
||||
### --var
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Alias of --variable.
|
||||
|
||||
### --variable
|
||||
|
||||
| | |
|
||||
| ---- | ------------------------- |
|
||||
| Type | <code>string-array</code> |
|
||||
|
||||
Specify a set of values for Terraform-managed variables.
|
||||
|
||||
### --variables-file
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specify a file path with values for Terraform-managed variables.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
|
||||
Generated
+1
-1
@@ -26,6 +26,6 @@ coder templates versions
|
||||
|
||||
| Name | Purpose |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------- |
|
||||
| [<code>archive</code>](./templates_versions_archive.md) | Archive a template version(s). |
|
||||
| [<code>list</code>](./templates_versions_list.md) | List all the versions of the specified template |
|
||||
| [<code>archive</code>](./templates_versions_archive.md) | Archive a template version(s). |
|
||||
| [<code>unarchive</code>](./templates_versions_unarchive.md) | Unarchive a template version(s). |
|
||||
|
||||
Generated
+8
-8
@@ -12,6 +12,14 @@ coder templates versions list [flags] <template>
|
||||
|
||||
## Options
|
||||
|
||||
### --include-archived
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Include archived versions in the result list.
|
||||
|
||||
### -c, --column
|
||||
|
||||
| | |
|
||||
@@ -21,14 +29,6 @@ coder templates versions list [flags] <template>
|
||||
|
||||
Columns to display in table output. Available columns: name, created at, created by, status, active, archived.
|
||||
|
||||
### --include-archived
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Include archived versions in the result list.
|
||||
|
||||
### -o, --output
|
||||
|
||||
| | |
|
||||
|
||||
Generated
+8
-8
@@ -18,14 +18,6 @@ Use --always-prompt to change the parameter values of the workspace.
|
||||
|
||||
## Options
|
||||
|
||||
### --always-prompt
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Always prompt all parameters. Does not pull parameter values from existing workspace.
|
||||
|
||||
### --build-option
|
||||
|
||||
| | |
|
||||
@@ -60,3 +52,11 @@ Rich parameter value in the format "name=value".
|
||||
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
|
||||
|
||||
Specify a file path with values for rich parameters defined in the template.
|
||||
|
||||
### --always-prompt
|
||||
|
||||
| | |
|
||||
| ---- | ----------------- |
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Always prompt all parameters. Does not pull parameter values from existing workspace.
|
||||
|
||||
Generated
+2
-2
@@ -18,9 +18,9 @@ coder users [subcommand]
|
||||
|
||||
| Name | Purpose |
|
||||
| -------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| [<code>activate</code>](./users_activate.md) | Update a user's status to 'active'. Active users can fully interact with the platform |
|
||||
| [<code>create</code>](./users_create.md) | |
|
||||
| [<code>delete</code>](./users_delete.md) | Delete a user by username or user_id. |
|
||||
| [<code>list</code>](./users_list.md) | |
|
||||
| [<code>show</code>](./users_show.md) | Show a single user. Use 'me' to indicate the currently authenticated user. |
|
||||
| [<code>delete</code>](./users_delete.md) | Delete a user by username or user_id. |
|
||||
| [<code>activate</code>](./users_activate.md) | Update a user's status to 'active'. Active users can fully interact with the platform |
|
||||
| [<code>suspend</code>](./users_suspend.md) | Update a user's status to 'suspended'. A suspended user cannot log into the platform |
|
||||
|
||||
Generated
+4
-4
@@ -18,13 +18,13 @@ coder users create [flags]
|
||||
|
||||
Specifies an email address for the new user.
|
||||
|
||||
### --login-type
|
||||
### -u, --username
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Optionally specify the login type for the user. Valid values are: password, none, github, oidc. Using 'none' prevents the user from authenticating and requires an API key/token to be generated by an admin.
|
||||
Specifies a username for the new user.
|
||||
|
||||
### -p, --password
|
||||
|
||||
@@ -34,10 +34,10 @@ Optionally specify the login type for the user. Valid values are: password, none
|
||||
|
||||
Specifies a password for the new user.
|
||||
|
||||
### -u, --username
|
||||
### --login-type
|
||||
|
||||
| | |
|
||||
| ---- | ------------------- |
|
||||
| Type | <code>string</code> |
|
||||
|
||||
Specifies a username for the new user.
|
||||
Optionally specify the login type for the user. Valid values are: password, none, github, oidc. Using 'none' prevents the user from authenticating and requires an API key/token to be generated by an admin.
|
||||
|
||||
Reference in New Issue
Block a user