Files
docker-docs/data/scout-cli/docker_scout_config.yaml
David Karlsson ec72262eed scout: remove module for cli docs, vendor manually
Upstream docs had a formatting issue that needed a hotfix.
Rather than fixing the vendored yaml,
which would be overwritten the next time update (any) vendored modules,
I decided to manually copy the cli reference yaml to the data dir.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-01-05 09:18:29 +01:00

60 lines
1.4 KiB
YAML

command: docker scout config
short: Manage Docker Scout configuration
long: |-
`docker scout config` allows you to list, get and set Docker Scout configuration.
Available configuration key:
- `organization`: Namespace of the Docker organization to be used by default.
usage: docker scout config [KEY] [VALUE]
pname: docker scout
plink: docker_scout.yaml
inherited_options:
- option: debug
value_type: bool
default_value: "false"
description: Debug messages
deprecated: false
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: verbose-debug
value_type: bool
default_value: "false"
description: Verbose debug
deprecated: false
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
### List existing configuration
```console
$ docker scout config
organization=my-org-namespace
```
### Print configuration value
```console
$ docker scout config organization
my-org-namespace
```
### Set configuration value
```console
$ docker scout config organization my-org-namespace
✓ Successfully set organization to my-org-namespace
```
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false