altium-cli 0.1.7

CLI tool for inspecting and manipulating Altium Designer files
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
//! PCB footprint library (PcbLib) commands.
//!
//! High-level operations for exploring and managing Altium PCB footprint libraries.

use clap::Subcommand;
use serde::Serialize;
use std::path::PathBuf;

use crate::output::{self, TextFormat};
use altium_format::ops::pcblib;

#[derive(Subcommand)]
pub enum PcbLibCommands {
    /// Complete library overview with footprint categories and statistics
    Overview {
        /// Path to PcbLib file
        path: PathBuf,
    },

    /// List all footprints in the library
    List {
        /// Path to PcbLib file
        path: PathBuf,
    },

    /// Search for footprints by name or description
    Search {
        /// Path to PcbLib file
        path: PathBuf,

        /// Search query
        query: String,

        /// Maximum results to return
        #[arg(short, long)]
        limit: Option<usize>,
    },

    /// Library info and statistics
    Info {
        /// Path to PcbLib file
        path: PathBuf,
    },

    /// Show detailed footprint information
    Footprint {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name or index
        name: String,

        /// Show primitive details
        #[arg(long)]
        primitives: bool,
    },

    /// List pads (all or for specific footprint)
    Pads {
        /// Path to PcbLib file
        path: PathBuf,

        /// Filter by footprint name
        #[arg(short, long)]
        footprint: Option<String>,
    },

    /// List primitives for a footprint
    Primitives {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        footprint: String,
    },

    /// Analyze hole sizes across the library
    Holes {
        /// Path to PcbLib file
        path: PathBuf,
    },

    /// Measure footprint dimensions and clearances
    Measure {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        footprint: String,
    },

    /// Export as JSON for LLM processing
    Json {
        /// Path to PcbLib file
        path: PathBuf,

        /// Include full pad details
        #[arg(long)]
        full: bool,
    },

    /// Render footprint as ASCII art
    RenderAscii {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        footprint: String,
    },

    /// Create new empty library
    Create {
        /// Path to new PcbLib file
        path: PathBuf,
    },

    /// Add footprint pattern to library
    AddFootprint {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        name: String,

        /// Footprint description
        #[arg(short, long)]
        description: Option<String>,
    },

    /// Add pad to footprint
    AddPad {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        #[arg(short, long)]
        footprint: String,

        /// Pad designator
        #[arg(short, long)]
        designator: String,

        /// X position in mm
        #[arg(short, long)]
        x: f64,

        /// Y position in mm
        #[arg(short, long)]
        y: f64,

        /// Pad width in mm
        #[arg(short, long)]
        width: f64,

        /// Pad height in mm
        #[arg(long)]
        height: f64,

        /// Pad shape (round, rectangular, rounded_rect, octagonal)
        #[arg(short, long, default_value = "rectangular")]
        shape: String,

        /// Hole diameter in mm (0 for SMD)
        #[arg(long, default_value = "0")]
        hole: f64,
    },

    /// Add silkscreen line to footprint
    AddSilkscreen {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        #[arg(short, long)]
        footprint: String,

        /// Start X in mm
        #[arg(long)]
        x1: f64,

        /// Start Y in mm
        #[arg(long)]
        y1: f64,

        /// End X in mm
        #[arg(long)]
        x2: f64,

        /// End Y in mm
        #[arg(long)]
        y2: f64,

        /// Line width in mm
        #[arg(short, long, default_value = "0.15")]
        width: f64,
    },

    /// Add silkscreen arc to footprint
    AddArc {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        #[arg(short, long)]
        footprint: String,

        /// Center X in mm
        #[arg(short, long)]
        x: f64,

        /// Center Y in mm
        #[arg(short, long)]
        y: f64,

        /// Radius in mm
        #[arg(short, long)]
        radius: f64,

        /// Start angle in degrees
        #[arg(long)]
        start_angle: f64,

        /// End angle in degrees
        #[arg(long)]
        end_angle: f64,

        /// Line width in mm
        #[arg(short, long, default_value = "0.15")]
        width: f64,
    },

