Skip to main content

Polyglot structural-analysis platform: extract dependency graphs, visualize coupling, track architectural drift.

Project description

code-ranker

CI codecov dependencies Crates.io npm PyPI License

Structural-analysis tool for Rust, Python, JavaScript and TypeScript codebases. Built AI-agent-friendly first — finds where a project has structural problems and hands an actionable shortlist to a human or an AI agent for the actual refactor.

👉 Map your codebase's worst structural problems in 30 seconds — jump to the Rust quick start and run it on your repo now.

Status: pre-alpha. APIs and output shapes may change without notice. Pin a specific version.

Rust quick start

cargo install code-ranker --version 1.1.0   # install the CLI
code-ranker report .                                # make html report in .code-ranker/ folder

report . needs no flags: it writes a self-contained HTML report (plus a JSON snapshot) into .code-ranker/. Open the latest …-<commit>.html to explore the dependency graph, per-file metrics, and the AI prompt generator. Everything below is detail.

Offline & private

code-ranker always runs entirely on your machine. It makes no network calls, sends no telemetry or analytics, and never uploads your code or analysis results anywhere. Generated HTML reports are self-contained — no CDN, no external requests, no tracking.

AI agents friendly

Hand your codebase to an AI agent and let it fix the worst spot. code-ranker is built to feed work straight to an AI coding agent (Claude Code, Cursor, …). Attach the short playbook docs/ai-skill.md to your agent's context — it teaches the agent which two metrics matter (dependency cycles ADP, coupling HK) and the exact fix loop (scorecard → snapshot → fix → re-check → before/after report).

Then just ask, e.g.:

  • "Read https://raw.githubusercontent.com/ffedoroff/code-ranker/main/docs/ai-skill.md. Find the worst dependency cycle in this project and propose a refactor that breaks it — show me the plan before changing code."
  • "Read https://raw.githubusercontent.com/ffedoroff/code-ranker/main/docs/ai-skill.md. Find the most complex / highest-HK file and analyze how to split it; explain what the split buys for me (lower coupling, smaller blast radius). Take a before report, apply the split, take an after report, and show me the HTML diff."

The agent drives the CLI itself — ai-skill.md already spells out the commands and the loop, so no glue is needed.

What it finds

  • Files that grew too complex and should be split. Per-file cyclomatic / cognitive / Halstead / MI metrics; flags files above your threshold.
  • Strong coupling between files. Computes fan-in / fan-out / HK on the file dependency graph; surfaces the files that everything depends on (or that depend on everything). Third-party libraries are tracked separately as depth-1 external nodes (fan_out_external), so they never inflate your internal-coupling numbers.
  • Cyclic dependencies. Detects SCCs in the file graph — including the silent ones the compiler does not catch.
  • Files that are just too big. Raw LOC, public surface size per file.

The tool does not refactor for you. It produces a structured, machine-readable list of problem spots and an offline HTML report a human or an LLM can act on.

CI integration

Runs as a linter. Configure thresholds in code-ranker.toml; the CLI exits non-zero when the codebase breaches them — so a PR that introduces a new cycle, a file above your cognitive budget, or a file above your LOC limit fails the build.

code-ranker check . \
  --threshold file.cognitive=25 --threshold file.loc=800

The linter is the check command — exits non-zero on any cycle or threshold violation, e.g. a PR that introduces a new file-level cycle or a file above your LOC limit (mutual and chain cycle checks are on by default). See docs/CLI.md for all flags.

Add it to your pipeline today — one code-ranker check step stops new cycles and bloat from ever landing.

Full CLI

Written in Rust — fast, memory-safe, single static-ish binary with no runtime dependencies (no Python, no Node, no JVM, no shared libs to install). One file on PATH, done.

Two commands: check (linter — exits non-zero on violations; with --baseline, a relative regression gate) and report (snapshot JSON + offline HTML; with --baseline, a baseline↔current diff). Both accept a directory or an existing .json/.html snapshot as input — analyze once, then run cheap passes over the snapshot. No daemon, no language server, no plugin host required at runtime. Full reference: docs/CLI.md.

HTML report with dynamic diagrams

code-ranker report writes a single self-contained HTML file with:

  • An interactive file dependency graph; third-party libraries appear as depth-1 external nodes in a distinct amber colour with dashed edges.
  • Dagre-laid-out graph with pan/zoom and live filtering.
  • Sortable table per metric; click a node to open its neighbourhood.
  • "Prompt generator" panel that copies a ready-to-paste prompt (one for each principle: ADP, SRP, OCP, LSP, ISP, DIP, DRY, KISS, LoD, MISU, CoI, YAGNI; plus Reduce Complexity, Split Components) — feed the prompt + the selected nodes to your AI agent.

No network, no analytics, no telemetry. Open in any browser, share as a file.

Live demo — code-ranker run on its own repo: interactive HTML report · JSON snapshot (regenerated on every push to main).

Install

Package pages: crates.io · npm · PyPI · Docker Hub · GHCR

Pick a channel:

