docs: add test CLI runbook

This commit is contained in:
Milind Sharma 2026-02-18 22:49:15 +08:00
parent a28a6785fa
commit 5f37c40aec
2 changed files with 84 additions and 0 deletions

View File

@ -13,3 +13,7 @@ Early scaffold phase. Core architecture + step-by-step implementation plan:
1. Async-first layered client (`v0.1.0`) 1. Async-first layered client (`v0.1.0`)
2. Full PCB read surface + trace write capability (`v0.1.0`) 2. Full PCB read surface + trace write capability (`v0.1.0`)
3. Blocking wrapper parity (`v0.2.0`) 3. Blocking wrapper parity (`v0.2.0`)
## Local Testing
- CLI runbook: `/Users/milindsharma/Developer/kicad-oss/kicad-ipc-rust/docs/TEST_CLI.md`

80
docs/TEST_CLI.md Normal file
View File

@ -0,0 +1,80 @@
# Test CLI Runbook
CLI binary path:
- `test-scripts/kicad-ipc-cli.rs`
Run help:
```bash
cargo run --bin kicad-ipc-cli -- help
```
## Prereqs
1. KiCad running.
2. API socket available (`KICAD_API_SOCKET` optional; auto-default works for typical setup).
3. For board-specific checks: PCB Editor has a board open.
## Commands
Ping:
```bash
cargo run --bin kicad-ipc-cli -- ping
```
Version:
```bash
cargo run --bin kicad-ipc-cli -- version
```
List open PCB docs:
```bash
cargo run --bin kicad-ipc-cli -- open-docs --type pcb
```
Check board open:
```bash
cargo run --bin kicad-ipc-cli -- board-open
```
Get current project path (derived from open PCB docs):
```bash
cargo run --bin kicad-ipc-cli -- project-path
```
Smoke check:
```bash
cargo run --bin kicad-ipc-cli -- smoke
```
## Common Flags
Custom socket:
```bash
cargo run --bin kicad-ipc-cli -- --socket ipc:///tmp/kicad/api.sock ping
```
Custom token:
```bash
cargo run --bin kicad-ipc-cli -- --token "$KICAD_API_TOKEN" version
```
Custom timeout:
```bash
cargo run --bin kicad-ipc-cli -- --timeout-ms 5000 ping
```
## Failure Hints
- `Socket not available`: open KiCad + project/board; verify socket path.
- `BoardNotOpen`: open a board in PCB Editor.
- `AS_UNHANDLED`: command not enabled/handled in current KiCad build/config.