    /// Generate chip footprint by size
    GenChip {
        /// Path to PcbLib file
        path: PathBuf,

        /// Chip size (0201, 0402, 0603, 0805, 1206)
        size: String,

        /// Pad density (most, nominal, least)
        #[arg(short, long, default_value = "nominal")]
        density: String,
    },

    /// Render footprint as SVG
    RenderSvg {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        footprint: String,

        /// Output file path
        #[arg(short, long)]
        output: Option<PathBuf>,

        /// Scale in pixels per mil
        #[arg(short, long, default_value = "0.5")]
        scale: f64,

        /// Use light theme
        #[arg(long)]
        light: bool,

        /// Hide grid
        #[arg(long)]
        no_grid: bool,

        /// Hide pad designators
        #[arg(long)]
        no_designators: bool,
    },

    /// Render footprint as PNG
    RenderPng {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        footprint: String,

        /// Output file path
        #[arg(short, long)]
        output: Option<PathBuf>,

        /// Scale in pixels per mil
        #[arg(short, long, default_value = "0.5")]
        scale: f64,

        /// Target width in pixels
        #[arg(short, long)]
        width: Option<u32>,
    },

    /// Batch import from JSON
    AddJson {
        /// Path to PcbLib file
        path: PathBuf,

        /// JSON file path (use "-" for stdin)
        #[arg(short, long)]
        file: Option<String>,

        /// JSON string
        #[arg(short, long)]
        json: Option<String>,
    },

    /// Add row of pads to footprint
    AddPadRow {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        #[arg(short, long)]
        footprint: String,

        /// Number of pads
        #[arg(short, long)]
        count: usize,

        /// Pitch with unit (e.g., "2.54mm", "100mil")
        #[arg(short, long)]
        pitch: String,

        /// Pad width with unit
        #[arg(long)]
        pad_width: String,

        /// Pad height with unit
        #[arg(long)]
        pad_height: String,

        /// Direction (horizontal, vertical, h, v, x, y)
        #[arg(short, long, default_value = "horizontal")]
        direction: String,

        /// Starting pad number
        #[arg(short, long, default_value = "1")]
        start: u32,

        /// Row X offset with unit
        #[arg(short, long, default_value = "0mm")]
        x: String,

        /// Row Y offset with unit
        #[arg(short, long, default_value = "0mm")]
        y: String,

        /// Pad shape
        #[arg(long, default_value = "rectangular")]
        shape: String,

        /// Hole diameter with unit (0mm for SMD)
        #[arg(long, default_value = "0mm")]
        hole: String,

        /// Interpret pitch as spacing (pad edge to edge)
        #[arg(long)]
        use_spacing: bool,
    },

    /// Add dual row of pads (SOIC, DIP style)
    AddDualRow {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        #[arg(short, long)]
        footprint: String,

        /// Pads per side
        #[arg(short = 'n', long)]
        pads_per_side: usize,

        /// Pitch with unit
        #[arg(short, long)]
        pitch: String,

        /// Row spacing with unit
        #[arg(short, long)]
        row_spacing: String,

        /// Pad width with unit (for SMD or through-hole)
        #[arg(long)]
        pad_width: Option<String>,

        /// Pad height with unit (for SMD)
        #[arg(long)]
        pad_height: Option<String>,

        /// Pad diameter with unit (for through-hole)
        #[arg(long)]
        pad_diameter: Option<String>,

        /// Hole diameter with unit (makes through-hole)
        #[arg(long)]
        hole: Option<String>,

        /// Pad shape
        #[arg(long, default_value = "rectangular")]
        shape: String,
    },

    /// Add quad pattern pads (QFP style)
    AddQuadPads {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        #[arg(short, long)]
        footprint: String,

        /// Pads per side
        #[arg(short = 'n', long)]
        pads_per_side: usize,

        /// Pitch with unit
        #[arg(short, long)]
        pitch: String,

        /// Span with unit (center to center of opposite rows)
        #[arg(short, long)]
        span: String,

        /// Pad width with unit
        #[arg(long)]
        pad_width: String,

        /// Pad height with unit
        #[arg(long)]
        pad_height: String,

        /// Pad shape
        #[arg(long, default_value = "rectangular")]
        shape: String,
    },

