Add `--help` option at scope level

[grasmarcussanti129]

Feature Request

The current CLI setup only provides minimal usage information through the README and command usage syntax. It would be beneficial to enhance the user experience by implementing a --help option for each command within the Datadog CI CLI. This would allow users to easily access more detailed information about each command, including options, examples, and descriptions directly through the CLI.

Proposed Changes:

• Implement a --help flag for each command under the relevant scopes (e.g., datadog-ci aas --help, datadog-ci cloud-run --help).
• Include detailed descriptions of what each command does and the options it accepts.
• Provide usage examples to guide users in using the commands effectively.

Benefits:

• Improved user experience and accessibility of information.
• Reduced reliance on external documentation, making it quicker for users to get help as they work with the CLI.

This enhancement would make the tool more user-friendly, especially for new users or those unfamiliar with the various commands.

[Drarig29]

Hi @grasmarcussanti129! We are currently limited by what our CLI library offers us. In the meantime, running datadog-ci aas --help gives you the list of commands that exist:

Unknown Syntax Error: Command not found; did you mean one of:

  0. datadog-ci aas instrument [-d,--dry-run] [-s,--subscription-id #0] [-g,--resource-group #0] [-n,--name #0] [-r,--resource-id #0] [-e,--env-vars #0] [--config #0] [--fips] [--fips-ignore-error] [--service #0] [--env,--environment #0] [--version #0] [--instance-logging] [--log-path #0] [--no-restart] [--dotnet] [--musl] [--source-code-integration,--sourceCodeIntegration] [--upload-git-metadata,--uploadGitMetadata] [--extra-tags,--extraTags #0]
  1. datadog-ci aas uninstrument [-d,--dry-run] [-s,--subscription-id #0] [-g,--resource-group #0] [-n,--name #0] [-r,--resource-id #0] [-e,--env-vars #0] [--config #0] [--fips] [--fips-ignore-error]

While running aas --help

And you can then run datadog-ci aas instrument --help. This will output what you expect.

I'll rename your issue and keep it open for tracking.