Skip to content

main: add project links and verbosity hint to CLI help text#2940

Open
Xavrir wants to merge 2 commits intomandiant:masterfrom
Xavrir:improve-cli-help-text-1686
Open

main: add project links and verbosity hint to CLI help text#2940
Xavrir wants to merge 2 commits intomandiant:masterfrom
Xavrir:improve-cli-help-text-1686

Conversation

@Xavrir
Copy link

@Xavrir Xavrir commented Mar 17, 2026

Summary

Addresses suggestions from #1686 (review clig.dev for CLI guidelines):

  • Add GitHub repository, documentation, and issue reporting links to the CLI help epilog, following clig.dev's recommendation to include a support path in top-level help text
  • Add a hint about -v/--verbose and -vv/--vverbose flags so users know how to get more detailed output

These are the changes that were explicitly discussed and approved in #1686 (GitHub link approved by @mr-tz, verbosity hint suggested by @williballenthin).

Changes

capa/main.py: Added 6 lines to the CLI help epilog:

  • Verbosity hint line
  • Three labeled links (GitHub, Documentation, Report issues)

CHANGELOG.md: Added two entries under New Features.

Test plan

  • black --check passes (no formatting changes needed)
  • Verify capa --help displays the new links and hint correctly at the bottom of the help text
  • CI passes

Closes #1686

@google-cla
Copy link

google-cla bot commented Mar 17, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the command-line interface by improving its help text. The changes aim to provide users with easier access to support resources and clearer guidance on how to control output verbosity, thereby improving the overall user experience and discoverability of features.

Highlights

  • CLI Help Text Enhancement: Added GitHub repository, documentation, and issue reporting links to the CLI help epilog, aligning with clig.dev recommendations for providing support paths.
  • Verbosity Hint: Included a hint in the CLI help epilog about using -v/--verbose and -vv/--vverbose flags to guide users on obtaining more detailed output.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request enhances the command-line interface's help text by adding a hint for verbosity flags and links to the project's GitHub repository, documentation, and issue tracker. This is a valuable improvement for user experience. I've suggested a small refinement to the documentation link to point to the rendered website and adjusted the alignment for better readability.

Add GitHub repository, documentation, and issue reporting links to the
CLI help epilog, following clig.dev guidelines for including support
paths in help text. Also add a hint about -v/--verbose and -vv/--vverbose
flags for users who want more detailed output.

Closes mandiant#1686
@Xavrir Xavrir force-pushed the improve-cli-help-text-1686 branch from 962cb2f to c91a5d7 Compare March 17, 2026 23:55
Comment on lines +7 to +8
- main: add GitHub, documentation, and issue reporting links to CLI help text @Xavrir #1686
- main: add verbosity hint to CLI help epilog @Xavrir #1686
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please collapse into a single entry.

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.

review clig.dev for CLI guidelines

2 participants