Skip to content

Repository files navigation

Signal Review

Signal Review is a local-first code review tool that runs a read-only review pipeline against a repository checkout and works with any OpenAI-compatible backend, including Ollama.

It ships with:

  • a reusable review engine
  • a local CLI
  • a /review skill wrapper
  • structured JSON output for automation

What it is for

  • reviewing large, integrated codebases
  • keeping review tooling local and low-cost
  • producing stable review reports with score, summary, and findings
  • fitting into agent workflows without handing control to a paid external service

Quick Start

npm install
npm run review -- --base-url http://127.0.0.1:11434 --model qwen2.5:14b

For a direct executable:

node scripts/review.js --base-url http://127.0.0.1:11434 --model qwen2.5:14b

macOS App

The repo includes a macOS launcher app that wraps the CLI and stores setup in ~/Library/Application Support/Signal Review/config.json.

Build it with:

npm run package:macos

That command stages dist/macos/Signal Review.app. When run on macOS, it also creates a DMG in dist/.

The first launch prompts for the repository to review, the backend URL, and the model name. The launcher then opens Terminal and runs the review CLI with those saved settings.

Note: the current launcher expects Node.js 22+ to be installed on the Mac.

Linux App

The repo also includes a native Linux app directory that wraps the same CLI and stores setup in ~/.config/signal-review/config.json.

Build it with:

npm run package:linux

That command stages dist/linux/Signal Review.AppDir and, when appimagetool is available, creates a Linux AppImage alongside it.

The Linux launcher uses Zenity for GUI setup and report display when available, and falls back to terminal prompts if it is not.

Output

  • Human-readable summary by default
  • JSON with --json
  • Exit codes:
    • 0 clean review
    • 2 findings present
    • 1 runtime failure

Repository Layout

  • src/services/local-review/ - review engine, context collection, backend adapter, CLI
  • scripts/review.js - executable entry point
  • tests/services/ - behavior tests
  • .agents/skills/review/SKILL.md - /review skill wrapper
  • docs/signal-review.md - branding and repo naming handoff

Contributing

Use short-lived codex/* branches, keep changes focused, and run npm run verify before opening a pull request.

See CONTRIBUTING.md for the branch and PR workflow.

License

MIT

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages