Skip to content

docs: update README yara section — subcommand is wired, tested, and in CI - #15

Merged
warpedatom merged 1 commit into
mainfrom
docs/readme-yara-accurate
Jul 21, 2026
Merged

docs: update README yara section — subcommand is wired, tested, and in CI#15
warpedatom merged 1 commit into
mainfrom
docs/readme-yara-accurate

Conversation

@warpedatom

@warpedatom warpedatom commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Documentation:

  • Expand README documentation for the yara-scan feature, its gating requirements, behavior differences, and example offsetscan yara CLI invocations.

@sourcery-ai

sourcery-ai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The PR updates the README’s YARA section to reflect that the offsetscan yara subcommand is now wired, tested, and exercised in CI, clarifying feature-gating, build requirements, behavior, and providing usage examples.

File-Level Changes

Change Details Files
Update README documentation for the yara-scan feature and offsetscan yara subcommand to describe current behavior, gating, CI coverage, and usage.
  • Remove outdated note that yara-scan is experimental, not built in CI, and untested against real rules.
  • Describe the offsetscan yara subcommand, its record schema, and parity with Invoke-OffsetYaraScan.
  • Clarify that the feature is gated and off by default, and document the need for a C toolchain and libclang due to the vendored libyara via bindgen.
  • Note that a dedicated CI job builds and tests the feature on Linux with libclang installed.
  • Explain lossy decoding of non-printable match bytes into Data and how this can diverge from the YARA CLI’s rendering.
  • Add concrete usage examples showing how to build with --features yara-scan and invoke offsetscan yara over single files and recursive corpora with multiple rule files.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@warpedatom
warpedatom merged commit 895a573 into main Jul 21, 2026
6 checks passed
@warpedatom
warpedatom deleted the docs/readme-yara-accurate branch July 21, 2026 06:31
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.

1 participant