-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcli.js
More file actions
1162 lines (1053 loc) · 37.1 KB
/
cli.js
File metadata and controls
1162 lines (1053 loc) · 37.1 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
#!/usr/bin/env node
import 'dotenv/config';
import { program } from 'commander';
import { apiCommand, validateApiOptions } from './commands/api.js';
import {
baselinesCommand,
validateBaselinesOptions,
} from './commands/baselines.js';
import { buildsCommand, validateBuildsOptions } from './commands/builds.js';
import {
comparisonsCommand,
validateComparisonsOptions,
} from './commands/comparisons.js';
import { configCommand, validateConfigOptions } from './commands/config-cmd.js';
import { doctorCommand, validateDoctorOptions } from './commands/doctor.js';
import {
finalizeCommand,
validateFinalizeOptions,
} from './commands/finalize.js';
import { init } from './commands/init.js';
import { loginCommand, validateLoginOptions } from './commands/login.js';
import { logoutCommand, validateLogoutOptions } from './commands/logout.js';
import { orgsCommand, validateOrgsOptions } from './commands/orgs.js';
import { previewCommand, validatePreviewOptions } from './commands/preview.js';
import {
projectsCommand,
validateProjectsOptions,
} from './commands/projects.js';
import {
approveCommand,
commentCommand,
rejectCommand,
validateApproveOptions,
validateCommentOptions,
validateRejectOptions,
} from './commands/review.js';
import { runCommand, validateRunOptions } from './commands/run.js';
import { statusCommand, validateStatusOptions } from './commands/status.js';
import { tddCommand, validateTddOptions } from './commands/tdd.js';
import {
runDaemonChild,
tddListCommand,
tddStartCommand,
tddStatusCommand,
tddStopCommand,
} from './commands/tdd-daemon.js';
import { uploadCommand, validateUploadOptions } from './commands/upload.js';
import { validateWhoamiOptions, whoamiCommand } from './commands/whoami.js';
import { createPluginServices } from './plugin-api.js';
import { loadPlugins } from './plugin-loader.js';
import { createServices } from './services/index.js';
import {
generateStaticReport,
getReportFileUrl,
} from './services/static-report-generator.js';
import { openBrowser } from './utils/browser.js';
import { colors } from './utils/colors.js';
import { loadConfig } from './utils/config-loader.js';
import { getContext } from './utils/context.js';
import { saveUserPath } from './utils/global-config.js';
import * as output from './utils/output.js';
import { getPackageVersion } from './utils/package-info.js';
// Custom help formatting with Observatory design system
const formatHelp = (cmd, helper) => {
let c = colors;
let lines = [];
let isRootCommand = !cmd.parent;
let version = getPackageVersion();
// Branded header with grizzly bear
lines.push('');
if (isRootCommand) {
// Cute grizzly bear mascot with square eyes (like the Vizzly logo!)
lines.push(c.brand.amber(' ʕ□ᴥ□ʔ'));
lines.push(` ${c.brand.amber(c.bold('vizzly'))} ${c.dim(`v${version}`)}`);
lines.push(` ${c.gray('Visual regression testing for UI teams')}`);
} else {
// Compact header for subcommands
lines.push(` ${c.brand.amber(c.bold('vizzly'))} ${c.white(cmd.name())}`);
let desc = cmd.description();
if (desc) {
lines.push(` ${c.gray(desc)}`);
}
}
lines.push('');
// Usage
let usage = helper.commandUsage(cmd).replace('Usage: ', '');
lines.push(` ${c.dim('Usage')} ${c.white(usage)}`);
lines.push('');
// Get all subcommands
let commands = helper.visibleCommands(cmd);
if (commands.length > 0) {
if (isRootCommand) {
// Group commands by category for root help with icons
let categories = [
{
key: 'core',
icon: '▸',
title: 'Core',
names: [
'run',
'tdd',
'upload',
'status',
'finalize',
'preview',
'builds',
'comparisons',
],
},
{
key: 'review',
icon: '▸',
title: 'Review',
names: ['approve', 'reject', 'comment'],
},
{
key: 'setup',
icon: '▸',
title: 'Setup',
names: ['init', 'doctor', 'config', 'baselines'],
},
{ key: 'advanced', icon: '▸', title: 'Advanced', names: ['api'] },
{
key: 'auth',
icon: '▸',
title: 'Account',
names: ['login', 'logout', 'whoami', 'orgs', 'projects'],
},
];
let grouped = {
core: [],
review: [],
setup: [],
advanced: [],
auth: [],
other: [],
};
for (let command of commands) {
let name = command.name();
if (name === 'help') continue;
let found = false;
for (let cat of categories) {
if (cat.names.includes(name)) {
grouped[cat.key].push(command);
found = true;
break;
}
}
if (!found) grouped.other.push(command);
}
for (let cat of categories) {
let cmds = grouped[cat.key];
if (cmds.length === 0) continue;
lines.push(` ${c.brand.amber(cat.icon)} ${c.bold(cat.title)}`);
for (let command of cmds) {
let name = command.name();
let desc = command.description() || '';
// Truncate long descriptions
if (desc.length > 48) desc = `${desc.substring(0, 45)}...`;
lines.push(` ${c.white(name.padEnd(18))} ${c.gray(desc)}`);
}
lines.push('');
}
// Plugins (other commands from plugins)
if (grouped.other.length > 0) {
lines.push(` ${c.brand.amber('▸')} ${c.bold('Plugins')}`);
for (let command of grouped.other) {
let name = command.name();
let desc = command.description() || '';
if (desc.length > 48) desc = `${desc.substring(0, 45)}...`;
lines.push(` ${c.white(name.padEnd(18))} ${c.gray(desc)}`);
}
lines.push('');
}
} else {
// For subcommands, simple list
lines.push(` ${c.brand.amber('▸')} ${c.bold('Commands')}`);
for (let command of commands) {
let name = command.name();
if (name === 'help') continue;
let desc = command.description() || '';
if (desc.length > 48) desc = `${desc.substring(0, 45)}...`;
lines.push(` ${c.white(name.padEnd(18))} ${c.gray(desc)}`);
}
lines.push('');
}
}
// Options - use dimmer styling for less visual weight
let options = helper.visibleOptions(cmd);
if (options.length > 0) {
lines.push(` ${c.brand.amber('▸')} ${c.bold('Options')}`);
for (let option of options) {
let flags = option.flags;
let desc = option.description || '';
if (desc.length > 40) desc = `${desc.substring(0, 37)}...`;
lines.push(` ${c.cyan(flags.padEnd(22))} ${c.dim(desc)}`);
}
lines.push('');
}
// Quick start examples (only for root command)
if (isRootCommand) {
lines.push(` ${c.brand.amber('▸')} ${c.bold('Quick Start')}`);
lines.push('');
lines.push(` ${c.dim('# Local visual testing')}`);
lines.push(` ${c.gray('$')} ${c.white('vizzly tdd start')}`);
lines.push('');
lines.push(` ${c.dim('# CI pipeline')}`);
lines.push(
` ${c.gray('$')} ${c.white('vizzly run "npm test" --wait')}`
);
lines.push('');
}
// Dynamic context section (only for root)
if (isRootCommand) {
let contextItems = getContext();
if (contextItems.length > 0) {
lines.push(` ${c.dim('─'.repeat(52))}`);
for (let item of contextItems) {
if (item.type === 'success') {
lines.push(
` ${c.green('✓')} ${c.gray(item.label)} ${c.white(item.value)}`
);
} else if (item.type === 'warning') {
lines.push(
` ${c.yellow('!')} ${c.gray(item.label)} ${c.yellow(item.value)}`
);
} else {
lines.push(
` ${c.dim('○')} ${c.gray(item.label)} ${c.dim(item.value)}`
);
}
}
lines.push('');
}
}
// Footer with links
lines.push(` ${c.dim('─'.repeat(52))}`);
lines.push(
` ${c.dim('Docs')} ${c.cyan(c.underline('docs.vizzly.dev'))} ${c.dim('GitHub')} ${c.cyan(c.underline('github.com/vizzly-testing/cli'))}`
);
lines.push('');
return lines.join('\n');
};
program
.name('vizzly')
.description('Vizzly CLI for visual regression testing')
.version(getPackageVersion())
.option('-c, --config <path>', 'Config file path')
.option('--api-url <url>', 'API URL override')
.option('--token <token>', 'Vizzly API token')
.option('-v, --verbose', 'Verbose output (shorthand for --log-level debug)')
.option(
'--log-level <level>',
'Log level: debug, info, warn, error (default: info, or VIZZLY_LOG_LEVEL env var)'
)
.option(
'--json [fields]',
'JSON output, optionally specify fields (e.g., --json id,status,branch)'
)
.option('--color', 'Force colored output (even in non-TTY)')
.option('--no-color', 'Disable colored output')
.option(
'--strict',
'Fail on any error (default: be resilient, warn on non-critical issues)'
)
.configureHelp({ formatHelp });
// Load plugins before defining commands
// We need to manually parse to get the config option early
let configPath = null;
let verboseMode = false;
let logLevelArg = null;
let jsonArg = null;
for (let i = 0; i < process.argv.length; i++) {
if (
(process.argv[i] === '-c' || process.argv[i] === '--config') &&
process.argv[i + 1]
) {
configPath = process.argv[i + 1];
}
if (process.argv[i] === '-v' || process.argv[i] === '--verbose') {
verboseMode = true;
}
if (process.argv[i] === '--log-level' && process.argv[i + 1]) {
logLevelArg = process.argv[i + 1];
}
// Handle --json with optional field selection
// --json (no value) = true, --json=fields or --json fields = "fields"
if (process.argv[i] === '--json') {
let nextArg = process.argv[i + 1];
// If next arg exists and doesn't start with -, it's the fields value
if (nextArg && !nextArg.startsWith('-')) {
jsonArg = nextArg;
} else {
jsonArg = true;
}
} else if (process.argv[i].startsWith('--json=')) {
jsonArg = process.argv[i].substring('--json='.length);
}
}
// Configure output early
// Priority: --log-level > --verbose > VIZZLY_LOG_LEVEL env var > default ('info')
// Color priority: --no-color (off) > --color (on) > auto-detect
let colorOverride;
if (process.argv.includes('--no-color')) {
colorOverride = false;
} else if (process.argv.includes('--color')) {
colorOverride = true;
}
output.configure({
logLevel: logLevelArg,
verbose: verboseMode,
color: colorOverride,
json: jsonArg,
});
const config = await loadConfig(configPath, {});
const services = createServices(config);
const pluginServices = createPluginServices(services);
let plugins = [];
try {
plugins = await loadPlugins(configPath, config);
for (const plugin of plugins) {
try {
// Add timeout protection for plugin registration (5 seconds)
const registerPromise = plugin.register(program, {
config,
services: pluginServices,
output,
// Backwards compatibility alias for plugins using old API
logger: output,
});
const timeoutPromise = new Promise((_, reject) =>
setTimeout(
() => reject(new Error('Plugin registration timeout (5s)')),
5000
)
);
await Promise.race([registerPromise, timeoutPromise]);
output.debug(`Registered plugin: ${plugin.name}`);
} catch (error) {
output.warn(`Failed to register plugin ${plugin.name}: ${error.message}`);
}
}
} catch (error) {
output.debug(`Plugin loading failed: ${error.message}`);
}
program
.command('init')
.description('Initialize Vizzly in your project')
.option('--force', 'Overwrite existing configuration')
.action(async options => {
const globalOptions = program.opts();
await init({ ...globalOptions, ...options, plugins });
});
program
.command('upload')
.description('Upload screenshots to Vizzly')
.argument('<path>', 'Path to screenshots directory or file')
.option('-b, --build-name <name>', 'Build name for grouping')
.option('-m, --metadata <json>', 'Additional metadata as JSON')
.option('--batch-size <n>', 'Upload batch size', v => parseInt(v, 10))
.option('--upload-timeout <ms>', 'Upload timeout in milliseconds', v =>
parseInt(v, 10)
)
.option('--branch <branch>', 'Git branch')
.option('--commit <sha>', 'Git commit SHA')
.option('--message <msg>', 'Commit message')
.option('--environment <env>', 'Environment name', 'test')
.option('--org <slug>', 'Target organization slug')
.option('--project <slug>', 'Target project slug')
.option('--project-id <id>', 'Target project ID')
.option('--threshold <number>', 'Comparison threshold', parseFloat)
.option('--token <token>', 'API token override')
.option('--wait', 'Wait for build completion')
.option('--upload-all', 'Upload all screenshots without SHA deduplication')
.option('--parallel-id <id>', 'Unique identifier for parallel test execution')
.action(async (path, options) => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateUploadOptions(path, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await uploadCommand(path, options, globalOptions);
});
// TDD command with subcommands - Local visual testing with interactive dashboard
const tddCmd = program
.command('tdd')
.description('Run tests in TDD mode with local visual comparisons');
// TDD Start - Background server
tddCmd
.command('start')
.description('Start background TDD server with dashboard')
.option('--port <port>', 'Port for TDD server', '47392')
.option('--open', 'Open dashboard in browser')
.option('--baseline-build <id>', 'Use specific build as baseline')
.option('--baseline-comparison <id>', 'Use specific comparison as baseline')
.option('--environment <env>', 'Environment name', 'test')
.option('--threshold <number>', 'Comparison threshold', parseFloat)
.option('--timeout <ms>', 'Server timeout in milliseconds', '30000')
.option('--fail-on-diff', 'Fail tests when visual differences are detected')
.option('--token <token>', 'API token override')
.option('--daemon-child', 'Internal: run as daemon child process')
.action(async options => {
const globalOptions = program.opts();
// If this is a daemon child process, run the server directly
if (options.daemonChild) {
await runDaemonChild(options, globalOptions);
return;
}
await tddStartCommand(options, globalOptions);
});
// TDD Stop - Kill background server
tddCmd
.command('stop')
.description('Stop background TDD server')
.action(async options => {
const globalOptions = program.opts();
await tddStopCommand(options, globalOptions);
});
// TDD Status - Check server status
tddCmd
.command('status')
.description('Check TDD server status')
.action(async options => {
const globalOptions = program.opts();
await tddStatusCommand(options, globalOptions);
});
// TDD List - List all running servers (for menubar app integration)
tddCmd
.command('list')
.description('List all running TDD servers')
.action(async options => {
const globalOptions = program.opts();
await tddListCommand(options, globalOptions);
});
// TDD Run - One-off test run with ephemeral server (generates static report)
tddCmd
.command('run <command>')
.description('Run tests once in TDD mode with local visual comparisons')
.option('--port <port>', 'Port for TDD server', '47392')
.option('--branch <branch>', 'Git branch override')
.option('--environment <env>', 'Environment name', 'test')
.option('--threshold <number>', 'Comparison threshold', parseFloat)
.option('--token <token>', 'API token override')
.option('--timeout <ms>', 'Server timeout in milliseconds', '30000')
.option('--baseline-build <id>', 'Use specific build as baseline')
.option('--baseline-comparison <id>', 'Use specific comparison as baseline')
.option(
'--set-baseline',
'Accept current screenshots as new baseline (overwrites existing)'
)
.option('--fail-on-diff', 'Fail tests when visual differences are detected')
.option('--no-open', 'Skip opening report in browser')
.action(async (command, options) => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateTddOptions(command, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
const { result, cleanup } = await tddCommand(
command,
options,
globalOptions
);
// Track cleanup state to prevent double cleanup
let isCleaningUp = false;
const handleCleanup = async () => {
if (isCleaningUp) return;
isCleaningUp = true;
await cleanup();
};
// Set up cleanup on process signals
const sigintHandler = () => {
handleCleanup().then(() => process.exit(result?.exitCode || 0));
};
const sigtermHandler = () => {
handleCleanup().then(() => process.exit(result?.exitCode || 0));
};
process.once('SIGINT', sigintHandler);
process.once('SIGTERM', sigtermHandler);
// If there are comparisons, generate static report
const hasComparisons = result?.comparisons?.length > 0;
if (hasComparisons) {
// Note: Tests have completed at this point, so report-data.json is stable.
// The report reflects the final state of all comparisons.
const reportResult = await generateStaticReport(process.cwd());
if (reportResult.success) {
const reportUrl = getReportFileUrl(reportResult.reportPath);
output.print(
` ${colors.brand.textTertiary('→')} Report: ${colors.blue(reportUrl)}`
);
output.blank();
// Open report in browser unless --no-open
if (options.open !== false) {
await openBrowser(reportUrl);
}
} else {
output.warn(`Failed to generate static report: ${reportResult.error}`);
}
}
// Remove signal handlers before normal cleanup to prevent double cleanup
process.off('SIGINT', sigintHandler);
process.off('SIGTERM', sigtermHandler);
await handleCleanup();
process.exit(result?.exitCode || 0);
});
program
.command('run')
.description('Run tests with Vizzly integration')
.argument('<command>', 'Test command to run')
.option('--port <port>', 'Port for screenshot server', '47392')
.option('-b, --build-name <name>', 'Custom build name')
.option('--branch <branch>', 'Git branch override')
.option('--commit <sha>', 'Git commit SHA')
.option('--message <msg>', 'Commit message')
.option('--environment <env>', 'Environment name', 'test')
.option('--org <slug>', 'Target organization slug')
.option('--project <slug>', 'Target project slug')
.option('--project-id <id>', 'Target project ID')
.option('--token <token>', 'API token override')
.option('--wait', 'Wait for build completion')
.option('--timeout <ms>', 'Server timeout in milliseconds', '30000')
.option('--allow-no-token', 'Allow running without API token')
.option('--upload-all', 'Upload all screenshots without SHA deduplication')
.option('--parallel-id <id>', 'Unique identifier for parallel test execution')
.action(async (command, options) => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateRunOptions(command, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
try {
const result = await runCommand(command, options, globalOptions);
if (result && !result.success && result.exitCode > 0) {
process.exit(result.exitCode);
}
} catch (error) {
output.error('Command failed', error);
process.exit(1);
}
});
program
.command('status')
.description('Check the status of a build')
.argument('<build-id>', 'Build ID to check status for')
.action(async (buildId, options) => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateStatusOptions(buildId, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await statusCommand(buildId, options, globalOptions);
});
program
.command('builds')
.description('List and query builds')
.option('-b, --build <id>', 'Get a specific build by ID')
.option('--branch <branch>', 'Filter by branch')
.option(
'--status <status>',
'Filter by status (created, pending, processing, completed, failed)'
)
.option('--environment <env>', 'Filter by environment')
.option('-p, --project <slug>', 'Filter by project slug')
.option('--org <slug>', 'Filter by organization slug')
.option(
'--limit <n>',
'Maximum results to return (1-250)',
val => parseInt(val, 10),
20
)
.option('--offset <n>', 'Skip first N results', val => parseInt(val, 10), 0)
.option('--comparisons', 'Include comparisons when fetching a specific build')
.addHelpText(
'after',
`
Examples:
$ vizzly builds # List recent builds
$ vizzly builds --branch main # Filter by branch
$ vizzly builds --project storybook # Filter by project
$ vizzly builds --project storybook --org my-org # Disambiguate by org
$ vizzly builds --status completed # Filter by status
$ vizzly builds -b abc123-def456 # Get specific build by ID
$ vizzly builds -b abc123 --comparisons # Include comparisons
$ vizzly builds --json # Output as JSON for scripting
`
)
.action(async options => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateBuildsOptions(options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await buildsCommand(options, globalOptions);
});
program
.command('comparisons')
.description('Query and search comparisons')
.option('-b, --build <id>', 'Get comparisons for a specific build')
.option('--id <id>', 'Get a specific comparison by ID')
.option('--name <pattern>', 'Search comparisons by name (supports wildcards)')
.option('--status <status>', 'Filter by status (identical, new, changed)')
.option('--branch <branch>', 'Filter by branch (for name search)')
.option(
'--limit <n>',
'Maximum results to return (1-250)',
val => parseInt(val, 10),
50
)
.option('--offset <n>', 'Skip first N results', val => parseInt(val, 10), 0)
.option('-p, --project <slug>', 'Filter by project slug')
.option('--org <slug>', 'Filter by organization slug')
.addHelpText(
'after',
`
Examples:
$ vizzly comparisons -b abc123 # List comparisons for a build
$ vizzly comparisons --id def456 # Get specific comparison by ID
$ vizzly comparisons --name "Button" # Search by screenshot name
$ vizzly comparisons --name "Login*" # Wildcard search
$ vizzly comparisons --name "Button" --org my-org # Filter by org
$ vizzly comparisons --status changed # Only changed comparisons
$ vizzly comparisons --json # Output as JSON for scripting
`
)
.action(async options => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateComparisonsOptions(options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await comparisonsCommand(options, globalOptions);
});
program
.command('config')
.description('Display current configuration')
.argument(
'[key]',
'Specific config key to get (dot notation, e.g., comparison.threshold)'
)
.action(async (key, options) => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateConfigOptions(options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await configCommand(key, options, globalOptions);
});
program
.command('baselines')
.description('List and query local TDD baselines')
.option('--name <pattern>', 'Filter baselines by name (supports wildcards)')
.option('--info <name>', 'Get detailed info for a specific baseline')
.addHelpText(
'after',
`
Examples:
$ vizzly baselines # List all local baselines
$ vizzly baselines --name "Button*" # Filter by name pattern
$ vizzly baselines --info "homepage" # Get details for specific baseline
$ vizzly baselines --json # Output as JSON for scripting
Note: Baselines are stored locally in .vizzly/baselines/ during TDD mode.
`
)
.action(async options => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateBaselinesOptions(options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await baselinesCommand(options, globalOptions);
});
program
.command('api')
.description('Make raw API requests (for power users)')
.argument('<endpoint>', 'API endpoint (e.g., /api/sdk/builds)')
.option(
'-X, --method <method>',
'HTTP method (GET or POST for approve/reject/comment)',
'GET'
)
.option('-d, --data <json>', 'Request body (JSON)')
.option(
'-H, --header <header>',
'Add header (key:value), can be repeated',
(val, prev) => (prev ? [...prev, val] : [val])
)
.option(
'-q, --query <param>',
'Add query param (key=value), can be repeated',
(val, prev) => (prev ? [...prev, val] : [val])
)
.addHelpText(
'after',
`
Examples:
$ vizzly api /api/sdk/builds # List builds
$ vizzly api /api/sdk/builds -q limit=5 # With query params
$ vizzly api /api/sdk/builds/abc123 # Get specific build
$ vizzly api /api/sdk/comparisons/abc123/approve -X POST
$ vizzly api /api/sdk/builds/abc123/comments -X POST -d '{"content":"Nice!"}'
Note: POST is restricted to approve, reject, and comment endpoints.
Most operations have dedicated commands (builds, comparisons, approve, etc.).
`
)
.action(async (endpoint, options) => {
const globalOptions = program.opts();
// Validate options
const validationErrors = validateApiOptions(endpoint, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await apiCommand(endpoint, options, globalOptions);
});
program
.command('approve')
.description('Approve a comparison')
.argument('<comparison-id>', 'Comparison ID to approve (UUID format)')
.option('-m, --comment <message>', 'Optional comment explaining the approval')
.addHelpText(
'after',
`
Examples:
$ vizzly approve abc123-def456-7890 # Approve a comparison
$ vizzly approve abc123 -m "LGTM" # Approve with comment
$ vizzly approve abc123 --json # Output as JSON for scripting
Workflow:
1. List comparisons: vizzly comparisons -b <build-id>
2. Review the changes in the web UI or via URLs in the output
3. Approve: vizzly approve <comparison-id>
`
)
.action(async (comparisonId, options) => {
const globalOptions = program.opts();
const validationErrors = validateApproveOptions(comparisonId, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await approveCommand(comparisonId, options, globalOptions);
});
program
.command('reject')
.description('Reject a comparison')
.argument('<comparison-id>', 'Comparison ID to reject (UUID format)')
.option('-r, --reason <message>', 'Required reason for rejection')
.addHelpText(
'after',
`
Examples:
$ vizzly reject abc123 -r "Button color is wrong"
$ vizzly reject abc123 --reason "Needs design review"
$ vizzly reject abc123 -r "Regression" --json
Workflow:
1. List comparisons: vizzly comparisons -b <build-id>
2. Review the changes in the web UI or via URLs in the output
3. Reject with reason: vizzly reject <comparison-id> -r "reason"
`
)
.action(async (comparisonId, options) => {
const globalOptions = program.opts();
const validationErrors = validateRejectOptions(comparisonId, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await rejectCommand(comparisonId, options, globalOptions);
});
program
.command('comment')
.description('Add a comment to a build')
.argument('<build-id>', 'Build ID to comment on (UUID format)')
.argument('<message>', 'Comment message')
.option(
'-t, --type <type>',
'Comment type: general, approval, rejection',
'general'
)
.addHelpText(
'after',
`
Examples:
$ vizzly comment abc123 "Looks good overall"
$ vizzly comment abc123 "Approved" -t approval
$ vizzly comment abc123 "Please fix the header" -t rejection
$ vizzly comment abc123 "CI feedback" --json
Workflow:
1. Get build ID: vizzly builds --branch main
2. Add comment: vizzly comment <build-id> "Your message"
`
)
.action(async (buildId, message, options) => {
const globalOptions = program.opts();
const validationErrors = validateCommentOptions(buildId, message, options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await commentCommand(buildId, message, options, globalOptions);
});
program
.command('orgs')
.description('List organizations you have access to')
.addHelpText(
'after',
`
Examples:
$ vizzly orgs # List all organizations
$ vizzly orgs --json # Output as JSON for scripting
Note: Shows organizations from your user account (via vizzly login)
or the single organization for a project token.
`
)
.action(async options => {
const globalOptions = program.opts();
const validationErrors = validateOrgsOptions(options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await orgsCommand(options, globalOptions);
});
program
.command('projects')
.description('List projects you have access to')
.option('--org <slug>', 'Filter by organization slug')
.option(
'--limit <n>',
'Maximum results to return (1-250)',
val => parseInt(val, 10),
50
)
.option('--offset <n>', 'Skip first N results', val => parseInt(val, 10), 0)
.addHelpText(
'after',
`
Examples:
$ vizzly projects # List all projects
$ vizzly projects --org my-company # Filter by organization
$ vizzly projects --json # Output as JSON for scripting
Workflow:
1. List orgs: vizzly orgs
2. List projects: vizzly projects --org <org-slug>
3. Query builds: vizzly builds
`
)
.action(async options => {
const globalOptions = program.opts();
const validationErrors = validateProjectsOptions(options);
if (validationErrors.length > 0) {
output.error('Validation errors:');
for (let error of validationErrors) {
output.printErr(` - ${error}`);
}
process.exit(1);
}
await projectsCommand(options, globalOptions);