Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add a description to the root command #108

Merged
merged 2 commits into from
Oct 18, 2024

Conversation

obs-gh-mattcotter
Copy link
Collaborator

@obs-gh-mattcotter obs-gh-mattcotter commented Oct 17, 2024

Description

OB-37820 Here's how it looks now:

$ ./observe-agent help
Observe distribution of OTEL Collector along with CLI utils to help with setup
and maintenance. To start the agent, run: observe-agent start

Usage:
  observe-agent [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  diagnose    Run diagnostic checks.
  help        Help about any command
  init-config Initialize agent configuration
  start       Start the Observe agent process.
  status      Display status of agent
  version     Display the currently installed version of the observe-agent.

Flags:
      --config string   config file path
  -h, --help            help for observe-agent
  -t, --toggle          Help message for toggle

Use "observe-agent [command] --help" for more information about a command.

@obs-gh-mattcotter obs-gh-mattcotter merged commit 9b75d11 into main Oct 18, 2024
8 checks passed
@obs-gh-mattcotter obs-gh-mattcotter deleted the OB-37820-root-command-desc branch October 18, 2024 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants