-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCOMMAND_SUMMARY.html
More file actions
1723 lines (1649 loc) · 80.2 KB
/
COMMAND_SUMMARY.html
File metadata and controls
1723 lines (1649 loc) · 80.2 KB
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
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" data-theme="dark">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vangard Command Reference</title>
<style>
/* ── Reset & base ─────────────────────────────────────────────── */
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
/* ── Dark theme (default) ─────────────────────────────────────── */
:root, html[data-theme="dark"] {
--bg: #0f1117;
--surface: #1a1d27;
--surface2: #222534;
--surface3: #2b2f42;
--border: #2e3348;
--border-light: #3a3f5c;
--text: #e2e5f0;
--text-muted: #6b7280;
--text-dim: #9ca3af;
--accent: #6366f1;
--accent-glow: #6366f133;
--radius: 8px;
--radius-sm: 4px;
--font-mono: "JetBrains Mono", "Fira Code", "Cascadia Code", ui-monospace, monospace;
--font-sans: "Inter", system-ui, -apple-system, sans-serif;
--badge-opt-bg: #1e293b;
--badge-opt-color: #64748b;
--badge-opt-border:#334155;
--toggle-bg: #2b2f42;
--toggle-color: #9ca3af;
--toggle-border:#3a3f5c;
--toggle-hover: #3a3f5c;
}
/* ── Light theme ──────────────────────────────────────────────── */
html[data-theme="light"] {
--bg: #f5f6fa;
--surface: #ffffff;
--surface2: #eef0f7;
--surface3: #e4e7f2;
--border: #d5d9ec;
--border-light: #c0c6e0;
--text: #1a1d27;
--text-muted: #6b7280;
--text-dim: #4b5563;
--accent: #4f46e5;
--accent-glow: #4f46e514;
--badge-opt-bg: #e2e8f0;
--badge-opt-color: #475569;
--badge-opt-border:#94a3b8;
--toggle-bg: #ffffff;
--toggle-color: #4b5563;
--toggle-border:#d5d9ec;
--toggle-hover: #e4e7f2;
}
body {
font-family: var(--font-sans);
background: var(--bg);
color: var(--text);
font-size: 14px;
line-height: 1.6;
padding: 2rem 1.5rem 4rem;
transition: background .2s, color .2s;
}
/* ── Page header ──────────────────────────────────────────────── */
.page-header {
max-width: 1100px;
margin: 0 auto 2.5rem;
padding-bottom: 1.5rem;
border-bottom: 1px solid var(--border);
display: grid;
grid-template-columns: 1fr auto;
align-items: start;
gap: 1rem;
}
.page-header-text h1 {
font-size: 1.75rem;
font-weight: 700;
letter-spacing: -0.02em;
color: var(--text);
}
.page-header-text h1 span {
color: var(--accent);
}
.page-subtitle {
margin-top: .35rem;
color: var(--text-dim);
font-size: .9rem;
}
.page-meta {
margin-top: .75rem;
display: flex;
gap: .75rem;
flex-wrap: wrap;
font-size: .8rem;
color: var(--text-muted);
}
.page-meta span { display: flex; align-items: center; gap: .3rem; }
/* ── Theme toggle button ──────────────────────────────────────── */
#theme-toggle {
margin-top: .25rem;
display: inline-flex;
align-items: center;
gap: .4rem;
padding: .4rem .75rem;
background: var(--toggle-bg);
color: var(--toggle-color);
border: 1px solid var(--toggle-border);
border-radius: 6px;
font-family: var(--font-sans);
font-size: .8rem;
cursor: pointer;
white-space: nowrap;
transition: background .15s, color .15s, border-color .15s;
}
#theme-toggle:hover {
background: var(--toggle-hover);
color: var(--text);
}
#theme-toggle .icon { font-size: 1rem; line-height: 1; }
/* ── Main table ───────────────────────────────────────────────── */
.wrap {
max-width: 1100px;
margin: 0 auto;
overflow-x: auto;
}
table.main-table {
width: 100%;
border-collapse: separate;
border-spacing: 0;
background: var(--surface);
border: 1px solid var(--border);
border-radius: var(--radius);
overflow: hidden;
}
table.main-table thead th {
background: var(--surface3);
padding: .7rem 1rem;
text-align: left;
font-size: .75rem;
font-weight: 600;
text-transform: uppercase;
letter-spacing: .08em;
color: var(--text-dim);
border-bottom: 1px solid var(--border);
}
table.main-table thead th:first-child { width: 190px; }
.cmd-row:not(:last-child) td { border-bottom: 1px solid var(--border); }
.cmd-row:hover td { background: var(--surface2); }
.cmd-row td { padding: 1rem; vertical-align: top; }
/* ── Command name cell ────────────────────────────────────────── */
.cmd-name-cell { width: 190px; }
.cmd-name {
font-family: var(--font-mono);
font-size: .88rem;
font-weight: 600;
color: var(--accent);
background: var(--accent-glow);
padding: .2em .5em;
border-radius: var(--radius-sm);
white-space: nowrap;
}
.cmd-class {
margin-top: .4rem;
font-size: .72rem;
color: var(--text-muted);
font-family: var(--font-mono);
}
/* ── Command description cell ─────────────────────────────────── */
.cmd-desc { color: var(--text); margin-bottom: .6rem; font-size: .88rem; }
/* ── Args details/summary ─────────────────────────────────────── */
.arg-details { margin-top: .4rem; }
.arg-summary {
cursor: pointer;
display: inline-flex;
align-items: center;
gap: .5rem;
font-size: .8rem;
color: var(--text-dim);
user-select: none;
padding: .25rem 0;
list-style: none;
}
.arg-summary::-webkit-details-marker { display: none; }
.arg-summary::before {
content: "▶";
font-size: .65rem;
transition: transform .15s;
color: var(--accent);
}
details[open] .arg-summary::before { transform: rotate(90deg); }
.arg-summary:hover { color: var(--text); }
/* ── Argument inner table ─────────────────────────────────────── */
.arg-table-wrap {
margin-top: .6rem;
overflow-x: auto;
border: 1px solid var(--border-light);
border-radius: var(--radius-sm);
}
table.arg-table {
width: 100%;
border-collapse: collapse;
font-size: .8rem;
}
table.arg-table thead th {
background: var(--surface3);
padding: .45rem .75rem;
text-align: left;
font-size: .7rem;
font-weight: 600;
text-transform: uppercase;
letter-spacing: .07em;
color: var(--text-muted);
border-bottom: 1px solid var(--border);
white-space: nowrap;
}
table.arg-table tbody tr:not(:last-child) td {
border-bottom: 1px solid var(--border);
}
table.arg-table tbody tr:hover td { background: var(--surface3); }
table.arg-table td { padding: .5rem .75rem; vertical-align: top; }
.arg-name-cell { width: 220px; white-space: nowrap; }
.arg-primary {
font-family: var(--font-mono);
font-size: .82rem;
color: var(--text);
}
.alias {
font-family: var(--font-mono);
font-size: .75rem;
color: var(--text-muted);
margin-left: .25rem;
}
.arg-type-cell {
width: 130px;
font-family: var(--font-mono);
font-size: .78rem;
color: var(--text-dim);
white-space: nowrap;
}
.arg-default {
display: block;
font-size: .72rem;
color: var(--text-muted);
margin-top: .2rem;
}
.arg-desc-cell { color: var(--text-dim); font-size: .8rem; }
.arg-ui-cell { width: 260px; }
/* ── Badges ───────────────────────────────────────────────────── */
.badge {
display: inline-block;
font-size: .68rem;
font-weight: 600;
padding: .15em .45em;
border-radius: 3px;
letter-spacing: .04em;
white-space: nowrap;
}
.badge-required {
background: #fef3c7;
color: #92400e;
border: 1px solid #f59e0b44;
}
.badge-optional {
background: var(--badge-opt-bg);
color: var(--badge-opt-color);
border: 1px solid var(--badge-opt-border);
}
/* ── UI hint stack ────────────────────────────────────────────── */
.hint-stack {
display: flex;
flex-direction: column;
gap: .3rem;
}
.hint-detail, .hint-placeholder, .hint-autocomplete {
font-size: .74rem;
color: var(--text-muted);
font-family: var(--font-mono);
}
.hint-placeholder { font-style: italic; font-family: var(--font-sans); color: var(--text-muted); }
.hint-autocomplete { color: #a78bfa; font-family: var(--font-sans); }
/* ── Misc ─────────────────────────────────────────────────────── */
code {
font-family: var(--font-mono);
font-size: .85em;
background: var(--surface3);
padding: .1em .3em;
border-radius: 3px;
color: var(--text);
}
.muted { color: var(--text-muted); font-size: .8rem; }
/* ── Legend ───────────────────────────────────────────────────── */
.legend {
max-width: 1100px;
margin: 1.75rem auto 0;
display: flex;
flex-wrap: wrap;
gap: .6rem 1.25rem;
font-size: .78rem;
color: var(--text-muted);
}
.legend-item { display: flex; align-items: center; gap: .4rem; }
@media (max-width: 700px) {
body { padding: 1rem .75rem 3rem; }
table.main-table thead th:first-child,
.cmd-name-cell { width: 130px; }
}
</style>
</head>
<body>
<header class="page-header">
<div class="page-header-text">
<h1>Vangard <span>Command Reference</span></h1>
<p class="page-subtitle">Auto-generated from <code>config.yaml</code> · All CLI commands, arguments, and UI hints.</p>
<div class="page-meta">
<span>📋 22 commands</span>
<span>🔄 Run <code>npm run generate-docs</code> to regenerate</span>
</div>
</div>
<button id="theme-toggle" onclick="toggleTheme()" title="Toggle light/dark theme">
<span class="icon" id="theme-icon">☀️</span>
<span id="theme-label">Light</span>
</button>
</header>
<div class="wrap">
<table class="main-table">
<thead>
<tr>
<th>Command</th>
<th>Description & Arguments</th>
</tr>
</thead>
<tbody>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">action</code>
<div class="cmd-class">ExecGenericActionSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Execute the specified action with optional settings as a series of key=value pairs separated by commas</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-required">1 required</span><span class="badge badge-optional">1 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">action_class</code>
<span class="badge badge-required">required</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Class name of the action to execute</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., DzIrayRender, DzFileIOAction</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-s</code>
<code class="alias">--settings</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Settings for the action as a series of key=value pairs separated by commas</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>key1=value1,key2=value2</em></span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">apply-pose</code>
<div class="cmd-class">ApplyGenericPoseSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Apply the given named posed as pose file to the currently selected node or specified node</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-required">1 required</span><span class="badge badge-optional">1 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">pose_file</code>
<span class="badge badge-required">required</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Absolute path to the pose file to be applied</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#ede9fe;color:#8b5cf6;border:1px solid #8b5cf633;">file-picker</span><span class="hint-detail">ext: <code>.duf</code> <code>.dsf</code> <code>.pz2</code></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-t</code>
<code class="alias">--target-node</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Label of the node to apply the pose to. If not specified, apply to the currently selected node.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Target node name (optional)</em></span><span class="hint-autocomplete">💬 autocomplete: <code>scene-nodes</code> [<code>figure</code>]</span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">batch-render</code>
<div class="cmd-class">BatchRenderSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Given a pattern of scene files, load each one and render it to the target location (default is studio-iray) with the given output file pattern</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-optional">13 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-s</code>
<code class="alias">--scene-files</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code><span class="arg-default">default: <code>_</code></span></td>
<td class="arg-desc-cell">Pattern of scene files to load, including glob support. See README for examples</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., /path/to/scenes/*.duf</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-o</code>
<code class="alias">--output-path</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Path to directory where output files are to be written. If not specified, use the location of the scene file.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#f5f3ff;color:#7c3aed;border:1px solid #7c3aed33;">folder-picker</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-t</code>
<code class="alias">--target</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code><span class="arg-default">default: <code>direct-file</code></span></td>
<td class="arg-desc-cell">Target of the render. Allowed values are local-to-file, local-to-window, or iray-server-bridge</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#fef3c7;color:#f59e0b;border:1px solid #f59e0b33;">select</span><span class="hint-detail">choices: <code>Direct to File (Local)</code>, <code>Local to File</code>, <code>Local to Window</code>, <code>iRay Server Bridge</code></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-r</code>
<code class="alias">--resolution</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Resolution to render, overriding the resolution of the scene file, in WxH format (e.g. 1920x1080)</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., 1920x1080, 3840x2160</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-c</code>
<code class="alias">--cameras</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Cameras to render for. Can be one of 'all_visible', 'viewport', or a pattern that maps to one or more visible cameras</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., all_visible, viewport, Camera*</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-j</code>
<code class="alias">--job-name-pattern</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Pattern to use for naming job names or render output files. In the pattern, %s refers to the scene name, %c the camera name, %f the frame number, and %r the render count</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., %s_%c_frame%f</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-f</code>
<code class="alias">--frames</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Frames to render. Comma-separated list of frames that can include ranges and range patterns. See README for full detail and example.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., 1,5,10-20</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">--iray-server</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code><span class="arg-default">default: <code>127.0.0.1</code></span></td>
<td class="arg-desc-cell">For target iray-server the IP address or hostname of the iRay server/master to use.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>IP address or hostname</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">--iray-protocol</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code><span class="arg-default">default: <code>http</code></span></td>
<td class="arg-desc-cell">Sets the http protocol to use. Allowed values are http or https.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#fef3c7;color:#f59e0b;border:1px solid #f59e0b33;">select</span><span class="hint-detail">choices: <code>http</code>, <code>https</code></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">--iray-port</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code><span class="arg-default">default: <code>9090</code></span></td>
<td class="arg-desc-cell">For target iray-server the TCP port of the iRay server/master.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Port number</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">--iray-user</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">For target iray-server the username to connect to the iRay server/master. Must be specified here or in config file specified by --iray-config-file</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Username</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">--iray-password</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">For target iray-server the password to connect to the iRay server/master. Must be specified here or in config file specified by --iray-config-file</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Password</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">--iray-config-file</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">For target iray-server the configuration options file to use for iRay server/master configuration. Values in this file can be overridden by additional command line arguments</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#ede9fe;color:#8b5cf6;border:1px solid #8b5cf633;">file-picker</span><span class="hint-detail">ext: <code>.json</code> <code>.yaml</code> <code>.yml</code></span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">copy-camera</code>
<div class="cmd-class">CopyNamedCameraToCurrentCameraSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Copy the specified camera (by label) to the specified target camera, or the current viewport camera if target not specified</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-optional">2 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-s</code>
<code class="alias">--source-camera</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Camera to copy from</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Source camera name</em></span><span class="hint-autocomplete">💬 autocomplete: <code>scene-nodes</code> [<code>camera</code>]</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-t</code>
<code class="alias">--target-camera</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Camera to copy to (optional)</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Target camera name (optional)</em></span><span class="hint-autocomplete">💬 autocomplete: <code>scene-nodes</code> [<code>camera</code>]</span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">create-cam</code>
<div class="cmd-class">CreateBasicCameraSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Create a perspective camera with given name and camera type as parameters to generate the name of the camera along with the selected node label.</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-required">2 required</span><span class="badge badge-optional">1 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">cam_name</code>
<span class="badge badge-required">required</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Name of the camera</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., MainCamera, CloseUp</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">cam_class</code>
<span class="badge badge-required">required</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Class (type) of camera</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#fef3c7;color:#f59e0b;border:1px solid #f59e0b33;">select</span><span class="hint-detail">choices: <code>Perspective Camera</code>, <code>Orthographic Camera</code></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-f</code>
<code class="alias">--focus</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>flag</code><span class="arg-default">default: <code>False</code></span></td>
<td class="arg-desc-cell">If true, turn DOF on the new camera</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#d1fae5;color:#10b981;border:1px solid #10b98133;">checkbox</span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">create-group</code>
<div class="cmd-class">CreateGroupNodeSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Group the selected nodes in the scene to the name specified.</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-required">1 required</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">group_name</code>
<span class="badge badge-required">required</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Name of the new group.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., Furniture, Props, Background</em></span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">drop-object</code>
<div class="cmd-class">DropObjectSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Drop one object on top of another, respecting bounding box boundaries.</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-required">2 required</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">source_node</code>
<span class="badge badge-required">required</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Label of the object to be dropped</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Object to drop</em></span><span class="hint-autocomplete">💬 autocomplete: <code>scene-nodes</code> [<code>prop</code>, <code>figure</code>]</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">target_node</code>
<span class="badge badge-required">required</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Label of the object to be dropped onto</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Target surface/object</em></span><span class="hint-autocomplete">💬 autocomplete: <code>scene-nodes</code> [<code>prop</code>, <code>figure</code>]</span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">face-render-lora</code>
<div class="cmd-class">FaceRenderLoraSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Render a series of orbital camera angles around a figure's face for LoRA training image generation</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-optional">8 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-o</code>
<code class="alias">--output-dir</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code><span class="arg-default">default: <code>y:/ai/charflow/output/face_lora/</code></span></td>
<td class="arg-desc-cell">Directory to write rendered images to.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#f5f3ff;color:#7c3aed;border:1px solid #7c3aed33;">folder-picker</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-p</code>
<code class="alias">--file-prefix</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code><span class="arg-default">default: <code>face</code></span></td>
<td class="arg-desc-cell">Filename prefix for output images. Angle label and extension are appended.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., face, portrait, headshot</em></span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-W</code>
<code class="alias">--wid</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>int</code><span class="arg-default">default: <code>768</code></span></td>
<td class="arg-desc-cell">Render width in pixels.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#cffafe;color:#06b6d4;border:1px solid #06b6d433;">spinner</span><span class="hint-detail">min 64 · max 4096 · step 64</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-H</code>
<code class="alias">--height</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>int</code><span class="arg-default">default: <code>768</code></span></td>
<td class="arg-desc-cell">Render height in pixels.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#cffafe;color:#06b6d4;border:1px solid #06b6d433;">spinner</span><span class="hint-detail">min 64 · max 4096 · step 64</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-d</code>
<code class="alias">--camera-distance</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>int</code><span class="arg-default">default: <code>80</code></span></td>
<td class="arg-desc-cell">Camera distance from the face center in DAZ scene units (cm).</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#fee2e2;color:#ef4444;border:1px solid #ef444433;">slider</span><span class="hint-detail">min 30 · max 200 · step 5</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-y</code>
<code class="alias">--face-y-offset</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>int</code><span class="arg-default">default: <code>5</code></span></td>
<td class="arg-desc-cell">Vertical offset from the head bone origin toward eye/nose level.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#fee2e2;color:#ef4444;border:1px solid #ef444433;">slider</span><span class="hint-detail">min -20 · max 20 · step 1</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-n</code>
<code class="alias">--node-label</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str</code></td>
<td class="arg-desc-cell">Label of the figure node to target. If not specified, the first skeleton in the scene is used.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>Figure node name (optional)</em></span><span class="hint-autocomplete">💬 autocomplete: <code>scene-nodes</code> [<code>figure</code>]</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-t</code>
<code class="alias">--test-mode</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>flag</code><span class="arg-default">default: <code>False</code></span></td>
<td class="arg-desc-cell">If set, show a message box at each angle instead of rendering.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#d1fae5;color:#10b981;border:1px solid #10b98133;">checkbox</span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">help</code>
<div class="cmd-class">HelpCommand</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Displays help information for commands.</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-optional">1 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">command_name</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>str <code>nargs=?</code></code></td>
<td class="arg-desc-cell">The specific command to get help for.</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#dbeafe;color:#3b82f6;border:1px solid #3b82f633;">text</span><span class="hint-placeholder">e.g. <em>e.g., load-scene, batch-render</em></span></div></td>
</tr>
</tbody>
</table>
</div>
</details>
</td>
</tr>
<tr class="cmd-row">
<td class="cmd-name-cell">
<code class="cmd-name">inc-scene</code>
<div class="cmd-class">SceneRollerSU</div>
</td>
<td class="cmd-desc-cell">
<p class="cmd-desc">Save the current scene file incrementing the file name with a numerical, incrementing, suffix.</p>
<details class="arg-details">
<summary class="arg-summary">
Arguments <span class="badge badge-optional">2 optional</span>
</summary>
<div class="arg-table-wrap">
<table class="arg-table">
<thead>
<tr>
<th>Name / Flags</th>
<th>Type</th>
<th>Description</th>
<th>UI Hint</th>
</tr>
</thead>
<tbody>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-n</code>
<code class="alias">--number</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>int</code></td>
<td class="arg-desc-cell">If specified, replace the numeric suffix at the end of the scene file name with the given number (or add it if one doesn't exist).</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#cffafe;color:#06b6d4;border:1px solid #06b6d433;">spinner</span><span class="hint-detail">min 0 · max 9999 · step 1</span></div></td>
</tr>
<tr>
<td class="arg-name-cell">
<code class="arg-primary">-i</code>
<code class="alias">--increment</code>
<span class="badge badge-optional">optional</span>
</td>
<td class="arg-type-cell"><code>int</code><span class="arg-default">default: <code>1</code></span></td>
<td class="arg-desc-cell">If specified, increment the scene file suffix by the given amount (default = 1).</td>
<td class="arg-ui-cell"><div class="hint-stack"><span class="badge" style="background:#cffafe;color:#06b6d4;border:1px solid #06b6d433;">spinner</span><span class="hint-detail">min 1 · max 100 · step 1</span></div></td>
</tr>
</tbody>
</table>
</div>
</details>