burr 0.23.0

Design-rule checks for CAD-as-code workflows.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# CLI Reference

Burr ships as a Rust CLI named `burr`.

Install:

```bash
cargo install burr --version 0.23.0
```

## Commands

```txt
burr --version
burr init <folder>
burr check [--rulepack <file>] [--no-write-receipt] <folder|burr-design-data.json>...
burr explain [--json] <folder|burr-receipt.json|repair-report.json>...
burr stamp <folder|burr-design-data.json>...
```

## `burr init`

Creates a minimal `build123d` starter project:

```bash
burr init my-part
cd my-part
uv sync
uv run python design.py
burr check .
```

## `burr check`

Runs the linter:

```txt
find burr-design-data.json
  -> verify supported schema versions
  -> verify source and artifact hashes
  -> load selected rulepack
  -> check declared features
  -> write burr-receipt.json
```

Use `--no-write-receipt` when a caller only wants terminal output. Use
`--rulepack <file>` to override the rulepack declared by design data.

## `burr explain`

Expands failed checks into fix guidance:

```bash
burr explain .
burr explain --json .
```

Human output is for review. JSON output is for agent repair loops.

## `burr stamp`

Updates declared source and artifact hashes in `burr-design-data.json`.