    /// Add grid of pads (BGA style)
    AddPadGrid {
        /// Path to PcbLib file
        path: PathBuf,

        /// Footprint name
        #[arg(short, long)]
        footprint: String,

        /// Number of rows
        #[arg(short, long)]
        rows: usize,

        /// Number of columns
        #[arg(short, long)]
        cols: usize,

        /// Pitch with unit
        #[arg(short, long)]
        pitch: String,

        /// Pad diameter with unit
        #[arg(long)]
        pad_diameter: String,

        /// Pad shape
        #[arg(long, default_value = "round")]
        shape: String,

        /// Skip center region diameter with unit
        #[arg(long, default_value = "0mm")]
        skip_center: String,
    },
}

pub fn run(cmd: &PcbLibCommands, format: &str) -> Result<(), Box<dyn std::error::Error>> {
    match cmd {
        PcbLibCommands::Overview { path } => {
            let result = pcblib::cmd_overview(path)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::List { path } => {
            let result = pcblib::cmd_list(path)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::Search {
            path,
            query,
            limit: _,
        } => {
            let result = pcblib::cmd_search(path, query)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::Info { path } => {
            let result = pcblib::cmd_info(path)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::Footprint {
            path,
            name,
            primitives,
        } => {
            let result = pcblib::cmd_footprint(path, name, *primitives)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::Pads { path, footprint } => {
            let result = pcblib::cmd_pads(path, footprint.clone(), false)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::Primitives { path, footprint } => {
            let result = pcblib::cmd_primitives(path, footprint)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::Holes { path } => {
            let result = pcblib::cmd_holes(path)?;
            output::print(&TextWrapper(result), format)?;
        }
        PcbLibCommands::Measure { path, footprint } => {
            // Use "summary" type for overview measurement
            pcblib::cmd_measure(path, footprint, "summary", None, None, None, format == "json")?;
        }
        PcbLibCommands::Json { path, full } => {
            let result = pcblib::cmd_json(path, *full)?;
            let json_str = serde_json::to_string_pretty(&result)?;
            println!("{}", json_str);
        }
        PcbLibCommands::RenderAscii { path, footprint } => {
            pcblib::cmd_render_ascii(path, footprint, 80, 40)?;
        }
        PcbLibCommands::Create { path } => {
            pcblib::cmd_create(path)?;
        }
        PcbLibCommands::AddFootprint {
            path,
            name,
            description,
        } => {
            pcblib::cmd_add_footprint(path, name, description.clone())?;
        }
        PcbLibCommands::AddPad {
            path,
            footprint,
            designator,
            x,
            y,
            width,
            height,
            shape,
            hole,
        } => {
            pcblib::cmd_add_pad(
                path,
                footprint,
                designator,
                *x,
                *y,
                *width,
                *height,
                shape,
                *hole,
            )?;
        }
        PcbLibCommands::AddSilkscreen {
            path,
            footprint,
            x1,
            y1,
            x2,
            y2,
            width,
        } => {
            pcblib::cmd_add_silkscreen(path, footprint, *x1, *y1, *x2, *y2, *width)?;
        }
        PcbLibCommands::AddArc {
            path,
            footprint,
            x,
            y,
            radius,
            start_angle,
            end_angle,
            width,
        } => {
            pcblib::cmd_add_arc(
                path,
                footprint,
                *x,
                *y,
                *radius,
                *start_angle,
                *end_angle,
                *width,
            )?;
        }
        PcbLibCommands::GenChip {
            path,
            size,
            density,
        } => {
            pcblib::cmd_gen_chip(path, size, density)?;
        }
        PcbLibCommands::RenderSvg {
            path,
            footprint,
            output,
            scale,
            light,
            no_grid,
            no_designators,
        } => {
            pcblib::cmd_render_svg(
                path,
                footprint,
                output.clone(),
                *scale,
                *light,
                *no_grid,
                *no_designators,
            )?;
        }
        PcbLibCommands::RenderPng {
            path,
            footprint,
            output,
            scale,
            width,
        } => {
            pcblib::cmd_render_png(path, footprint, output.clone(), *scale, *width)?;
        }
        PcbLibCommands::AddJson { path, file, json } => {
            pcblib::cmd_add_json(path, file.clone(), json.clone())?;
        }
        PcbLibCommands::AddPadRow {
            path,
            footprint,
            count,
            pitch,
            pad_width,
            pad_height,
            direction,
            start,
            x,
            y,
            shape,
            hole,
            use_spacing,
        } => {
            pcblib::cmd_add_pad_row(
                path,
                footprint,
                *count,
                pitch,
                pad_width,
                pad_height,
                direction,
                *start,
                x,
                y,
                shape,
                hole,
                *use_spacing,
            )?;
        }
        PcbLibCommands::AddDualRow {
            path,
            footprint,
            pads_per_side,
            pitch,
            row_spacing,
            pad_width,
            pad_height,
            pad_diameter,
            hole,
            shape,
        } => {
            pcblib::cmd_add_dual_row(
                path,
                footprint,
                *pads_per_side,
                pitch,
                row_spacing,
                pad_width.as_deref(),
                pad_height.as_deref(),
                pad_diameter.as_deref(),
                hole.as_deref(),
                shape,
            )?;
        }
        PcbLibCommands::AddQuadPads {
            path,
            footprint,
            pads_per_side,
            pitch,
            span,
            pad_width,
            pad_height,
            shape,
        } => {
            pcblib::cmd_add_quad_pads(
                path,
                footprint,
                *pads_per_side,
                pitch,
                span,
                pad_width,
                pad_height,
                shape,
            )?;
        }
        PcbLibCommands::AddPadGrid {
            path,
            footprint,
            rows,
            cols,
            pitch,
            pad_diameter,
            shape,
            skip_center,
        } => {
            pcblib::cmd_add_pad_grid(
                path,
                footprint,
                *rows,
                *cols,
                pitch,
                pad_diameter,
                shape,
                skip_center,
            )?;
        }
    }
    Ok(())
}

// Wrapper to add TextFormat impl for library types
#[derive(Serialize)]
#[serde(transparent)]
struct TextWrapper<T>(T);

impl<T: Serialize> TextFormat for TextWrapper<T> {
    fn format_text(&self) -> String {
        if let Ok(value) = serde_json::to_value(&self.0) {
            format_value(&value, 0)
        } else {
            "Error formatting output".to_string()
        }
    }
}

fn format_value(value: &serde_json::Value, indent: usize) -> String {
    let prefix = "  ".repeat(indent);
    match value {
        serde_json::Value::Object(map) => {
            let mut out = String::new();
            for (key, val) in map {
                match val {
                    serde_json::Value::String(s) => {
                        out.push_str(&format!("{}{}: {}\n", prefix, key, s));
                    }
                    serde_json::Value::Number(n) => {
                        out.push_str(&format!("{}{}: {}\n", prefix, key, n));
                    }
                    serde_json::Value::Bool(b) => {
                        out.push_str(&format!("{}{}: {}\n", prefix, key, b));
                    }
                    serde_json::Value::Null => {
                        out.push_str(&format!("{}{}: null\n", prefix, key));
                    }
                    serde_json::Value::Array(arr) => {
                        if arr.is_empty() {
                            out.push_str(&format!("{}{}: []\n", prefix, key));
                        } else {
                            out.push_str(&format!("{}{}:\n", prefix, key));
                            for item in arr {
                                out.push_str(&format_value(item, indent + 1));
                                out.push('\n');
                            }
                        }
                    }
                    serde_json::Value::Object(_) => {
                        out.push_str(&format!("{}{}:\n", prefix, key));
                        out.push_str(&format_value(val, indent + 1));
                    }
                }
            }
            out
        }
        serde_json::Value::Array(arr) => {
            let mut out = String::new();
            for (i, item) in arr.iter().enumerate() {
                out.push_str(&format!("{}[{}]\n", prefix, i));
                out.push_str(&format_value(item, indent + 1));
            }
            out
        }
        serde_json::Value::String(s) => format!("{}{}\n", prefix, s),
        serde_json::Value::Number(n) => format!("{}{}\n", prefix, n),
        serde_json::Value::Bool(b) => format!("{}{}\n", prefix, b),
        serde_json::Value::Null => format!("{}null\n", prefix),
    }
}