CLI Reference for other commands¶
Config¶
cctl config¶
change engines configuration
Usage:
cctl config [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
cctl config add-alias¶
Usage:
cctl config add-alias [OPTIONS] COMMAND ALIAS
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
cctl config add-engine¶
Usage:
cctl config add-engine [OPTIONS] NAME URL
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-u, --user |
text | Username for Basic Auth | None |
-p, --password |
text | Password for Basic Auth | None |
-s, --select |
boolean | directly select this context | False |
--no-verify |
boolean | do not verify ssl | False |
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
cctl config edit¶
Usage:
cctl config edit [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-e, --editor |
text | Specify the editor you want to use | None |
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
cctl config get-alias¶
Usage:
cctl config get-alias [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
cctl config get-engines¶
Usage:
cctl config get-engines [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
cctl config remove-alias¶
Usage:
cctl config remove-alias [OPTIONS] ALIAS
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
cctl config remove-engine¶
Usage:
cctl config remove-engine [OPTIONS] NAME
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
cctl config use-engine¶
Usage:
cctl config use-engine [OPTIONS] NAME
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
Schema¶
cctl schema¶
Usage:
cctl schema [OPTIONS] SCHEMA_NAME
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-f, --format |
choice (json | yaml) |
N/A | yaml |
--traceback |
boolean | do not hide traceback on error | False |
--help |
boolean | Show this message and exit. | False |
Info¶
cctl info¶
Usage:
cctl info [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-oT, --output-template |
text | provide a template name (one of default, result-length) or provide a jinja2 template string that will be used. | None |
-o, --output |
choice (template) |
N/A | template |
--help |
boolean | Show this message and exit. | False |