Skip to content

doc: add table comparing ways to consume capa output#2874

Merged
mike-hunhoff merged 4 commits intomandiant:masterfrom
devs6186:fix/2273-doc-output-consumption-table
Mar 2, 2026
Merged

doc: add table comparing ways to consume capa output#2874
mike-hunhoff merged 4 commits intomandiant:masterfrom
devs6186:fix/2273-doc-output-consumption-table

Conversation

@devs6186
Copy link
Contributor

closes #2273

Users often ask about the different ways to work with capa results. There was no single place comparing CLI, IDA Pro, Ghidra, CAPE/sandbox, and Web (capa Explorer).

Changes

  • Added a new "Ways to consume capa output" section at the top of doc/usage.md with a concise table listing: CLI, IDA Pro, Ghidra, CAPE (dynamic sandbox), and Web (capa Explorer) — including the output/interface and typical use for each.

Checklist

  • No CHANGELOG update needed
  • No new tests needed
  • No documentation update needed
  • This submission includes AI-generated code and I have provided details in the description.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @devs6186, 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 capa documentation by providing a clear and concise comparison of the various methods available for consuming capa output. This addresses common user questions by centralizing information on each method's interface and typical use, making it easier for users to understand and choose the most appropriate tool for their needs.

Highlights

  • Documentation Improvement: A new section titled "Ways to consume capa output" was added to doc/usage.md, featuring a table that compares different methods for interacting with capa results, including CLI, IDA Pro, Ghidra, CAPE, and Web (capa Explorer).

🧠 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.

Changelog
  • CHANGELOG.md
    • Added a new development entry for the documentation update.
  • doc/usage.md
    • Introduced a new section "Ways to consume capa output" with a table comparing different consumption methods.
    • Detailed the output/interface and typical use for CLI, IDA Pro, Ghidra, CAPE, and Web (capa Explorer) within the new table.
Activity
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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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

The pull request introduces a new table to doc/usage.md comparing different ways to consume capa output, which is a good addition for user clarity. It also includes a corresponding entry in CHANGELOG.md. The changes are straightforward and improve documentation. No critical issues were found.

@mike-hunhoff
Copy link
Collaborator

@devs6186 please resolve the merge conflicts.

Add a short table to usage.md for CLI, IDA, Ghidra, CAPE, and web.

Fixes mandiant#2273
Addresses reviewer feedback to provide a link to learn more for each
consumption method (IDA Pro, Ghidra, CAPE, Web/capa Explorer).

Refs mandiant#2273
@devs6186 devs6186 force-pushed the fix/2273-doc-output-consumption-table branch from 2e3c9aa to ea88b74 Compare February 24, 2026 03:52
@devs6186
Copy link
Contributor Author

@devs6186 please resolve the merge conflicts.

i have resolved all conflicts for all my ope prs, it waiting for your approval thank you!

@mike-hunhoff
Copy link
Collaborator

@devs6186 please resolve conflicts and we can get this merged.

Resolve CHANGELOG.md conflict by keeping both the doc entry (mandiant#2273)
and the binja entry (mandiant#2399) in the Development section.
@mike-hunhoff mike-hunhoff merged commit 2e36f67 into mandiant:master Mar 2, 2026
2 checks passed
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.

introduce a table to compare/contrast the ways of consuming capa output

3 participants