Clarify Pheon installation and first-use examples

This commit is contained in:
Jan Petykiewicz 2026-11-17 15:07:40 -08:00
commit 4ea14085f7

View file

@ -1,11 +1,14 @@
# Command-line tools
Use `pheon` to inspect a GDSII file, compare revisions, or trace cell references.
The CLI runs independently of Python.
Use uncompressed `.gds` files with the CLI. It runs independently of Python.
## Install
From a source checkout, with Rust 1.88 or newer:
If you downloaded a CLI archive, extract it and add the directory containing
`pheon` (`pheon.exe` on Windows) to your `PATH`. Run `pheon --help` to check it.
To install from a source checkout, use Rust 1.88 or newer:
```sh
cargo install --path . --locked --bin pheon
@ -37,9 +40,10 @@ pheon diff before.gds after.gds --hierarchy ascii --max-changes 20
pheon diff before.gds after.gds --format json > report.json
```
Reports identify changed objects and their fields, plus affected ancestors in
the hierarchy. Objects that can be paired unambiguously receive a replacement
explanation; ambiguous changes remain removals and additions.
Text reports group changes by cell. A `-` line shows an object from the old file
and a `+` line shows one from the new file. A `~` line explains a likely
replacement when Pheon can pair the two uniquely. Request a hierarchy view to
see which parent cells are affected.
| Exit code | Meaning |
| --- | --- |