finch
finch copied to clipboard
Inconsistent messaging in `--help` output
Describe the bug
When I do finch build --help, the output ends with:
See also 'finch --help' for the global flags such as '--namespace', '--snapshotter', and '--cgroup-manager'.
However running finch --help does not mention the --napespace, --snapshotter and --cgroup-manager options, which is confusing:
$ finch --help
Finch: open-source container development tool
Usage:
finch [command]
Available Commands:
build Build an image from Dockerfile
builder Manage builds
commit Create a new image from a container's changes
completion Generate the autocompletion script for the specified shell
compose Compose
container Manage containers
cp Copy files/folders between a running container and the local filesystem
create Create a new container
events Get real time events from the server
exec Run a command in a running container
help Help about any command
history Show the history of an image
image Manage images
images List images
info Display system-wide information
inspect Return low-level information on Docker objects
kill Kill one or more running containers
load Load an image from a tar archive or STDIN
login Log in to a container registry
logout Log out from a container registry
logs Fetch the logs of a container
network Manage networks
pause Pause all processes within one or more containers
port List port mappings or a specific mapping for the container
ps List containers
pull Pull an image from a registry
push Push an image or a repository to a registry
restart Restart one or more containers
rm Remove one or more containers
rmi Remove one or more images
run Run a command in a new container
save Save one or more images to a tar archive (streamed to STDOUT by default)
start Start one or more stopped containers
stats Display a live stream of container(s) resource usage statistics
stop Stop one or more running containers
support-bundle Support bundle management
system Manage containerd
tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
top Display the running processes of a container
unpause Unpause all processes within one or more containers
update Update configuration of one or more containers
version Shows Finch version information
vm Manage the virtual machine lifecycle
volume Manage volumes
wait Block until one or more containers stop, then print their exit codes
Flags:
--debug running under debug mode
-h, --help help for finch
-v, --version version for finch
Use "finch [command] --help" for more information about a command.
Steps to reproduce
$ finch build --help
$ finch --help
Expected behavior
I expect the output of finch --help to mention the elements that the finch build --help output suggests it should contain; or that finch build --help does not point to finch --help for content that is not presented there.
Screenshots or logs
$ finch build --help
Build an image from a Dockerfile. Needs buildkitd to be running.
If Dockerfile is not present and -f is not specified, it will look for Containerfile and build with it.
Usage: finch build [flags] PATH
Flags:
--build-arg stringArray Set build-time variables
--buildkit-host string BuildKit address [$BUILDKIT_HOST] (default "unix:///run/buildkit/buildkitd.sock")
--cache-from stringArray External cache sources (eg. user/app:cache, type=local,src=path/to/dir)
--cache-to stringArray Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)
-f, --file string Name of the Dockerfile
-h, --help help for build
--iidfile string Write the image ID to the file
--label stringArray Set metadata for an image
--no-cache Do not use cache when building the image
-o, --output string Output destination (format: type=local,dest=path)
--platform strings Set target platform for build (e.g., "amd64", "arm64")
--progress string Set type of progress output (auto, plain, tty). Use plain to show container output (default "auto")
-q, --quiet Suppress the build output and print image ID on success
--rm Remove intermediate containers after a successful build (default true)
--secret stringArray Secret file to expose to the build: id=mysecret,src=/local/secret
--ssh stringArray SSH agent socket or keys to expose to the build (format: default|<id>[=<socket>|<key>[,<key>]])
-t, --tag stringArray Name and optionally a tag in the 'name:tag' format
--target string Set the target build stage to build
See also 'finch --help' for the global flags such as '--namespace', '--snapshotter', and '--cgroup-manager'.
$ finch --help
Finch: open-source container development tool
Usage:
finch [command]
Available Commands:
build Build an image from Dockerfile
builder Manage builds
commit Create a new image from a container's changes
completion Generate the autocompletion script for the specified shell
compose Compose
container Manage containers
cp Copy files/folders between a running container and the local filesystem
create Create a new container
events Get real time events from the server
exec Run a command in a running container
help Help about any command
history Show the history of an image
image Manage images
images List images
info Display system-wide information
inspect Return low-level information on Docker objects
kill Kill one or more running containers
load Load an image from a tar archive or STDIN
login Log in to a container registry
logout Log out from a container registry
logs Fetch the logs of a container
network Manage networks
pause Pause all processes within one or more containers
port List port mappings or a specific mapping for the container
ps List containers
pull Pull an image from a registry
push Push an image or a repository to a registry
restart Restart one or more containers
rm Remove one or more containers
rmi Remove one or more images
run Run a command in a new container
save Save one or more images to a tar archive (streamed to STDOUT by default)
start Start one or more stopped containers
stats Display a live stream of container(s) resource usage statistics
stop Stop one or more running containers
support-bundle Support bundle management
system Manage containerd
tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
top Display the running processes of a container
unpause Unpause all processes within one or more containers
update Update configuration of one or more containers
version Shows Finch version information
vm Manage the virtual machine lifecycle
volume Manage volumes
wait Block until one or more containers stop, then print their exit codes
Flags:
--debug running under debug mode
-h, --help help for finch
-v, --version version for finch
Use "finch [command] --help" for more information about a command.