project_open
Locates and describes a KiCad project—schematic, board, sheets, text variables, netclasses, format versions, and open-file lock status—from a directory or project file.
Instructions
Locate a KiCad project and describe it: root schematic, board, all sheets, text variables, netclasses, file format versions, and any editor lock files that mean KiCad has a file open.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | A project directory, or any .kicad_pro, .kicad_sch or .kicad_pcb inside it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| board | Yes | ||
| boards | Yes | ||
| warnings | No | ||
| directory | Yes | ||
| lock_files | No | KiCad editor lock files present. A lock means the GUI has the file open. | |
| netclasses | No | ||
| schematics | Yes | ||
| project_file | Yes | ||
| root_schematic | Yes | ||
| text_variables | No | ||
| board_format_version | No | ||
| project_file_version | No | ||
| schematic_format_version | No |