Repository navigation
Running the CLI
git clone https://github.com/JoeyHammoth/bendEDA
cd bendEDA
python -m venv .venv
. .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e ".[dev]"Python 3.12+. No network is needed after install; no EDA toolchain is required for the commands that currently work.
bendeda --version # bendeda 0.0.1
bendeda validate --all # schemas + task packages
python -m unittest discover -s tests -v| Code | Meaning |
|---|---|
0 |
the command did what it says |
1 |
a check ran and failed |
2 |
usage error |
3 |
not implemented — the command printed its plan and refused to pretend |
Exit 3 is load-bearing. In a study about false assurance, a stub that exits 0 would let a person or an agent believe a gate ran when nothing ran. If a script needs to distinguish states, test for 0 explicitly rather than treating "no exception" as success.
bendeda init --dry-run
bendeda task new B1_fifo --tier B --dry-run
bendeda validate --all
bendeda --help
# L1 vector path (needs bun + the pinned compiler source)
python tools/fetch_bend.py
export BENDEDA_BEND_CLI=.bend-cache/bend-2.0.40/bend2/main.ts
bendeda conformance compile --model experiments/fixtures/toy_counter/model.bend --out .bend-cache/out/model.mjs
bendeda conformance trace --module .bend-cache/out/model.mjs --cycles 24
bendeda conformance trace --module .bend-cache/out/model.mjs --cycles 24 --inject-offset 1The last command is a self-test of the comparator: it shifts the DUT by one cycle and the gate passes only if the offset is detected. A trace checker that cannot see a one-cycle shift is measuring nothing.
To judge real RTL rather than the Python reference, run the DUT under Verilator in
the pinned image (needs Docker; the image is bendeda/oss-cad:2026-11-20):
# the testbench is generated from dut.json — a port manifest, not hand-written code
bendeda conformance trace --module .bend-cache/out/model.mjs --cycles 24 \
--dut verilator --rtl experiments/fixtures/toy_counter/dut.sv \
--spec experiments/fixtures/toy_counter/dut.json
# the negative control: wrapping RTL must fail as a value mismatch
bendeda conformance trace --module .bend-cache/out/model.mjs --cycles 24 \
--dut verilator --rtl experiments/fixtures/toy_counter/dut_wrap.sv; echo "exit=$?"A plan can drive each input separately. incs stays the model's stimulus; the
stimulus object maps an input name to its own sequence:
{
"incs": [1, 2, 3],
"stimulus": { "inc": [1, 2, 3], "en": [1, 1, 0] }
}bendeda conformance trace --module .bend-cache/out/model.mjs \
--dut verilator --rtl experiments/fixtures/toy_counter/dut.sv \
--spec experiments/fixtures/toy_counter/dut.json \
--plan path/to/plan.json| Command | Issue |
|---|---|
law lint, law mutate
|
#10 |
canary |
#9 |
oracle seal, oracle verify-commitment
|
#13 |
tf run |
blocked by BendBV (#8) |
conformance (L2/L3 rungs) |
arrives with the EDA image (#6) |
gate run, gate calibrate, run, replay
|
#15 |
report, bundle verify, serve
|
Phase 6 / Phase 2 |
-
ModuleNotFoundError: bendeda— the package is not installed; runpip install -e .from the repository root. -
Windows line endings — the repository normalises to LF via
.gitattributes. Iftools/check_whitespace.pycomplains after an editor round-trip, your editor wrote CRLF. - A gate says "skipped" — a required image or capability is absent. Skipped is not a pass; CI treats it as such and prints the reason.
- Tests pass but a command exits 3 — intended, see the table above.
- Site: https://joeyhammoth.github.io/bendEDA/
- This wiki for the plan and decisions
- Design document for anything normative
Code Apache-2.0 · documents and task data CC BY 4.0 · this wiki records decisions, not the current state of the code — the design document and the repository are normative.