# universal — shell installer that drops the prebuilt binary on PATH
curl -fsSL https://github.com/ffedoroff/code-ranker/releases/latest/download/code-ranker-installer.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://github.com/ffedoroff/code-ranker/releases/latest/download/code-ranker-installer.ps1 | iex"

# Rust (Cargo)
cargo install code-ranker --version 1.1.0

# Node (npm)
npm install -g code-ranker

# Python (pip / uv / pipx)
pip install code-ranker

# Docker (Docker Hub)
docker pull fedoroff/code-ranker:1.1.0

# Docker (GHCR — no anonymous rate limits)
docker pull ghcr.io/ffedoroff/code-ranker:1.1.0

All channels ship the same code-ranker binary built from the same Rust source. Linux (x86_64, aarch64), macOS (x86_64, aarch64), Windows (x86_64).

Quick start

# lint a project — non-zero exit on violations (CI linter)
code-ranker check ./path/to/project

# analyze and write a snapshot JSON + offline HTML report
code-ranker report
# → .code-ranker/{ts}-{git-hash-3}.json + .code-ranker/{ts}-{git-hash-3}.html
#   (override paths via --output.<fmt>.path or [output.<fmt>] in code-ranker.toml)

# before / after refactor comparison: an HTML diff against a baseline snapshot
code-ranker report . --baseline .code-ranker/before.json

Built-in plugins: rust (cargo + syn), python, javascript (also handles TypeScript) — all compiled into the single binary, nothing to install.

Documentation

  • CLI — commands, flags, and examples
  • Rule reference — rule ids grouped by concern (CYC/CPX/CPL/SIZ), per-file thresholds (file), what each flags, and how to fix it
  • Configcode-ranker.toml schema
  • AI agent skill — a short playbook to attach to an AI agent's context (the ADP/HK fix loop)
  • PRD — product requirements
  • DESIGN — technical design
  • Principles corpus — Rust / Python / TypeScript principle catalogues used by the prompt generator

Try it now

cargo install code-ranker --version 1.1.0 && code-ranker report . && open .code-ranker/

One command on any Rust project — you'll have an interactive structural map and an AI-ready shortlist in seconds. ⭐ the repo if it helps.

License

Apache-2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

code_ranker-1.1.0.tar.gz (873.0 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

code_ranker-1.1.0-py3-none-win_amd64.whl (5.1 MB view details)

Uploaded Python 3Windows x86-64

code_ranker-1.1.0-py3-none-manylinux_2_28_x86_64.whl (5.1 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

code_ranker-1.1.0-py3-none-manylinux_2_28_aarch64.whl (4.8 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

code_ranker-1.1.0-py3-none-macosx_11_0_arm64.whl (4.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

Details for the file code_ranker-1.1.0.tar.gz.

File metadata

  • Download URL: code_ranker-1.1.0.tar.gz
  • Upload date:
  • Size: 873.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for code_ranker-1.1.0.tar.gz
Algorithm Hash digest
SHA256 78ca9a21e686cd5a3362b586d84b12085d59a99c5441f4f6dd095a4783843e3e
MD5 cad810a61dcde401f6e5ba269fbf7d77
BLAKE2b-256 945227ed642ea7a6dfdec351612196d72e2c534f01a31a945004e49f2e96f32c

See more details on using hashes here.

File details

Details for the file code_ranker-1.1.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: code_ranker-1.1.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 5.1 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for code_ranker-1.1.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 817cab0398a2dd09760fda2403d2209582687d66ceec5e811ff2598a316da3fc
MD5 460cd67b8907a97c078718ad33acd9d3
BLAKE2b-256 1f2a97d1e789db38e7c46210aff49ab43a4fcf56f6fe7ef408de0101751b2044

See more details on using hashes here.

File details

Details for the file code_ranker-1.1.0-py3-none-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for code_ranker-1.1.0-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a62dc21390e1e65628113103b3c8814376042e40016a26ab70f4c4629ae29d80
MD5 b4e812e9e7c85a9a66a1bb29b131e10c
BLAKE2b-256 2a1dcac649b333ebf30a392a08dcb6b03e7ecd51b9717e35d5c3e61b779301c5

See more details on using hashes here.

File details

Details for the file code_ranker-1.1.0-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for code_ranker-1.1.0-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 92cb74944bb0051fbbc2b86124cafe159b2953d0705e4b64edd90ee9d57d291e
MD5 169ee4a820cfcba05d9ec1df7acdda0a
BLAKE2b-256 e043eb6aaf859bdeb72a6e4cb6c28bfaa49d66870031d4f25975c867d04b2df9

See more details on using hashes here.

File details

Details for the file code_ranker-1.1.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for code_ranker-1.1.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 de61e89500d8d426d8f7130ebdf81f1dfd09afc8b8ab9107792f4a50714038e3
MD5 feda3bd298443b4dfb69f19159e759cb
BLAKE2b-256 72033eb8fe6d272375fa16e9c429d5c8919f02e8bcec783879474d1087fd3db2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page