Skip to content

[Bug]: UX - CLI top-level subcommands scrambled at the end #349

@egernst

Description

@egernst

I have done the following

  • I have searched the existing issues
  • If possible, I've reproduced the issue using the 'main' branch of this project

Steps to reproduce

I added a plugin for local testing and noticed that --help output for a plugin, from here https://github.com/apple/container/blob/main/Sources/ContainerPlugin/PluginLoader.swift#L75, adds an extra newline at the end, which looks awkward when viewing --help in context of the rest of the built in commands.

Example:

$ container --help
OVERVIEW: A container platform for macOS
USAGE: container [--debug] <subcommand>
OPTIONS:
  --debug                 Enable debug output [environment: CONTAINER_DEBUG]
  --version               Show the version.
  -h, --help              Show help information.
CONTAINER SUBCOMMANDS:
  create                  Create a new container
  delete, rm              Delete one or more containers
  exec                    Run a new command in a running container
  inspect                 Display information about one or more containers
  kill                    Kill one or more running containers
  list, ls                List containers
  logs                    Fetch container stdio or boot logs
  run                     Run a container
  start                   Start a container
  stop                    Stop one or more running containers
IMAGE SUBCOMMANDS:
  build                   Build an image from a Dockerfile
  images, image, i        Manage images
  registry, r             Manage registry configurations
OTHER SUBCOMMANDS:
  builder                 Manage an image builder instance
  network, n              Manage container networks
PLUGINS:
  my-plugin                  Super rad plugin (Eric)

  system, s               Manage system components

Note, it's the extra newline between 'my-plugin' and system that feels odd. In addition, perhaps PLUGINS section should just be at end, instead of in middle of "other subcommands"?

Current behavior

there's an extra line..

Expected behavior

Either in its own section, or in this place. No extra new line after last plugin.

Environment

- OS: 
- Xcode: 
- Container:

Relevant log output

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions