Skip to content

Commit 2d39ceb

Browse files
feat: update version to 2.5.0 and enhance 'cf harden' command options
- Bump version in pyproject.toml to 2.5.0. - Add new options to 'cf harden' command: --list-from-steps, --from, --open-in-openroad, and --open-in-klayout for improved usability. - Update README.md with new command options and examples. - Introduce CategorizedCommand class for better help output organization in CLI.
1 parent ef22247 commit 2d39ceb

4 files changed

Lines changed: 245 additions & 38 deletions

File tree

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -401,13 +401,18 @@ cf harden [MACRO] [OPTIONS]
401401

402402
**Key Options:**
403403
- `--list` or no argument: List all available macros
404+
- `--list-from-steps`: List valid LibreLane step names for `--from` for a specific macro
404405
- `MACRO`: Name of macro to harden (e.g., `user_proj_example`, `user_project_wrapper`)
405406
- `--project-root`: Specify project directory
406-
- `--tag`: Custom run tag (defaults to timestamp)
407+
- `--tag`: Run tag. Without `--from`, existing tag is overwritten; with `--from`, resumes that tag
408+
- `--from`: Start hardening from a specific LibreLane step (e.g., `OpenROAD.DetailedRouting`)
409+
- `--tag` + `--from`: Resume from that step using the existing run state under the specified tag
410+
- `--from` without `--tag`: Resume from that step using the latest existing run tag for the macro
411+
- `--open-in-openroad`: Open an existing run in OpenROAD GUI (uses latest run if `--tag` omitted)
412+
- `--open-in-klayout`: Open an existing run in KLayout GUI (uses latest run if `--tag` omitted)
407413
- `--pdk`: PDK to use (default: sky130A)
408414
- `--use-nix`: Force use of Nix (fails if Nix not available)
409415
- `--use-docker`: Force use of Docker (fails if Docker not available)
410-
- `--dry-run`: Show configuration without running
411416

412417
**Examples:**
413418
```bash
@@ -420,8 +425,22 @@ cf harden user_proj_example
420425
# Harden with custom tag and PDK
421426
cf harden user_proj_example --tag my_run --pdk sky130B
422427
423-
# Preview hardening configuration
424-
cf harden user_proj_example --dry-run
428+
# Resume flow from a specific LibreLane step
429+
cf harden user_proj_example --tag test2 --from OpenROAD.DetailedRouting
430+
431+
# Resume from latest existing run tag automatically
432+
cf harden user_proj_example --from OpenROAD.DetailedRouting
433+
434+
# Show exact valid --from step names for a macro
435+
cf harden user_proj_example --list-from-steps
436+
437+
# Open GUI for a specific run tag
438+
cf harden user_proj_example --tag test2 --open-in-openroad
439+
cf harden user_proj_example --tag test2 --open-in-klayout
440+
441+
# Open GUI for latest existing run tag automatically
442+
cf harden user_proj_example --open-in-openroad
443+
425444
```
426445

427446
**Workflow:**

0 commit comments

Comments
 (0)