chore(docs): update terramaid run -h output

[chenrui333]

Why

update run command help output

followup #65

relates to Homebrew/homebrew-core#199510

Summary by CodeRabbit

• Documentation
  • Updated usage instructions for the terramaid utility.
  • Refined description to clarify functionality.
  • Improved command structure for better usability.
  • Added and updated flags for enhanced command options.

[coderabbitai]

Walkthrough

The changes in this pull request focus on updating the README.md file for the terramaid utility. The documentation has been refined to clarify the command usage and enhance the descriptions of various flags. Notable updates include a change in the command structure to terramaid run [flags], the introduction of a new flag for specifying the chart type, and corrections to existing flag descriptions for better clarity.

Changes

File	Change Summary
README.md	Updated usage instructions for terramaid, changed command structure to terramaid run [flags], added -c, --chart-type string flag, clarified -r, --direction string, updated -s, --subgraph-name string, and corrected -w, --working-dir string typo.

Poem

In the land of code where rabbits play,
terramaid shines bright, guiding the way.
With flags all in line, and commands so clear,
Generating diagrams brings us good cheer!
Hop along, dear friends, let’s code and create,
With Mermaid in hand, our diagrams await! 🐇✨

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 634f57f and 115f421.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (2)

README.md (2)

116-129: Documentation improvements look great!

The help output updates are well-structured and provide clear information about:

• Command usage
• Available flags
• Environment variables
• Default values

---

116-116: Verify backward compatibility of command structure change

The command structure has changed from terramaid [flags] to terramaid run [flags]. This could be a breaking change for existing users.

Let's check if this is documented elsewhere in the codebase:

Also applies to: 119-119

[RoseSecurity]

Thank you for the contribution!