GoogleContainerTools / GoogleContainerTools/skaffold

skaffold inspect command does not show all supported flags for its subcommands

Open
#6,562 2 comments 0 reactions 0 assignees View on GitHub
area/cli area/docs area/inspect bugbash/q4-2022 help wanted kind/documentation kind/friction priority/p3
Dominant language
Go
Stars
15.9k
Forks
1.7k
Avg merge
3d 9h
Merged PRs (30d)
10

Description

Currently if you attempt to list flags for `skaffold inspect`, the inherited flags from the root command are not shown. UX-wise I believe this is confusing as it would be hard to find all of the supported flags for the command. Below is an example showing this:
```
aprindle@aprindle ~/skaffold [inspect-tests-add-test-type]$ skaff inspect build-env list --help
Print the list of active build environments.

Examples:
# Get list of target build environments with activated profiles p1 and p2
skaffold inspect build-env list -p p1,p2 --format json

Options:
-p, --profile=[]: Profile names to activate

Usage:
skaffold inspect build-env list [flags] [options]

Use "skaffold options" for a list of global command-line options (applies to all commands).
```

```
aprindle@aprindle ~/skaffold [inspect-tests-add-test-type]$ skaffold inspect --help
Helper commands for Cloud Code IDEs to interact with and modify skaffold configuration files.

Available Commands:
build-env Interact with skaffold build environment definitions.
modules Interact with configuration modules
profiles Interact with configuration profiles

Use "skaffold --help" for more information about a given command.
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.