Skip to content

Reliary/quale

Repository files navigation

quale

PyPI version Python versions CI License

Structural codebase analysis - no parsers, no config, any language.

Quickstart

pip install quale

cd my-project
quale ec --files src/route.ts    # agent: edit context (75% accuracy)
quale o                          # agent: repo orientation
quale review                     # human: per-file review summary
quale ci check origin/main HEAD  # CI: automated gates

Commands by persona

Commands are organized into four personas — LLM agents are the primary design target (measured 75% accuracy, 0.0 extra edits):

Persona Prefix Commands
LLM agent quale o (orient), ec (edit-context, 75% accuracy), vp (verify-packet, 80% accuracy)
Human developer quale review, onboard, refactor-cost, inspect, explore
CI pipeline quale ci check, comment, trend, init (GitHub Actions generator)
Structural primitives quale core 60+ commands including hub-risk, spectral-gap, criticality

LLM agent

Add two lines to your agent's MCP config, or drop the skill file into OpenCode — no prompt engineering, no hand-holding:

# MCP: add to opencode.json or claude_desktop_config.json
# Skill: already installed at ~/.config/opencode/skills/quale/SKILL.md

Agent commands return structured JSON — no terminal output to parse. Short aliases keep shell commands concise:

Command Alias What it returns
quale o 2 chars Repo map: modules, landmarks, languages, recommended workflow
quale ec --files <file> 4 words Edit context + verification_mc candidates (75% accuracy)
quale vp --files <file> 4 words Verification packet with co-change signal (80% accuracy)

Two integration modes:

  1. MCP server (quale --mcp) — the 3 commands above as typed MCP tools. Add to ~/.config/opencode/opencode.json:

    {"quale": {"type": "local", "command": ["quale", "--mcp"]}}

    Works with any MCP agent: Claude Desktop, Claude Code, Cursor, VS Code. See docs/MCP_SETUP.md for each config.

  2. Skill file — auto-loaded by OpenCode. The agent calls quale ec before every edit without manual prompting. Already installed at ~/.config/opencode/skills/quale/SKILL.md.

Measured effect (1,100 trials, 12 repos, 6 model families): baseline test-file accuracy 10-20%. With quale ec: 75% accuracy, zero extra edits.1

Human developer

Command What it does
quale review Per-file review: stable anchors, hub risk, test gaps, action items
quale onboard Onboarding plan: languages, macro-modules, landmark files
quale refactor-cost <file> Effort estimate: direct impact, transitive ripple, clones
quale inspect . Codebase overview: tech stack, module layout, health
quale explore . Best files to read first for a new contributor

Human developer

CI pipeline

Command What it does
quale ci init Generates a GitHub Actions YAML
quale ci check <base> <head> Runs structural gates, exits 0-7 with bitmask
quale ci comment <base> <head> Posts structural report as GitHub PR comment
quale ci trend Tracks CI metric trends over time

Advanced primitives

See quale core --help for 60+ commands including hub-risk, spectral-gap, criticality, coupling-chain, diff-structural, test-gaps, and more.

How it works

flowchart LR
    A[Source files] --> B[Vocabulary extraction]
    B --> C[Co-occurrence matrix]
    C --> D[Structural analysis]
    D --> E[Human output]
    D --> F[CI gates]
    D --> G[Agent JSON]
Loading

Quale reads every source file as text and builds a vocabulary for each one. Words and identifiers are extracted by splitting on delimiters (. _ - / CamelCase - no AST or parser needed). Stopwords, imports, and keywords are stripped.

These per-file vocabularies are assembled into a sparse co-occurrence matrix: if two files both contain the identifier createUser, they share an edge. The matrix captures vocabulary overlap relationships: which files speak the same "language" - without parsing imports, ASTs, or data flow. This naturally reveals module alignment, test coverage gaps, and files that act as vocabulary hubs.

The same delimiter-splitting pipeline works without modification across languages - there is no grammar file, no AST plugin, no language-specific config. Quale treats every source file as text, so it handles any language the same way. The quality of the output depends on the codebase having enough identifiers to build a meaningful matrix.

What the matrix reveals

Metric What it measures Why it matters
Hub risk Files coupled to many others but rarely edited Changes to these files break many dependents; they need careful review
Spectral gap Size ratio of largest vs second-largest vocabulary cluster A gap > 3x often points to a monolith - one module's vocabulary dominates the repo
Test mirror Structural overlap between source and test files Low overlap suggests tests don't exercise the source vocabulary directly
Criticality (k) Change amplification factor k > 1 means changes cascade - touching one file affects many through shared vocabulary
Entropy Directory-level vocabulary dispersion High-entropy directories use identifiers inconsistently across files
Coupling chain N-hop transitive file coupling The indirect blast radius - changing A may break C through B
Stable core Files whose vocabulary is stable across git history Low-risk refactoring targets
Clone detection Near-identical identifier sets across files Candidates for deduplication
flowchart LR
    A[Co-occurrence matrix] --> B[Hub risk]
    A --> C[Spectral gap]
    A --> D[Test mirror ratio]
    A --> E[Criticality k]
    A --> F[Coupling chains]
    B --> G[quale review / agent guard]
    C --> G
    D --> G
    E --> G
    F --> G
    G --> H[Terminal report or structured JSON]
Loading

What it is and what it's not

What it is:

  • A structural vocabulary analyzer for codebases
  • A code review tool that surfaces coupling, test gaps, and stable anchors
  • A CI gate that checks for structural regressions
  • An LLM agent helper that provides repo context in structured JSON

What it's not:

  • Not a linter (no AST, no rule engine, no style checking)
  • Not a test coverage tool (vocabulary overlap ≠ statement coverage)
  • Not a security scanner (no data flow, no taint analysis)
  • Not a dependency graph (import paths are never parsed - co-occurrence is inferred from identifier sharing, which is different)
  • Not useful on a brand-new repo with fewer than ~50 files - there's no structure to measure
  • Not a replacement for human code review - it catches structural blind spots, not logic bugs

Practical limits

  • git history required for diff-based commands
  • 75% verification accuracy on test-file prediction — the remaining 25% are repos without stem-matched tests or co-change history. When quale can't find the right file, it says so rather than guessing.

Development

git clone https://github.com/Reliary/quale
cd quale
pip install -e ".[dev]"

python -m pytest tests/ -v
ruff check quale/
mypy quale/ --ignore-missing-imports

Deep dive

License

MIT

Footnotes

  1. Full methodology at docs/EFFECT_HARNESS.md. Models tested: Qwen, Gemma, Nemotron, Mistral, Claude, local Gemma — every model guessed the wrong test file without quale and found the right one with it.

About

Grammar-free CLI that tells LLMs what to edit, what to test, and what to leave alone

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors