The Breadkit circuit checker

Check wiring before you build.

Analyze breadboard holes and component connections to find placement errors, shorts, floating pins, and mismatches with your design intent.

See a finding Browse rules

Install from RubyGems

gem install breadkit-lint
bklint circuit.bk.rb

This site documents the main branch. Published gems may lag behind it; check the setup guide for source checkout instructions.

Example: a short circuit

board :half
supply :USB, voltage: 5.0,
       plus: "B+1", minus: "B-1"
wire "a10", "B+"
wire "b10", "B-"

Excerpt from the bklint report

E: [Electrical/ShortCircuit]
USB.- (0.0 V) and USB.+ (5.0 V)
conflict on USB+ (path: B-1 → … → B+1)

a10 and b10 share a conductive strip, so the positive and negative rails are shorted.

What it checks

Placement

Invalid holes, part collisions, leads placed on the same strip, and ICs that miss the center gap.

Electrical connections

Shorts, unconnected pins, split rails, supply voltages, and LED series resistors.

Design intent

Differences between expect declarations and the resolved nets.

Use it locally or in CI

Choose text, JSON, GitHub annotations, or SARIF output. Set the severity that fails the run with --fail-level.

bklint circuit.bk.rb --format github
bklint circuit.bk.rb --format sarif --out lint.sarif
bklint circuit.bk.rb --only Electrical/ShortCircuit

Lint JSON schema

Review findings on the diagram

Pass JSON results to breadkit-render to mark the reported holes and wires on the diagram.

bklint circuit.bk.rb --format json --out lint.json
bkrender circuit.bk.rb --annotations lint.json \
  -o review.svg

Explore breadkit-render

Ruby DSL files and configuration require statements run as Ruby. Only process inputs you trust. YAML, TOML, and IR JSON are data-only circuit formats.

Learn to write a circuit