docs: Fix cli usage examples

[chipshort]

Description

The usage example was not reflecting the actual parameters

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification (not applicable, there is no issue)
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests (should this be tested?)
• added a changelog entry to CHANGELOG.md (Is this needed?)
• updated the relevant documentation or specification, including comments for documenting Go code (not applicable)
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Updated command-line query syntax for ordering parameters from --order-by to --order_by.

• Documentation

  • Revised documentation to reflect the new parameter naming convention for consistency.

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a modification to the command-line query string format in the server/cmt_cmds.go and server/v2/cometbft/commands.go files. The parameter name has been updated from --order-by to --order_by, requiring users to adopt an underscore instead of a hyphen. While the command's functionality remains unchanged, this adjustment necessitates updates to user documentation and any scripts that utilize this command format.

Changes

Files	Change Summary
server/cmt_cmds.go, server/v2/cometbft/commands.go	Changed parameter name from --order-by to --order_by for consistency in command syntax.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CommandParser
    participant CommandExecutor

    User->>CommandParser: Input command with --order_by
    CommandParser->>CommandExecutor: Execute command with ordering
    CommandExecutor-->>User: Return results

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c55e8d7 and 2b703d6.

Files selected for processing (2)

• server/cmt_cmds.go (1 hunks)
• server/v2/cometbft/commands.go (1 hunks)

Files skipped from review due to trivial changes (1)

• server/v2/cometbft/commands.go

Additional context used

Path-based instructions (1)

server/cmt_cmds.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (1)

server/cmt_cmds.go (1)

186-186: Verify the accuracy and consistency of the parameter name change.

The parameter name has been updated from --order-by to --order_by. Ensure that this change is consistent with the rest of the codebase and documentation.

[julienrbrt]

ACK.