gitwtfhub

wtf is herald-engine?

async-herald/herald-engine — explained in plain English

Analysis updated 2026-05-18

25RustAudience · developerComplexity · 3/5LicenseSetup · moderate

TL;DR

A Rust code analysis engine that checks code against explicit, readable rules instead of an AI model.

Mindmap

mindmap
  root((Herald))
    What it does
      Rule based code analysis
      No AI black box
      Local only processing
    Tech stack
      Rust
      tree-sitter
      Cargo
    Use cases
      CI pipeline checks
      Custom rule writing
      Local code scoring
    Audience
      Developers
      Rust engineers
      CI pipeline maintainers

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Why would anyone build with this?

REASON 1

Run rule based code analysis locally on a folder or file without sending code to any server.

REASON 2

Add Herald's CLI to a CI pipeline to fail builds when specific code rules are violated.

REASON 3

Write custom .herald rule files to catch project specific code issues.

REASON 4

Get a quality score and precise, explainable findings across 15 supported languages.

What's in the stack?

Rusttree-sitterCargo

How it stacks up

async-herald/herald-enginemeistrari/pdqogham/rust-number-prefix
Stars252525
LanguageRustRustRust
Last pushed2021-07-20
MaintenanceDormant
Setup difficultymoderateeasyeasy
Complexity3/52/52/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you spin it up?

Difficulty · moderate Time to first run · 30min

Requires the Rust toolchain and Cargo to build the CLI from source.

AGPL-3.0: you can use, modify, and redistribute the code, but if you run a modified version as a network service, you must publish your changes as source code.

Wtf does this do

Herald is a code analysis tool, written in Rust, that checks your code against explicit rules rather than using an AI model. Its README is written in French. The idea is that every problem it reports comes from a specific, readable rule, not a black box guess, so you always know exactly why something was flagged, and it produces a quality score for your code alongside the issues it finds. It also does not store your code anywhere, everything runs locally. This particular repository is the open source core of the project. It contains the analysis engine itself, which uses tree-sitter to parse fifteen different programming languages, a custom rule language called .herald for writing analysis rules, a set of built in analyzers, and the scoring logic. It ships with 78 free rules covering areas like security, architecture, quality, and reliability. A command line tool called herald-cli lets you run all of this against your own files on your own machine. The author also runs a paid hosted service called herald.codes, which adds things this open source repository does not include, such as browser based analysis, linking private GitHub or GitLab repositories without cloning them, historical reports, team features, CI/CD integration that checks every pull request, support for very large repositories, and premium rule categories. None of that hosted platform or the premium rules are part of this repository. To use it, you clone the repository and build it with Cargo, then run the resulting binary against a folder or a single file, with a JSON output option for scripting or CI pipelines. The project is released under the AGPL-3.0 license, meaning if you offer a modified version of it as a network service, you must publish your changes as source code too.

Yoink these prompts

Prompt 1
Help me build herald-engine from source with Cargo and run it against my project.
Prompt 2
Explain how to write a custom .herald rule for catching a specific code pattern.
Prompt 3
Show me how to use herald-cli's JSON output in a CI pipeline.
Prompt 4
Walk me through the difference between the free CLI and the hosted herald.codes service.

Frequently asked questions

wtf is herald-engine?

A Rust code analysis engine that checks code against explicit, readable rules instead of an AI model.

What language is herald-engine written in?

Mainly Rust. The stack also includes Rust, tree-sitter, Cargo.

What license does herald-engine use?

AGPL-3.0: you can use, modify, and redistribute the code, but if you run a modified version as a network service, you must publish your changes as source code.

How hard is herald-engine to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is herald-engine for?

Mainly developer.

View the repo → Decode another repo

This repo across BitVibe Labs

Don't trust strangers blindly. Verify against the repo.