@sonisoft/now-sdk-ext-cli 5.2.0 → 5.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +166 -73
- package/dist/commands/flow/definition.d.ts +31 -0
- package/dist/commands/flow/definition.d.ts.map +1 -0
- package/dist/commands/flow/definition.js +166 -0
- package/dist/commands/flow/definition.js.map +1 -0
- package/dist/services/flow-display.service.d.ts +30 -1
- package/dist/services/flow-display.service.d.ts.map +1 -1
- package/dist/services/flow-display.service.js +134 -0
- package/dist/services/flow-display.service.js.map +1 -1
- package/oclif.manifest.json +954 -796
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -513,240 +513,6 @@
|
|
|
513
513
|
"query.js"
|
|
514
514
|
]
|
|
515
515
|
},
|
|
516
|
-
"atf": {
|
|
517
|
-
"aliases": [],
|
|
518
|
-
"args": {},
|
|
519
|
-
"description": "Execute ATF (Automated Test Framework) tests or test suites on a ServiceNow instance.\n\nThis command allows you to run automated tests and test suites remotely, making it perfect for CI/CD pipelines and automated testing workflows. You can execute individual tests, entire test suites, and configure execution parameters such as browser type, OS, and performance mode.\n\nFeatures:\n • Execute individual tests or complete test suites\n • Real-time progress monitoring\n • JSON output for CI/CD integration\n • Detailed test results and summaries\n • Browser and environment configuration\n • Performance testing mode support",
|
|
520
|
-
"examples": [
|
|
521
|
-
{
|
|
522
|
-
"description": "Execute a single ATF test by sys_id",
|
|
523
|
-
"command": "<%= config.bin %> <%= command.id %> --test-id f717a8c783103210621e78c6feaad396 --auth dev-instance"
|
|
524
|
-
},
|
|
525
|
-
{
|
|
526
|
-
"description": "Execute a test suite by sys_id and wait for completion",
|
|
527
|
-
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --auth dev-instance --wait"
|
|
528
|
-
},
|
|
529
|
-
{
|
|
530
|
-
"description": "Execute a test suite by name",
|
|
531
|
-
"command": "<%= config.bin %> <%= command.id %> --suite-name \"Smoke Tests\" --auth dev-instance"
|
|
532
|
-
},
|
|
533
|
-
{
|
|
534
|
-
"description": "Execute with specific browser configuration",
|
|
535
|
-
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --browser chrome --auth dev-instance"
|
|
536
|
-
},
|
|
537
|
-
{
|
|
538
|
-
"description": "Execute as performance test with JSON output for CI/CD",
|
|
539
|
-
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --performance --json --auth dev-instance"
|
|
540
|
-
},
|
|
541
|
-
{
|
|
542
|
-
"description": "Execute with custom poll interval (10 seconds)",
|
|
543
|
-
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --poll-interval 10000 --auth dev-instance"
|
|
544
|
-
}
|
|
545
|
-
],
|
|
546
|
-
"flags": {
|
|
547
|
-
"json": {
|
|
548
|
-
"char": "j",
|
|
549
|
-
"description": "Output results as JSON",
|
|
550
|
-
"name": "json",
|
|
551
|
-
"required": false,
|
|
552
|
-
"allowNo": false,
|
|
553
|
-
"type": "boolean"
|
|
554
|
-
},
|
|
555
|
-
"auth": {
|
|
556
|
-
"char": "a",
|
|
557
|
-
"description": "Auth alias to use.",
|
|
558
|
-
"name": "auth",
|
|
559
|
-
"required": false,
|
|
560
|
-
"hasDynamicHelp": false,
|
|
561
|
-
"multiple": false,
|
|
562
|
-
"type": "option"
|
|
563
|
-
},
|
|
564
|
-
"cred-store": {
|
|
565
|
-
"description": "Read credentials from @sonisoft/sn-credstore instead of the OS keyring. Use this in headless sessions (SSH, systemd, CI, agents) where the keyring cannot be unlocked.",
|
|
566
|
-
"helpGroup": "GLOBAL",
|
|
567
|
-
"name": "cred-store",
|
|
568
|
-
"required": false,
|
|
569
|
-
"allowNo": false,
|
|
570
|
-
"type": "boolean"
|
|
571
|
-
},
|
|
572
|
-
"deny-execute": {
|
|
573
|
-
"description": "Refuse background scripts, flow runs and ATF runs for this invocation.",
|
|
574
|
-
"helpGroup": "GLOBAL",
|
|
575
|
-
"name": "deny-execute",
|
|
576
|
-
"required": false,
|
|
577
|
-
"allowNo": false,
|
|
578
|
-
"type": "boolean"
|
|
579
|
-
},
|
|
580
|
-
"deny-write": {
|
|
581
|
-
"description": "Refuse any change to instance data for this invocation.",
|
|
582
|
-
"helpGroup": "GLOBAL",
|
|
583
|
-
"name": "deny-write",
|
|
584
|
-
"required": false,
|
|
585
|
-
"allowNo": false,
|
|
586
|
-
"type": "boolean"
|
|
587
|
-
},
|
|
588
|
-
"log-dir": {
|
|
589
|
-
"description": "Directory to write log files to. Implies --log-file.",
|
|
590
|
-
"helpGroup": "GLOBAL",
|
|
591
|
-
"name": "log-dir",
|
|
592
|
-
"required": false,
|
|
593
|
-
"hasDynamicHelp": false,
|
|
594
|
-
"multiple": false,
|
|
595
|
-
"type": "option"
|
|
596
|
-
},
|
|
597
|
-
"log-file": {
|
|
598
|
-
"description": "Write logs to a file. Defaults to $XDG_STATE_HOME/now-sdk-ext/logs (~/.local/state/now-sdk-ext/logs). Off by default; without this, nex logs warnings and errors to stderr only.",
|
|
599
|
-
"helpGroup": "GLOBAL",
|
|
600
|
-
"name": "log-file",
|
|
601
|
-
"required": false,
|
|
602
|
-
"allowNo": false,
|
|
603
|
-
"type": "boolean"
|
|
604
|
-
},
|
|
605
|
-
"log-level": {
|
|
606
|
-
"helpGroup": "GLOBAL",
|
|
607
|
-
"name": "log-level",
|
|
608
|
-
"summary": "Specify level for logging.",
|
|
609
|
-
"default": "info",
|
|
610
|
-
"hasDynamicHelp": false,
|
|
611
|
-
"multiple": false,
|
|
612
|
-
"options": [
|
|
613
|
-
"debug",
|
|
614
|
-
"warn",
|
|
615
|
-
"error",
|
|
616
|
-
"info",
|
|
617
|
-
"trace"
|
|
618
|
-
],
|
|
619
|
-
"type": "option"
|
|
620
|
-
},
|
|
621
|
-
"read-only": {
|
|
622
|
-
"description": "Refuse every change to the instance — equivalent to --deny-write --deny-execute. Reads are unaffected.",
|
|
623
|
-
"helpGroup": "GLOBAL",
|
|
624
|
-
"name": "read-only",
|
|
625
|
-
"required": false,
|
|
626
|
-
"allowNo": false,
|
|
627
|
-
"type": "boolean"
|
|
628
|
-
},
|
|
629
|
-
"test-id": {
|
|
630
|
-
"char": "t",
|
|
631
|
-
"description": "Test sys_id to execute",
|
|
632
|
-
"exclusive": [
|
|
633
|
-
"suite-id",
|
|
634
|
-
"suite-name"
|
|
635
|
-
],
|
|
636
|
-
"name": "test-id",
|
|
637
|
-
"required": false,
|
|
638
|
-
"hasDynamicHelp": false,
|
|
639
|
-
"multiple": false,
|
|
640
|
-
"type": "option"
|
|
641
|
-
},
|
|
642
|
-
"suite-id": {
|
|
643
|
-
"char": "s",
|
|
644
|
-
"description": "Test Suite sys_id to execute",
|
|
645
|
-
"exclusive": [
|
|
646
|
-
"test-id",
|
|
647
|
-
"suite-name"
|
|
648
|
-
],
|
|
649
|
-
"name": "suite-id",
|
|
650
|
-
"required": false,
|
|
651
|
-
"hasDynamicHelp": false,
|
|
652
|
-
"multiple": false,
|
|
653
|
-
"type": "option"
|
|
654
|
-
},
|
|
655
|
-
"suite-name": {
|
|
656
|
-
"char": "n",
|
|
657
|
-
"description": "Test Suite name to execute",
|
|
658
|
-
"exclusive": [
|
|
659
|
-
"test-id",
|
|
660
|
-
"suite-id"
|
|
661
|
-
],
|
|
662
|
-
"name": "suite-name",
|
|
663
|
-
"required": false,
|
|
664
|
-
"hasDynamicHelp": false,
|
|
665
|
-
"multiple": false,
|
|
666
|
-
"type": "option"
|
|
667
|
-
},
|
|
668
|
-
"wait": {
|
|
669
|
-
"char": "w",
|
|
670
|
-
"description": "Wait for test suite execution to complete and return results",
|
|
671
|
-
"name": "wait",
|
|
672
|
-
"required": false,
|
|
673
|
-
"allowNo": false,
|
|
674
|
-
"type": "boolean"
|
|
675
|
-
},
|
|
676
|
-
"poll-interval": {
|
|
677
|
-
"char": "p",
|
|
678
|
-
"description": "Polling interval in milliseconds when waiting for completion",
|
|
679
|
-
"name": "poll-interval",
|
|
680
|
-
"required": false,
|
|
681
|
-
"default": 5000,
|
|
682
|
-
"hasDynamicHelp": false,
|
|
683
|
-
"multiple": false,
|
|
684
|
-
"type": "option"
|
|
685
|
-
},
|
|
686
|
-
"browser": {
|
|
687
|
-
"char": "b",
|
|
688
|
-
"description": "Browser name for test execution (e.g., chrome, firefox)",
|
|
689
|
-
"name": "browser",
|
|
690
|
-
"required": false,
|
|
691
|
-
"hasDynamicHelp": false,
|
|
692
|
-
"multiple": false,
|
|
693
|
-
"type": "option"
|
|
694
|
-
},
|
|
695
|
-
"browser-version": {
|
|
696
|
-
"description": "Browser version for test execution",
|
|
697
|
-
"name": "browser-version",
|
|
698
|
-
"required": false,
|
|
699
|
-
"hasDynamicHelp": false,
|
|
700
|
-
"multiple": false,
|
|
701
|
-
"type": "option"
|
|
702
|
-
},
|
|
703
|
-
"os-name": {
|
|
704
|
-
"description": "Operating system name for test execution",
|
|
705
|
-
"name": "os-name",
|
|
706
|
-
"required": false,
|
|
707
|
-
"hasDynamicHelp": false,
|
|
708
|
-
"multiple": false,
|
|
709
|
-
"type": "option"
|
|
710
|
-
},
|
|
711
|
-
"os-version": {
|
|
712
|
-
"description": "Operating system version for test execution",
|
|
713
|
-
"name": "os-version",
|
|
714
|
-
"required": false,
|
|
715
|
-
"hasDynamicHelp": false,
|
|
716
|
-
"multiple": false,
|
|
717
|
-
"type": "option"
|
|
718
|
-
},
|
|
719
|
-
"performance": {
|
|
720
|
-
"description": "Run as performance test",
|
|
721
|
-
"name": "performance",
|
|
722
|
-
"required": false,
|
|
723
|
-
"allowNo": false,
|
|
724
|
-
"type": "boolean"
|
|
725
|
-
},
|
|
726
|
-
"cloud": {
|
|
727
|
-
"description": "Run in cloud",
|
|
728
|
-
"name": "cloud",
|
|
729
|
-
"required": false,
|
|
730
|
-
"allowNo": false,
|
|
731
|
-
"type": "boolean"
|
|
732
|
-
}
|
|
733
|
-
},
|
|
734
|
-
"hasDynamicHelp": false,
|
|
735
|
-
"hiddenAliases": [],
|
|
736
|
-
"id": "atf",
|
|
737
|
-
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
738
|
-
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
739
|
-
"pluginType": "core",
|
|
740
|
-
"strict": true,
|
|
741
|
-
"enableJsonFlag": true,
|
|
742
|
-
"isESM": true,
|
|
743
|
-
"relativePath": [
|
|
744
|
-
"dist",
|
|
745
|
-
"commands",
|
|
746
|
-
"atf",
|
|
747
|
-
"index.js"
|
|
748
|
-
]
|
|
749
|
-
},
|
|
750
516
|
"app": {
|
|
751
517
|
"aliases": [],
|
|
752
518
|
"args": {},
|
|
@@ -1471,29 +1237,263 @@
|
|
|
1471
1237
|
"uninstall.js"
|
|
1472
1238
|
]
|
|
1473
1239
|
},
|
|
1474
|
-
"
|
|
1240
|
+
"atf": {
|
|
1475
1241
|
"aliases": [],
|
|
1476
1242
|
"args": {},
|
|
1477
|
-
"description": "
|
|
1243
|
+
"description": "Execute ATF (Automated Test Framework) tests or test suites on a ServiceNow instance.\n\nThis command allows you to run automated tests and test suites remotely, making it perfect for CI/CD pipelines and automated testing workflows. You can execute individual tests, entire test suites, and configure execution parameters such as browser type, OS, and performance mode.\n\nFeatures:\n • Execute individual tests or complete test suites\n • Real-time progress monitoring\n • JSON output for CI/CD integration\n • Detailed test results and summaries\n • Browser and environment configuration\n • Performance testing mode support",
|
|
1478
1244
|
"examples": [
|
|
1479
1245
|
{
|
|
1480
|
-
"
|
|
1481
|
-
"
|
|
1246
|
+
"description": "Execute a single ATF test by sys_id",
|
|
1247
|
+
"command": "<%= config.bin %> <%= command.id %> --test-id f717a8c783103210621e78c6feaad396 --auth dev-instance"
|
|
1482
1248
|
},
|
|
1483
1249
|
{
|
|
1484
|
-
"
|
|
1485
|
-
"
|
|
1486
|
-
}
|
|
1487
|
-
],
|
|
1488
|
-
"flags": {
|
|
1489
|
-
"json": {
|
|
1490
|
-
"description": "Format output as json.",
|
|
1491
|
-
"helpGroup": "GLOBAL",
|
|
1492
|
-
"name": "json",
|
|
1493
|
-
"allowNo": false,
|
|
1494
|
-
"type": "boolean"
|
|
1250
|
+
"description": "Execute a test suite by sys_id and wait for completion",
|
|
1251
|
+
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --auth dev-instance --wait"
|
|
1495
1252
|
},
|
|
1496
|
-
|
|
1253
|
+
{
|
|
1254
|
+
"description": "Execute a test suite by name",
|
|
1255
|
+
"command": "<%= config.bin %> <%= command.id %> --suite-name \"Smoke Tests\" --auth dev-instance"
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"description": "Execute with specific browser configuration",
|
|
1259
|
+
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --browser chrome --auth dev-instance"
|
|
1260
|
+
},
|
|
1261
|
+
{
|
|
1262
|
+
"description": "Execute as performance test with JSON output for CI/CD",
|
|
1263
|
+
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --performance --json --auth dev-instance"
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
"description": "Execute with custom poll interval (10 seconds)",
|
|
1267
|
+
"command": "<%= config.bin %> <%= command.id %> --suite-id e077e00b83103210621e78c6feaad383 --poll-interval 10000 --auth dev-instance"
|
|
1268
|
+
}
|
|
1269
|
+
],
|
|
1270
|
+
"flags": {
|
|
1271
|
+
"json": {
|
|
1272
|
+
"char": "j",
|
|
1273
|
+
"description": "Output results as JSON",
|
|
1274
|
+
"name": "json",
|
|
1275
|
+
"required": false,
|
|
1276
|
+
"allowNo": false,
|
|
1277
|
+
"type": "boolean"
|
|
1278
|
+
},
|
|
1279
|
+
"auth": {
|
|
1280
|
+
"char": "a",
|
|
1281
|
+
"description": "Auth alias to use.",
|
|
1282
|
+
"name": "auth",
|
|
1283
|
+
"required": false,
|
|
1284
|
+
"hasDynamicHelp": false,
|
|
1285
|
+
"multiple": false,
|
|
1286
|
+
"type": "option"
|
|
1287
|
+
},
|
|
1288
|
+
"cred-store": {
|
|
1289
|
+
"description": "Read credentials from @sonisoft/sn-credstore instead of the OS keyring. Use this in headless sessions (SSH, systemd, CI, agents) where the keyring cannot be unlocked.",
|
|
1290
|
+
"helpGroup": "GLOBAL",
|
|
1291
|
+
"name": "cred-store",
|
|
1292
|
+
"required": false,
|
|
1293
|
+
"allowNo": false,
|
|
1294
|
+
"type": "boolean"
|
|
1295
|
+
},
|
|
1296
|
+
"deny-execute": {
|
|
1297
|
+
"description": "Refuse background scripts, flow runs and ATF runs for this invocation.",
|
|
1298
|
+
"helpGroup": "GLOBAL",
|
|
1299
|
+
"name": "deny-execute",
|
|
1300
|
+
"required": false,
|
|
1301
|
+
"allowNo": false,
|
|
1302
|
+
"type": "boolean"
|
|
1303
|
+
},
|
|
1304
|
+
"deny-write": {
|
|
1305
|
+
"description": "Refuse any change to instance data for this invocation.",
|
|
1306
|
+
"helpGroup": "GLOBAL",
|
|
1307
|
+
"name": "deny-write",
|
|
1308
|
+
"required": false,
|
|
1309
|
+
"allowNo": false,
|
|
1310
|
+
"type": "boolean"
|
|
1311
|
+
},
|
|
1312
|
+
"log-dir": {
|
|
1313
|
+
"description": "Directory to write log files to. Implies --log-file.",
|
|
1314
|
+
"helpGroup": "GLOBAL",
|
|
1315
|
+
"name": "log-dir",
|
|
1316
|
+
"required": false,
|
|
1317
|
+
"hasDynamicHelp": false,
|
|
1318
|
+
"multiple": false,
|
|
1319
|
+
"type": "option"
|
|
1320
|
+
},
|
|
1321
|
+
"log-file": {
|
|
1322
|
+
"description": "Write logs to a file. Defaults to $XDG_STATE_HOME/now-sdk-ext/logs (~/.local/state/now-sdk-ext/logs). Off by default; without this, nex logs warnings and errors to stderr only.",
|
|
1323
|
+
"helpGroup": "GLOBAL",
|
|
1324
|
+
"name": "log-file",
|
|
1325
|
+
"required": false,
|
|
1326
|
+
"allowNo": false,
|
|
1327
|
+
"type": "boolean"
|
|
1328
|
+
},
|
|
1329
|
+
"log-level": {
|
|
1330
|
+
"helpGroup": "GLOBAL",
|
|
1331
|
+
"name": "log-level",
|
|
1332
|
+
"summary": "Specify level for logging.",
|
|
1333
|
+
"default": "info",
|
|
1334
|
+
"hasDynamicHelp": false,
|
|
1335
|
+
"multiple": false,
|
|
1336
|
+
"options": [
|
|
1337
|
+
"debug",
|
|
1338
|
+
"warn",
|
|
1339
|
+
"error",
|
|
1340
|
+
"info",
|
|
1341
|
+
"trace"
|
|
1342
|
+
],
|
|
1343
|
+
"type": "option"
|
|
1344
|
+
},
|
|
1345
|
+
"read-only": {
|
|
1346
|
+
"description": "Refuse every change to the instance — equivalent to --deny-write --deny-execute. Reads are unaffected.",
|
|
1347
|
+
"helpGroup": "GLOBAL",
|
|
1348
|
+
"name": "read-only",
|
|
1349
|
+
"required": false,
|
|
1350
|
+
"allowNo": false,
|
|
1351
|
+
"type": "boolean"
|
|
1352
|
+
},
|
|
1353
|
+
"test-id": {
|
|
1354
|
+
"char": "t",
|
|
1355
|
+
"description": "Test sys_id to execute",
|
|
1356
|
+
"exclusive": [
|
|
1357
|
+
"suite-id",
|
|
1358
|
+
"suite-name"
|
|
1359
|
+
],
|
|
1360
|
+
"name": "test-id",
|
|
1361
|
+
"required": false,
|
|
1362
|
+
"hasDynamicHelp": false,
|
|
1363
|
+
"multiple": false,
|
|
1364
|
+
"type": "option"
|
|
1365
|
+
},
|
|
1366
|
+
"suite-id": {
|
|
1367
|
+
"char": "s",
|
|
1368
|
+
"description": "Test Suite sys_id to execute",
|
|
1369
|
+
"exclusive": [
|
|
1370
|
+
"test-id",
|
|
1371
|
+
"suite-name"
|
|
1372
|
+
],
|
|
1373
|
+
"name": "suite-id",
|
|
1374
|
+
"required": false,
|
|
1375
|
+
"hasDynamicHelp": false,
|
|
1376
|
+
"multiple": false,
|
|
1377
|
+
"type": "option"
|
|
1378
|
+
},
|
|
1379
|
+
"suite-name": {
|
|
1380
|
+
"char": "n",
|
|
1381
|
+
"description": "Test Suite name to execute",
|
|
1382
|
+
"exclusive": [
|
|
1383
|
+
"test-id",
|
|
1384
|
+
"suite-id"
|
|
1385
|
+
],
|
|
1386
|
+
"name": "suite-name",
|
|
1387
|
+
"required": false,
|
|
1388
|
+
"hasDynamicHelp": false,
|
|
1389
|
+
"multiple": false,
|
|
1390
|
+
"type": "option"
|
|
1391
|
+
},
|
|
1392
|
+
"wait": {
|
|
1393
|
+
"char": "w",
|
|
1394
|
+
"description": "Wait for test suite execution to complete and return results",
|
|
1395
|
+
"name": "wait",
|
|
1396
|
+
"required": false,
|
|
1397
|
+
"allowNo": false,
|
|
1398
|
+
"type": "boolean"
|
|
1399
|
+
},
|
|
1400
|
+
"poll-interval": {
|
|
1401
|
+
"char": "p",
|
|
1402
|
+
"description": "Polling interval in milliseconds when waiting for completion",
|
|
1403
|
+
"name": "poll-interval",
|
|
1404
|
+
"required": false,
|
|
1405
|
+
"default": 5000,
|
|
1406
|
+
"hasDynamicHelp": false,
|
|
1407
|
+
"multiple": false,
|
|
1408
|
+
"type": "option"
|
|
1409
|
+
},
|
|
1410
|
+
"browser": {
|
|
1411
|
+
"char": "b",
|
|
1412
|
+
"description": "Browser name for test execution (e.g., chrome, firefox)",
|
|
1413
|
+
"name": "browser",
|
|
1414
|
+
"required": false,
|
|
1415
|
+
"hasDynamicHelp": false,
|
|
1416
|
+
"multiple": false,
|
|
1417
|
+
"type": "option"
|
|
1418
|
+
},
|
|
1419
|
+
"browser-version": {
|
|
1420
|
+
"description": "Browser version for test execution",
|
|
1421
|
+
"name": "browser-version",
|
|
1422
|
+
"required": false,
|
|
1423
|
+
"hasDynamicHelp": false,
|
|
1424
|
+
"multiple": false,
|
|
1425
|
+
"type": "option"
|
|
1426
|
+
},
|
|
1427
|
+
"os-name": {
|
|
1428
|
+
"description": "Operating system name for test execution",
|
|
1429
|
+
"name": "os-name",
|
|
1430
|
+
"required": false,
|
|
1431
|
+
"hasDynamicHelp": false,
|
|
1432
|
+
"multiple": false,
|
|
1433
|
+
"type": "option"
|
|
1434
|
+
},
|
|
1435
|
+
"os-version": {
|
|
1436
|
+
"description": "Operating system version for test execution",
|
|
1437
|
+
"name": "os-version",
|
|
1438
|
+
"required": false,
|
|
1439
|
+
"hasDynamicHelp": false,
|
|
1440
|
+
"multiple": false,
|
|
1441
|
+
"type": "option"
|
|
1442
|
+
},
|
|
1443
|
+
"performance": {
|
|
1444
|
+
"description": "Run as performance test",
|
|
1445
|
+
"name": "performance",
|
|
1446
|
+
"required": false,
|
|
1447
|
+
"allowNo": false,
|
|
1448
|
+
"type": "boolean"
|
|
1449
|
+
},
|
|
1450
|
+
"cloud": {
|
|
1451
|
+
"description": "Run in cloud",
|
|
1452
|
+
"name": "cloud",
|
|
1453
|
+
"required": false,
|
|
1454
|
+
"allowNo": false,
|
|
1455
|
+
"type": "boolean"
|
|
1456
|
+
}
|
|
1457
|
+
},
|
|
1458
|
+
"hasDynamicHelp": false,
|
|
1459
|
+
"hiddenAliases": [],
|
|
1460
|
+
"id": "atf",
|
|
1461
|
+
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
1462
|
+
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
1463
|
+
"pluginType": "core",
|
|
1464
|
+
"strict": true,
|
|
1465
|
+
"enableJsonFlag": true,
|
|
1466
|
+
"isESM": true,
|
|
1467
|
+
"relativePath": [
|
|
1468
|
+
"dist",
|
|
1469
|
+
"commands",
|
|
1470
|
+
"atf",
|
|
1471
|
+
"index.js"
|
|
1472
|
+
]
|
|
1473
|
+
},
|
|
1474
|
+
"attachment:get": {
|
|
1475
|
+
"aliases": [],
|
|
1476
|
+
"args": {},
|
|
1477
|
+
"description": "Get metadata for a specific attachment.",
|
|
1478
|
+
"examples": [
|
|
1479
|
+
{
|
|
1480
|
+
"command": "<%= config.bin %> <%= command.id %> --sys-id att123 --auth dev",
|
|
1481
|
+
"description": "Get attachment metadata by sys_id"
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
"command": "<%= config.bin %> <%= command.id %> -s att123 --json --auth dev",
|
|
1485
|
+
"description": "Get attachment metadata as JSON"
|
|
1486
|
+
}
|
|
1487
|
+
],
|
|
1488
|
+
"flags": {
|
|
1489
|
+
"json": {
|
|
1490
|
+
"description": "Format output as json.",
|
|
1491
|
+
"helpGroup": "GLOBAL",
|
|
1492
|
+
"name": "json",
|
|
1493
|
+
"allowNo": false,
|
|
1494
|
+
"type": "boolean"
|
|
1495
|
+
},
|
|
1496
|
+
"auth": {
|
|
1497
1497
|
"char": "a",
|
|
1498
1498
|
"description": "Auth alias to use.",
|
|
1499
1499
|
"name": "auth",
|
|
@@ -2817,20 +2817,186 @@
|
|
|
2817
2817
|
"index.js"
|
|
2818
2818
|
]
|
|
2819
2819
|
},
|
|
2820
|
-
"
|
|
2820
|
+
"health:check": {
|
|
2821
2821
|
"aliases": [],
|
|
2822
2822
|
"args": {},
|
|
2823
|
-
"description": "
|
|
2823
|
+
"description": "Run a consolidated health check on a ServiceNow instance.\n\nPerforms comprehensive diagnostics including version info, cluster status, stuck job detection, semaphore counts, and operational record counts.\n\nFeatures:\n • Instance version and build information\n • Cluster node status\n • Stuck job detection with configurable threshold\n • Active semaphore count\n • Operational counts (incidents, changes, problems)\n • Color-coded status indicators\n • JSON output for CI/CD monitoring",
|
|
2824
2824
|
"examples": [
|
|
2825
2825
|
{
|
|
2826
|
-
"description": "Run
|
|
2827
|
-
"command": "<%= config.bin %> <%= command.id %> --
|
|
2828
|
-
}
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
|
|
2826
|
+
"description": "Run full health check",
|
|
2827
|
+
"command": "<%= config.bin %> <%= command.id %> --auth dev"
|
|
2828
|
+
},
|
|
2829
|
+
{
|
|
2830
|
+
"description": "Check only version and stuck jobs",
|
|
2831
|
+
"command": "<%= config.bin %> <%= command.id %> --include-version --include-stuck-jobs --no-include-cluster --no-include-semaphores --no-include-operational-counts --auth dev"
|
|
2832
|
+
},
|
|
2833
|
+
{
|
|
2834
|
+
"description": "Health check with custom stuck job threshold",
|
|
2835
|
+
"command": "<%= config.bin %> <%= command.id %> --stuck-job-threshold 60 --auth dev"
|
|
2836
|
+
},
|
|
2837
|
+
{
|
|
2838
|
+
"description": "Health check as JSON",
|
|
2839
|
+
"command": "<%= config.bin %> <%= command.id %> --json --auth dev"
|
|
2840
|
+
}
|
|
2841
|
+
],
|
|
2842
|
+
"flags": {
|
|
2843
|
+
"json": {
|
|
2844
|
+
"char": "j",
|
|
2845
|
+
"description": "Output results as JSON",
|
|
2846
|
+
"name": "json",
|
|
2847
|
+
"required": false,
|
|
2848
|
+
"allowNo": false,
|
|
2849
|
+
"type": "boolean"
|
|
2850
|
+
},
|
|
2851
|
+
"auth": {
|
|
2852
|
+
"char": "a",
|
|
2853
|
+
"description": "Auth alias to use.",
|
|
2854
|
+
"name": "auth",
|
|
2855
|
+
"required": false,
|
|
2856
|
+
"hasDynamicHelp": false,
|
|
2857
|
+
"multiple": false,
|
|
2858
|
+
"type": "option"
|
|
2859
|
+
},
|
|
2860
|
+
"cred-store": {
|
|
2861
|
+
"description": "Read credentials from @sonisoft/sn-credstore instead of the OS keyring. Use this in headless sessions (SSH, systemd, CI, agents) where the keyring cannot be unlocked.",
|
|
2862
|
+
"helpGroup": "GLOBAL",
|
|
2863
|
+
"name": "cred-store",
|
|
2864
|
+
"required": false,
|
|
2865
|
+
"allowNo": false,
|
|
2866
|
+
"type": "boolean"
|
|
2867
|
+
},
|
|
2868
|
+
"deny-execute": {
|
|
2869
|
+
"description": "Refuse background scripts, flow runs and ATF runs for this invocation.",
|
|
2870
|
+
"helpGroup": "GLOBAL",
|
|
2871
|
+
"name": "deny-execute",
|
|
2872
|
+
"required": false,
|
|
2873
|
+
"allowNo": false,
|
|
2874
|
+
"type": "boolean"
|
|
2875
|
+
},
|
|
2876
|
+
"deny-write": {
|
|
2877
|
+
"description": "Refuse any change to instance data for this invocation.",
|
|
2878
|
+
"helpGroup": "GLOBAL",
|
|
2879
|
+
"name": "deny-write",
|
|
2880
|
+
"required": false,
|
|
2881
|
+
"allowNo": false,
|
|
2882
|
+
"type": "boolean"
|
|
2883
|
+
},
|
|
2884
|
+
"log-dir": {
|
|
2885
|
+
"description": "Directory to write log files to. Implies --log-file.",
|
|
2886
|
+
"helpGroup": "GLOBAL",
|
|
2887
|
+
"name": "log-dir",
|
|
2888
|
+
"required": false,
|
|
2889
|
+
"hasDynamicHelp": false,
|
|
2890
|
+
"multiple": false,
|
|
2891
|
+
"type": "option"
|
|
2892
|
+
},
|
|
2893
|
+
"log-file": {
|
|
2894
|
+
"description": "Write logs to a file. Defaults to $XDG_STATE_HOME/now-sdk-ext/logs (~/.local/state/now-sdk-ext/logs). Off by default; without this, nex logs warnings and errors to stderr only.",
|
|
2895
|
+
"helpGroup": "GLOBAL",
|
|
2896
|
+
"name": "log-file",
|
|
2897
|
+
"required": false,
|
|
2898
|
+
"allowNo": false,
|
|
2899
|
+
"type": "boolean"
|
|
2900
|
+
},
|
|
2901
|
+
"log-level": {
|
|
2902
|
+
"helpGroup": "GLOBAL",
|
|
2903
|
+
"name": "log-level",
|
|
2904
|
+
"summary": "Specify level for logging.",
|
|
2905
|
+
"default": "info",
|
|
2906
|
+
"hasDynamicHelp": false,
|
|
2907
|
+
"multiple": false,
|
|
2908
|
+
"options": [
|
|
2909
|
+
"debug",
|
|
2910
|
+
"warn",
|
|
2911
|
+
"error",
|
|
2912
|
+
"info",
|
|
2913
|
+
"trace"
|
|
2914
|
+
],
|
|
2915
|
+
"type": "option"
|
|
2916
|
+
},
|
|
2917
|
+
"read-only": {
|
|
2918
|
+
"description": "Refuse every change to the instance — equivalent to --deny-write --deny-execute. Reads are unaffected.",
|
|
2919
|
+
"helpGroup": "GLOBAL",
|
|
2920
|
+
"name": "read-only",
|
|
2921
|
+
"required": false,
|
|
2922
|
+
"allowNo": false,
|
|
2923
|
+
"type": "boolean"
|
|
2924
|
+
},
|
|
2925
|
+
"include-version": {
|
|
2926
|
+
"description": "Include instance version information",
|
|
2927
|
+
"name": "include-version",
|
|
2928
|
+
"required": false,
|
|
2929
|
+
"allowNo": true,
|
|
2930
|
+
"type": "boolean"
|
|
2931
|
+
},
|
|
2932
|
+
"include-cluster": {
|
|
2933
|
+
"description": "Include cluster node status",
|
|
2934
|
+
"name": "include-cluster",
|
|
2935
|
+
"required": false,
|
|
2936
|
+
"allowNo": true,
|
|
2937
|
+
"type": "boolean"
|
|
2938
|
+
},
|
|
2939
|
+
"include-stuck-jobs": {
|
|
2940
|
+
"description": "Include stuck job detection",
|
|
2941
|
+
"name": "include-stuck-jobs",
|
|
2942
|
+
"required": false,
|
|
2943
|
+
"allowNo": true,
|
|
2944
|
+
"type": "boolean"
|
|
2945
|
+
},
|
|
2946
|
+
"include-semaphores": {
|
|
2947
|
+
"description": "Include active semaphore count",
|
|
2948
|
+
"name": "include-semaphores",
|
|
2949
|
+
"required": false,
|
|
2950
|
+
"allowNo": true,
|
|
2951
|
+
"type": "boolean"
|
|
2952
|
+
},
|
|
2953
|
+
"include-operational-counts": {
|
|
2954
|
+
"description": "Include operational record counts (incidents, changes, problems)",
|
|
2955
|
+
"name": "include-operational-counts",
|
|
2956
|
+
"required": false,
|
|
2957
|
+
"allowNo": true,
|
|
2958
|
+
"type": "boolean"
|
|
2959
|
+
},
|
|
2960
|
+
"stuck-job-threshold": {
|
|
2961
|
+
"description": "Minutes threshold for a job to be considered stuck",
|
|
2962
|
+
"name": "stuck-job-threshold",
|
|
2963
|
+
"required": false,
|
|
2964
|
+
"default": 30,
|
|
2965
|
+
"hasDynamicHelp": false,
|
|
2966
|
+
"multiple": false,
|
|
2967
|
+
"type": "option"
|
|
2968
|
+
}
|
|
2969
|
+
},
|
|
2970
|
+
"hasDynamicHelp": false,
|
|
2971
|
+
"hiddenAliases": [],
|
|
2972
|
+
"id": "health:check",
|
|
2973
|
+
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
2974
|
+
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
2975
|
+
"pluginType": "core",
|
|
2976
|
+
"strict": true,
|
|
2977
|
+
"enableJsonFlag": true,
|
|
2978
|
+
"isESM": true,
|
|
2979
|
+
"relativePath": [
|
|
2980
|
+
"dist",
|
|
2981
|
+
"commands",
|
|
2982
|
+
"health",
|
|
2983
|
+
"check.js"
|
|
2984
|
+
]
|
|
2985
|
+
},
|
|
2986
|
+
"flow:action": {
|
|
2987
|
+
"aliases": [],
|
|
2988
|
+
"args": {},
|
|
2989
|
+
"description": "Execute a Flow Designer action by scoped name.\n\nRuns an action using the sn_fd.FlowAPI ScriptableFlowRunner.\n\nFeatures:\n • Execute actions by scoped name\n • Pass input values as JSON\n • Foreground or background execution mode\n • Returns context ID, outputs, and debug information",
|
|
2990
|
+
"examples": [
|
|
2991
|
+
{
|
|
2992
|
+
"description": "Run an action",
|
|
2993
|
+
"command": "<%= config.bin %> <%= command.id %> --name global.create_record --inputs '{\"table\":\"incident\",\"values\":{\"short_description\":\"Test\"}}' --auth dev"
|
|
2994
|
+
}
|
|
2995
|
+
],
|
|
2996
|
+
"flags": {
|
|
2997
|
+
"json": {
|
|
2998
|
+
"char": "j",
|
|
2999
|
+
"description": "Output results as JSON",
|
|
2834
3000
|
"name": "json",
|
|
2835
3001
|
"required": false,
|
|
2836
3002
|
"allowNo": false,
|
|
@@ -3259,28 +3425,36 @@
|
|
|
3259
3425
|
"copy.js"
|
|
3260
3426
|
]
|
|
3261
3427
|
},
|
|
3262
|
-
"flow:
|
|
3428
|
+
"flow:definition": {
|
|
3263
3429
|
"aliases": [],
|
|
3264
3430
|
"args": {},
|
|
3265
|
-
"description": "
|
|
3431
|
+
"description": "Retrieve the read-only design-time definition of a flow, subflow, or action.\n\nReturns what the artifact IS, not what a run of it did: triggers, actions, nested subflows, flow logic, inputs and outputs as Workflow Studio stores them. Nothing is executed, published or modified, and no flow context is created or required.\n\nThis is the design-time counterpart to `flow details`, which describes one past execution and needs a context sys_id.\n\nThe type is never inferred from the sys_id: --type selects the artifact that is asked for, and a sys_id of a different type fails with a type_mismatch rather than being relabelled.\n\nWith --json, stdout carries exactly one JSON document — the complete typed result including the untouched ServiceNow payload — so it can be piped or redirected. Without it, a short summary is printed; definition bodies, step scripts and input values are never printed or logged.",
|
|
3266
3432
|
"examples": [
|
|
3267
3433
|
{
|
|
3268
|
-
"description": "
|
|
3269
|
-
"command": "<%= config.bin %> <%= command.id %> --
|
|
3434
|
+
"description": "Summarise a flow definition",
|
|
3435
|
+
"command": "<%= config.bin %> <%= command.id %> --sys-id 887dda5583237210fdb8f7b6feaad32c --auth dev"
|
|
3270
3436
|
},
|
|
3271
3437
|
{
|
|
3272
|
-
"description": "
|
|
3273
|
-
"command": "<%= config.bin %> <%= command.id %> -
|
|
3438
|
+
"description": "Retrieve a subflow definition",
|
|
3439
|
+
"command": "<%= config.bin %> <%= command.id %> -i 887dda5583237210fdb8f7b6feaad32c --type subflow --auth dev"
|
|
3274
3440
|
},
|
|
3275
3441
|
{
|
|
3276
|
-
"description": "
|
|
3277
|
-
"command": "<%= config.bin %> <%= command.id %> -
|
|
3442
|
+
"description": "Retrieve a custom action definition with its ordered steps",
|
|
3443
|
+
"command": "<%= config.bin %> <%= command.id %> -i 887dda5583237210fdb8f7b6feaad32c --type action --auth dev"
|
|
3444
|
+
},
|
|
3445
|
+
{
|
|
3446
|
+
"description": "Redirect the full JSON definition to a file",
|
|
3447
|
+
"command": "<%= config.bin %> <%= command.id %> -i 887dda5583237210fdb8f7b6feaad32c --json --auth dev > flow.json"
|
|
3448
|
+
},
|
|
3449
|
+
{
|
|
3450
|
+
"description": "Pipe the JSON definition into another tool",
|
|
3451
|
+
"command": "<%= config.bin %> <%= command.id %> -i 887dda5583237210fdb8f7b6feaad32c --type action --json --auth dev | jq .summary.steps"
|
|
3278
3452
|
}
|
|
3279
3453
|
],
|
|
3280
3454
|
"flags": {
|
|
3281
3455
|
"json": {
|
|
3282
3456
|
"char": "j",
|
|
3283
|
-
"description": "Output
|
|
3457
|
+
"description": "Output the complete typed result as JSON",
|
|
3284
3458
|
"name": "json",
|
|
3285
3459
|
"required": false,
|
|
3286
3460
|
"allowNo": false,
|
|
@@ -3360,35 +3534,42 @@
|
|
|
3360
3534
|
"allowNo": false,
|
|
3361
3535
|
"type": "boolean"
|
|
3362
3536
|
},
|
|
3363
|
-
"
|
|
3364
|
-
"char": "
|
|
3365
|
-
"description": "
|
|
3366
|
-
"name": "
|
|
3537
|
+
"sys-id": {
|
|
3538
|
+
"char": "i",
|
|
3539
|
+
"description": "sys_id of the flow, subflow, or action to retrieve",
|
|
3540
|
+
"name": "sys-id",
|
|
3367
3541
|
"required": true,
|
|
3368
3542
|
"hasDynamicHelp": false,
|
|
3369
3543
|
"multiple": false,
|
|
3370
3544
|
"type": "option"
|
|
3371
3545
|
},
|
|
3372
|
-
"
|
|
3373
|
-
"
|
|
3374
|
-
"
|
|
3546
|
+
"type": {
|
|
3547
|
+
"char": "t",
|
|
3548
|
+
"description": "Artifact type to retrieve. Must match what the sys_id actually is.",
|
|
3549
|
+
"name": "type",
|
|
3375
3550
|
"required": false,
|
|
3551
|
+
"default": "flow",
|
|
3376
3552
|
"hasDynamicHelp": false,
|
|
3377
3553
|
"multiple": false,
|
|
3554
|
+
"options": [
|
|
3555
|
+
"flow",
|
|
3556
|
+
"subflow",
|
|
3557
|
+
"action"
|
|
3558
|
+
],
|
|
3378
3559
|
"type": "option"
|
|
3379
3560
|
},
|
|
3380
|
-
"
|
|
3381
|
-
"
|
|
3382
|
-
"
|
|
3383
|
-
"name": "include-definition",
|
|
3561
|
+
"scope": {
|
|
3562
|
+
"description": "Scope sys_id or name for the transaction scope parameter. Optional — ServiceNow resolves the artifact's own scope when omitted.",
|
|
3563
|
+
"name": "scope",
|
|
3384
3564
|
"required": false,
|
|
3385
|
-
"
|
|
3386
|
-
"
|
|
3565
|
+
"hasDynamicHelp": false,
|
|
3566
|
+
"multiple": false,
|
|
3567
|
+
"type": "option"
|
|
3387
3568
|
}
|
|
3388
3569
|
},
|
|
3389
3570
|
"hasDynamicHelp": false,
|
|
3390
3571
|
"hiddenAliases": [],
|
|
3391
|
-
"id": "flow:
|
|
3572
|
+
"id": "flow:definition",
|
|
3392
3573
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
3393
3574
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
3394
3575
|
"pluginType": "core",
|
|
@@ -3399,17 +3580,25 @@
|
|
|
3399
3580
|
"dist",
|
|
3400
3581
|
"commands",
|
|
3401
3582
|
"flow",
|
|
3402
|
-
"
|
|
3583
|
+
"definition.js"
|
|
3403
3584
|
]
|
|
3404
3585
|
},
|
|
3405
|
-
"flow:
|
|
3586
|
+
"flow:details": {
|
|
3406
3587
|
"aliases": [],
|
|
3407
3588
|
"args": {},
|
|
3408
|
-
"description": "
|
|
3589
|
+
"description": "Get rich execution details for a flow context.\n\nReturns per-action timing, inputs, outputs, and high-level metadata (state, runtime, who ran it, test vs production). This is the primary diagnostic command after flow test or flow run.\n\nUses the ProcessFlow operations API (GET /api/now/processflow/operations/flow/context/{id}), the same endpoint Flow Designer uses to display execution details.\n\nNOTE: Requires flow operations logging to be enabled on the instance. If the execution report is unavailable, a notice will explain why.\n\nTypical workflow:\n flow test → flow details → diagnose → modify flow → flow test again",
|
|
3409
3590
|
"examples": [
|
|
3410
3591
|
{
|
|
3411
|
-
"description": "Get
|
|
3412
|
-
"command": "<%= config.bin %> <%= command.id %> --context-id
|
|
3592
|
+
"description": "Get execution details after testing a flow",
|
|
3593
|
+
"command": "<%= config.bin %> <%= command.id %> --context-id d4e5f6789012345678abcdef01234567 --auth dev"
|
|
3594
|
+
},
|
|
3595
|
+
{
|
|
3596
|
+
"description": "Get details with explicit scope",
|
|
3597
|
+
"command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --scope x_myapp --auth dev"
|
|
3598
|
+
},
|
|
3599
|
+
{
|
|
3600
|
+
"description": "Get details with JSON output for scripting",
|
|
3601
|
+
"command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --json --auth dev"
|
|
3413
3602
|
}
|
|
3414
3603
|
],
|
|
3415
3604
|
"flags": {
|
|
@@ -3497,7 +3686,7 @@
|
|
|
3497
3686
|
},
|
|
3498
3687
|
"context-id": {
|
|
3499
3688
|
"char": "c",
|
|
3500
|
-
"description": "Flow
|
|
3689
|
+
"description": "Flow context sys_id returned by flow test, flow run, flow subflow, or flow action",
|
|
3501
3690
|
"name": "context-id",
|
|
3502
3691
|
"required": true,
|
|
3503
3692
|
"hasDynamicHelp": false,
|
|
@@ -3505,17 +3694,25 @@
|
|
|
3505
3694
|
"type": "option"
|
|
3506
3695
|
},
|
|
3507
3696
|
"scope": {
|
|
3508
|
-
"description": "Scope
|
|
3697
|
+
"description": "Scope sys_id for the ProcessFlow API transaction scope parameter",
|
|
3509
3698
|
"name": "scope",
|
|
3510
3699
|
"required": false,
|
|
3511
3700
|
"hasDynamicHelp": false,
|
|
3512
3701
|
"multiple": false,
|
|
3513
3702
|
"type": "option"
|
|
3703
|
+
},
|
|
3704
|
+
"include-definition": {
|
|
3705
|
+
"char": "d",
|
|
3706
|
+
"description": "Include the full flow definition snapshot in the response",
|
|
3707
|
+
"name": "include-definition",
|
|
3708
|
+
"required": false,
|
|
3709
|
+
"allowNo": false,
|
|
3710
|
+
"type": "boolean"
|
|
3514
3711
|
}
|
|
3515
3712
|
},
|
|
3516
3713
|
"hasDynamicHelp": false,
|
|
3517
3714
|
"hiddenAliases": [],
|
|
3518
|
-
"id": "flow:
|
|
3715
|
+
"id": "flow:details",
|
|
3519
3716
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
3520
3717
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
3521
3718
|
"pluginType": "core",
|
|
@@ -3526,25 +3723,17 @@
|
|
|
3526
3723
|
"dist",
|
|
3527
3724
|
"commands",
|
|
3528
3725
|
"flow",
|
|
3529
|
-
"
|
|
3726
|
+
"details.js"
|
|
3530
3727
|
]
|
|
3531
3728
|
},
|
|
3532
|
-
"flow:
|
|
3729
|
+
"flow:error": {
|
|
3533
3730
|
"aliases": [],
|
|
3534
3731
|
"args": {},
|
|
3535
|
-
"description": "Retrieve
|
|
3732
|
+
"description": "Retrieve error details from a failed flow execution.\n\nGets the error message from a flow context that ended in an error state.",
|
|
3536
3733
|
"examples": [
|
|
3537
3734
|
{
|
|
3538
|
-
"description": "Get flow
|
|
3539
|
-
"command": "<%= config.bin %> <%= command.id %> --context-id
|
|
3540
|
-
},
|
|
3541
|
-
{
|
|
3542
|
-
"description": "Get latest 10 log entries in reverse order",
|
|
3543
|
-
"command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --limit 10 --order desc --auth dev"
|
|
3544
|
-
},
|
|
3545
|
-
{
|
|
3546
|
-
"description": "Get logs with JSON output for scripting",
|
|
3547
|
-
"command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --json --auth dev"
|
|
3735
|
+
"description": "Get flow error details",
|
|
3736
|
+
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --auth dev"
|
|
3548
3737
|
}
|
|
3549
3738
|
],
|
|
3550
3739
|
"flags": {
|
|
@@ -3632,41 +3821,25 @@
|
|
|
3632
3821
|
},
|
|
3633
3822
|
"context-id": {
|
|
3634
3823
|
"char": "c",
|
|
3635
|
-
"description": "Flow context sys_id
|
|
3824
|
+
"description": "Flow execution context sys_id",
|
|
3636
3825
|
"name": "context-id",
|
|
3637
3826
|
"required": true,
|
|
3638
3827
|
"hasDynamicHelp": false,
|
|
3639
3828
|
"multiple": false,
|
|
3640
3829
|
"type": "option"
|
|
3641
3830
|
},
|
|
3642
|
-
"
|
|
3643
|
-
"
|
|
3644
|
-
"
|
|
3645
|
-
"name": "limit",
|
|
3646
|
-
"required": false,
|
|
3647
|
-
"default": 100,
|
|
3648
|
-
"hasDynamicHelp": false,
|
|
3649
|
-
"multiple": false,
|
|
3650
|
-
"type": "option"
|
|
3651
|
-
},
|
|
3652
|
-
"order": {
|
|
3653
|
-
"char": "o",
|
|
3654
|
-
"description": "Order direction: asc (oldest first) or desc (newest first)",
|
|
3655
|
-
"name": "order",
|
|
3831
|
+
"scope": {
|
|
3832
|
+
"description": "Scope context for script execution",
|
|
3833
|
+
"name": "scope",
|
|
3656
3834
|
"required": false,
|
|
3657
|
-
"default": "asc",
|
|
3658
3835
|
"hasDynamicHelp": false,
|
|
3659
3836
|
"multiple": false,
|
|
3660
|
-
"options": [
|
|
3661
|
-
"asc",
|
|
3662
|
-
"desc"
|
|
3663
|
-
],
|
|
3664
3837
|
"type": "option"
|
|
3665
3838
|
}
|
|
3666
3839
|
},
|
|
3667
3840
|
"hasDynamicHelp": false,
|
|
3668
3841
|
"hiddenAliases": [],
|
|
3669
|
-
"id": "flow:
|
|
3842
|
+
"id": "flow:error",
|
|
3670
3843
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
3671
3844
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
3672
3845
|
"pluginType": "core",
|
|
@@ -3677,21 +3850,25 @@
|
|
|
3677
3850
|
"dist",
|
|
3678
3851
|
"commands",
|
|
3679
3852
|
"flow",
|
|
3680
|
-
"
|
|
3853
|
+
"error.js"
|
|
3681
3854
|
]
|
|
3682
3855
|
},
|
|
3683
|
-
"flow:
|
|
3856
|
+
"flow:logs": {
|
|
3684
3857
|
"aliases": [],
|
|
3685
3858
|
"args": {},
|
|
3686
|
-
"description": "
|
|
3859
|
+
"description": "Retrieve flow execution log entries for a given context.\n\nLog entries include error messages, step-level debug output, and cancellation reasons. Use this alongside flow details to get the full picture of what happened during an execution.\n\nQueries sys_flow_log entries and maps numeric log levels to human-readable names (ERROR, WARN, INFO, DEBUG).\n\nNOTE: Log entries may be empty for simple successful executions, or if the flow reporting level is set to NONE. Errors and warnings are always logged regardless of the reporting level setting.",
|
|
3687
3860
|
"examples": [
|
|
3688
3861
|
{
|
|
3689
|
-
"description": "
|
|
3690
|
-
"command": "<%= config.bin %> <%= command.id %> --context-id
|
|
3862
|
+
"description": "Get flow execution logs",
|
|
3863
|
+
"command": "<%= config.bin %> <%= command.id %> --context-id d4e5f6789012345678abcdef01234567 --auth dev"
|
|
3691
3864
|
},
|
|
3692
3865
|
{
|
|
3693
|
-
"description": "
|
|
3694
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
3866
|
+
"description": "Get latest 10 log entries in reverse order",
|
|
3867
|
+
"command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --limit 10 --order desc --auth dev"
|
|
3868
|
+
},
|
|
3869
|
+
{
|
|
3870
|
+
"description": "Get logs with JSON output for scripting",
|
|
3871
|
+
"command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --json --auth dev"
|
|
3695
3872
|
}
|
|
3696
3873
|
],
|
|
3697
3874
|
"flags": {
|
|
@@ -3779,43 +3956,41 @@
|
|
|
3779
3956
|
},
|
|
3780
3957
|
"context-id": {
|
|
3781
3958
|
"char": "c",
|
|
3782
|
-
"description": "Flow
|
|
3959
|
+
"description": "Flow context sys_id returned by flow test, flow run, flow subflow, or flow action",
|
|
3783
3960
|
"name": "context-id",
|
|
3784
3961
|
"required": true,
|
|
3785
3962
|
"hasDynamicHelp": false,
|
|
3786
3963
|
"multiple": false,
|
|
3787
3964
|
"type": "option"
|
|
3788
3965
|
},
|
|
3789
|
-
"
|
|
3790
|
-
"char": "
|
|
3791
|
-
"description": "
|
|
3792
|
-
"name": "
|
|
3793
|
-
"required": true,
|
|
3794
|
-
"hasDynamicHelp": false,
|
|
3795
|
-
"multiple": false,
|
|
3796
|
-
"type": "option"
|
|
3797
|
-
},
|
|
3798
|
-
"payload": {
|
|
3799
|
-
"char": "p",
|
|
3800
|
-
"description": "Optional JSON payload to include with the message",
|
|
3801
|
-
"name": "payload",
|
|
3966
|
+
"limit": {
|
|
3967
|
+
"char": "l",
|
|
3968
|
+
"description": "Maximum number of log entries to return",
|
|
3969
|
+
"name": "limit",
|
|
3802
3970
|
"required": false,
|
|
3971
|
+
"default": 100,
|
|
3803
3972
|
"hasDynamicHelp": false,
|
|
3804
3973
|
"multiple": false,
|
|
3805
3974
|
"type": "option"
|
|
3806
3975
|
},
|
|
3807
|
-
"
|
|
3808
|
-
"
|
|
3809
|
-
"
|
|
3976
|
+
"order": {
|
|
3977
|
+
"char": "o",
|
|
3978
|
+
"description": "Order direction: asc (oldest first) or desc (newest first)",
|
|
3979
|
+
"name": "order",
|
|
3810
3980
|
"required": false,
|
|
3981
|
+
"default": "asc",
|
|
3811
3982
|
"hasDynamicHelp": false,
|
|
3812
3983
|
"multiple": false,
|
|
3984
|
+
"options": [
|
|
3985
|
+
"asc",
|
|
3986
|
+
"desc"
|
|
3987
|
+
],
|
|
3813
3988
|
"type": "option"
|
|
3814
3989
|
}
|
|
3815
3990
|
},
|
|
3816
3991
|
"hasDynamicHelp": false,
|
|
3817
3992
|
"hiddenAliases": [],
|
|
3818
|
-
"id": "flow:
|
|
3993
|
+
"id": "flow:logs",
|
|
3819
3994
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
3820
3995
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
3821
3996
|
"pluginType": "core",
|
|
@@ -3826,21 +4001,21 @@
|
|
|
3826
4001
|
"dist",
|
|
3827
4002
|
"commands",
|
|
3828
4003
|
"flow",
|
|
3829
|
-
"
|
|
4004
|
+
"logs.js"
|
|
3830
4005
|
]
|
|
3831
4006
|
},
|
|
3832
|
-
"flow:
|
|
4007
|
+
"flow:message": {
|
|
3833
4008
|
"aliases": [],
|
|
3834
4009
|
"args": {},
|
|
3835
|
-
"description": "
|
|
4010
|
+
"description": "Send a message to a paused flow execution.\n\nSends a message to a flow context that is in a WAITING state (e.g. waiting on a \"Wait for Message\" action). Supports an optional JSON payload.",
|
|
3836
4011
|
"examples": [
|
|
3837
4012
|
{
|
|
3838
|
-
"description": "
|
|
3839
|
-
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --auth dev"
|
|
4013
|
+
"description": "Send a message to resume a waiting flow",
|
|
4014
|
+
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --message \"approved\" --auth dev"
|
|
3840
4015
|
},
|
|
3841
4016
|
{
|
|
3842
|
-
"description": "
|
|
3843
|
-
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --
|
|
4017
|
+
"description": "Send a message with a JSON payload",
|
|
4018
|
+
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --message \"data_ready\" --payload '{\"status\":\"ok\"}' --auth dev"
|
|
3844
4019
|
}
|
|
3845
4020
|
],
|
|
3846
4021
|
"flags": {
|
|
@@ -3935,183 +4110,36 @@
|
|
|
3935
4110
|
"multiple": false,
|
|
3936
4111
|
"type": "option"
|
|
3937
4112
|
},
|
|
3938
|
-
"
|
|
3939
|
-
"
|
|
3940
|
-
"
|
|
3941
|
-
"
|
|
3942
|
-
"hasDynamicHelp": false,
|
|
3943
|
-
"multiple": false,
|
|
3944
|
-
"type": "option"
|
|
3945
|
-
}
|
|
3946
|
-
},
|
|
3947
|
-
"hasDynamicHelp": false,
|
|
3948
|
-
"hiddenAliases": [],
|
|
3949
|
-
"id": "flow:outputs",
|
|
3950
|
-
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
3951
|
-
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
3952
|
-
"pluginType": "core",
|
|
3953
|
-
"strict": true,
|
|
3954
|
-
"enableJsonFlag": true,
|
|
3955
|
-
"isESM": true,
|
|
3956
|
-
"relativePath": [
|
|
3957
|
-
"dist",
|
|
3958
|
-
"commands",
|
|
3959
|
-
"flow",
|
|
3960
|
-
"outputs.js"
|
|
3961
|
-
]
|
|
3962
|
-
},
|
|
3963
|
-
"flow:run": {
|
|
3964
|
-
"aliases": [],
|
|
3965
|
-
"args": {},
|
|
3966
|
-
"description": "Execute a published Flow Designer flow by scoped name.\n\nRuns a flow using the sn_fd.FlowAPI ScriptableFlowRunner. Supports foreground (synchronous) and background (asynchronous) execution modes.\n\nNote: This command requires the flow to be published. For testing flows that are not yet published (draft/saved state), use `flow test` instead.\n\nFeatures:\n • Execute flows by scoped name (e.g. global.my_flow)\n • Pass input values as JSON\n • Foreground or background execution mode\n • Quick mode to skip execution detail records\n • Returns context ID, outputs, and debug information",
|
|
3967
|
-
"examples": [
|
|
3968
|
-
{
|
|
3969
|
-
"description": "Run a flow in foreground mode",
|
|
3970
|
-
"command": "<%= config.bin %> <%= command.id %> --name global.my_flow --auth dev"
|
|
3971
|
-
},
|
|
3972
|
-
{
|
|
3973
|
-
"description": "Run with inputs",
|
|
3974
|
-
"command": "<%= config.bin %> <%= command.id %> --name global.my_flow --inputs '{\"record_sys_id\":\"abc123\"}' --auth dev"
|
|
3975
|
-
},
|
|
3976
|
-
{
|
|
3977
|
-
"description": "Run in background mode",
|
|
3978
|
-
"command": "<%= config.bin %> <%= command.id %> --name global.my_flow --mode background --auth dev"
|
|
3979
|
-
}
|
|
3980
|
-
],
|
|
3981
|
-
"flags": {
|
|
3982
|
-
"json": {
|
|
3983
|
-
"char": "j",
|
|
3984
|
-
"description": "Output results as JSON",
|
|
3985
|
-
"name": "json",
|
|
3986
|
-
"required": false,
|
|
3987
|
-
"allowNo": false,
|
|
3988
|
-
"type": "boolean"
|
|
3989
|
-
},
|
|
3990
|
-
"auth": {
|
|
3991
|
-
"char": "a",
|
|
3992
|
-
"description": "Auth alias to use.",
|
|
3993
|
-
"name": "auth",
|
|
3994
|
-
"required": false,
|
|
3995
|
-
"hasDynamicHelp": false,
|
|
3996
|
-
"multiple": false,
|
|
3997
|
-
"type": "option"
|
|
3998
|
-
},
|
|
3999
|
-
"cred-store": {
|
|
4000
|
-
"description": "Read credentials from @sonisoft/sn-credstore instead of the OS keyring. Use this in headless sessions (SSH, systemd, CI, agents) where the keyring cannot be unlocked.",
|
|
4001
|
-
"helpGroup": "GLOBAL",
|
|
4002
|
-
"name": "cred-store",
|
|
4003
|
-
"required": false,
|
|
4004
|
-
"allowNo": false,
|
|
4005
|
-
"type": "boolean"
|
|
4006
|
-
},
|
|
4007
|
-
"deny-execute": {
|
|
4008
|
-
"description": "Refuse background scripts, flow runs and ATF runs for this invocation.",
|
|
4009
|
-
"helpGroup": "GLOBAL",
|
|
4010
|
-
"name": "deny-execute",
|
|
4011
|
-
"required": false,
|
|
4012
|
-
"allowNo": false,
|
|
4013
|
-
"type": "boolean"
|
|
4014
|
-
},
|
|
4015
|
-
"deny-write": {
|
|
4016
|
-
"description": "Refuse any change to instance data for this invocation.",
|
|
4017
|
-
"helpGroup": "GLOBAL",
|
|
4018
|
-
"name": "deny-write",
|
|
4019
|
-
"required": false,
|
|
4020
|
-
"allowNo": false,
|
|
4021
|
-
"type": "boolean"
|
|
4022
|
-
},
|
|
4023
|
-
"log-dir": {
|
|
4024
|
-
"description": "Directory to write log files to. Implies --log-file.",
|
|
4025
|
-
"helpGroup": "GLOBAL",
|
|
4026
|
-
"name": "log-dir",
|
|
4027
|
-
"required": false,
|
|
4028
|
-
"hasDynamicHelp": false,
|
|
4029
|
-
"multiple": false,
|
|
4030
|
-
"type": "option"
|
|
4031
|
-
},
|
|
4032
|
-
"log-file": {
|
|
4033
|
-
"description": "Write logs to a file. Defaults to $XDG_STATE_HOME/now-sdk-ext/logs (~/.local/state/now-sdk-ext/logs). Off by default; without this, nex logs warnings and errors to stderr only.",
|
|
4034
|
-
"helpGroup": "GLOBAL",
|
|
4035
|
-
"name": "log-file",
|
|
4036
|
-
"required": false,
|
|
4037
|
-
"allowNo": false,
|
|
4038
|
-
"type": "boolean"
|
|
4039
|
-
},
|
|
4040
|
-
"log-level": {
|
|
4041
|
-
"helpGroup": "GLOBAL",
|
|
4042
|
-
"name": "log-level",
|
|
4043
|
-
"summary": "Specify level for logging.",
|
|
4044
|
-
"default": "info",
|
|
4045
|
-
"hasDynamicHelp": false,
|
|
4046
|
-
"multiple": false,
|
|
4047
|
-
"options": [
|
|
4048
|
-
"debug",
|
|
4049
|
-
"warn",
|
|
4050
|
-
"error",
|
|
4051
|
-
"info",
|
|
4052
|
-
"trace"
|
|
4053
|
-
],
|
|
4054
|
-
"type": "option"
|
|
4055
|
-
},
|
|
4056
|
-
"read-only": {
|
|
4057
|
-
"description": "Refuse every change to the instance — equivalent to --deny-write --deny-execute. Reads are unaffected.",
|
|
4058
|
-
"helpGroup": "GLOBAL",
|
|
4059
|
-
"name": "read-only",
|
|
4060
|
-
"required": false,
|
|
4061
|
-
"allowNo": false,
|
|
4062
|
-
"type": "boolean"
|
|
4063
|
-
},
|
|
4064
|
-
"name": {
|
|
4065
|
-
"char": "n",
|
|
4066
|
-
"description": "Scoped name of the flow (e.g. global.my_flow)",
|
|
4067
|
-
"name": "name",
|
|
4113
|
+
"message": {
|
|
4114
|
+
"char": "m",
|
|
4115
|
+
"description": "Message to send to the flow",
|
|
4116
|
+
"name": "message",
|
|
4068
4117
|
"required": true,
|
|
4069
4118
|
"hasDynamicHelp": false,
|
|
4070
4119
|
"multiple": false,
|
|
4071
4120
|
"type": "option"
|
|
4072
4121
|
},
|
|
4073
|
-
"
|
|
4074
|
-
"char": "
|
|
4075
|
-
"description": "JSON
|
|
4076
|
-
"name": "
|
|
4077
|
-
"required": false,
|
|
4078
|
-
"hasDynamicHelp": false,
|
|
4079
|
-
"multiple": false,
|
|
4080
|
-
"type": "option"
|
|
4081
|
-
},
|
|
4082
|
-
"mode": {
|
|
4083
|
-
"char": "m",
|
|
4084
|
-
"description": "Execution mode",
|
|
4085
|
-
"name": "mode",
|
|
4122
|
+
"payload": {
|
|
4123
|
+
"char": "p",
|
|
4124
|
+
"description": "Optional JSON payload to include with the message",
|
|
4125
|
+
"name": "payload",
|
|
4086
4126
|
"required": false,
|
|
4087
|
-
"default": "foreground",
|
|
4088
4127
|
"hasDynamicHelp": false,
|
|
4089
4128
|
"multiple": false,
|
|
4090
|
-
"options": [
|
|
4091
|
-
"foreground",
|
|
4092
|
-
"background"
|
|
4093
|
-
],
|
|
4094
4129
|
"type": "option"
|
|
4095
4130
|
},
|
|
4096
4131
|
"scope": {
|
|
4097
|
-
"description": "Scope context for script execution
|
|
4132
|
+
"description": "Scope context for script execution",
|
|
4098
4133
|
"name": "scope",
|
|
4099
4134
|
"required": false,
|
|
4100
4135
|
"hasDynamicHelp": false,
|
|
4101
4136
|
"multiple": false,
|
|
4102
4137
|
"type": "option"
|
|
4103
|
-
},
|
|
4104
|
-
"quick": {
|
|
4105
|
-
"description": "Skip execution detail records for better performance",
|
|
4106
|
-
"name": "quick",
|
|
4107
|
-
"required": false,
|
|
4108
|
-
"allowNo": false,
|
|
4109
|
-
"type": "boolean"
|
|
4110
4138
|
}
|
|
4111
4139
|
},
|
|
4112
4140
|
"hasDynamicHelp": false,
|
|
4113
4141
|
"hiddenAliases": [],
|
|
4114
|
-
"id": "flow:
|
|
4142
|
+
"id": "flow:message",
|
|
4115
4143
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
4116
4144
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
4117
4145
|
"pluginType": "core",
|
|
@@ -4122,17 +4150,21 @@
|
|
|
4122
4150
|
"dist",
|
|
4123
4151
|
"commands",
|
|
4124
4152
|
"flow",
|
|
4125
|
-
"
|
|
4153
|
+
"message.js"
|
|
4126
4154
|
]
|
|
4127
4155
|
},
|
|
4128
|
-
"flow:
|
|
4156
|
+
"flow:outputs": {
|
|
4129
4157
|
"aliases": [],
|
|
4130
4158
|
"args": {},
|
|
4131
|
-
"description": "
|
|
4159
|
+
"description": "Retrieve outputs from a completed flow execution.\n\nGets the output name-value pairs from a flow, subflow, or action execution context.",
|
|
4132
4160
|
"examples": [
|
|
4133
4161
|
{
|
|
4134
|
-
"description": "
|
|
4162
|
+
"description": "Get flow outputs",
|
|
4135
4163
|
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --auth dev"
|
|
4164
|
+
},
|
|
4165
|
+
{
|
|
4166
|
+
"description": "Get outputs as JSON",
|
|
4167
|
+
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --json --auth dev"
|
|
4136
4168
|
}
|
|
4137
4169
|
],
|
|
4138
4170
|
"flags": {
|
|
@@ -4238,7 +4270,7 @@
|
|
|
4238
4270
|
},
|
|
4239
4271
|
"hasDynamicHelp": false,
|
|
4240
4272
|
"hiddenAliases": [],
|
|
4241
|
-
"id": "flow:
|
|
4273
|
+
"id": "flow:outputs",
|
|
4242
4274
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
4243
4275
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
4244
4276
|
"pluginType": "core",
|
|
@@ -4249,21 +4281,25 @@
|
|
|
4249
4281
|
"dist",
|
|
4250
4282
|
"commands",
|
|
4251
4283
|
"flow",
|
|
4252
|
-
"
|
|
4284
|
+
"outputs.js"
|
|
4253
4285
|
]
|
|
4254
4286
|
},
|
|
4255
|
-
"flow:
|
|
4287
|
+
"flow:run": {
|
|
4256
4288
|
"aliases": [],
|
|
4257
4289
|
"args": {},
|
|
4258
|
-
"description": "Execute a published Flow Designer
|
|
4290
|
+
"description": "Execute a published Flow Designer flow by scoped name.\n\nRuns a flow using the sn_fd.FlowAPI ScriptableFlowRunner. Supports foreground (synchronous) and background (asynchronous) execution modes.\n\nNote: This command requires the flow to be published. For testing flows that are not yet published (draft/saved state), use `flow test` instead.\n\nFeatures:\n • Execute flows by scoped name (e.g. global.my_flow)\n • Pass input values as JSON\n • Foreground or background execution mode\n • Quick mode to skip execution detail records\n • Returns context ID, outputs, and debug information",
|
|
4259
4291
|
"examples": [
|
|
4260
4292
|
{
|
|
4261
|
-
"description": "Run a
|
|
4262
|
-
"command": "<%= config.bin %> <%= command.id %> --name global.
|
|
4293
|
+
"description": "Run a flow in foreground mode",
|
|
4294
|
+
"command": "<%= config.bin %> <%= command.id %> --name global.my_flow --auth dev"
|
|
4263
4295
|
},
|
|
4264
4296
|
{
|
|
4265
4297
|
"description": "Run with inputs",
|
|
4266
|
-
"command": "<%= config.bin %> <%= command.id %> --name
|
|
4298
|
+
"command": "<%= config.bin %> <%= command.id %> --name global.my_flow --inputs '{\"record_sys_id\":\"abc123\"}' --auth dev"
|
|
4299
|
+
},
|
|
4300
|
+
{
|
|
4301
|
+
"description": "Run in background mode",
|
|
4302
|
+
"command": "<%= config.bin %> <%= command.id %> --name global.my_flow --mode background --auth dev"
|
|
4267
4303
|
}
|
|
4268
4304
|
],
|
|
4269
4305
|
"flags": {
|
|
@@ -4351,7 +4387,7 @@
|
|
|
4351
4387
|
},
|
|
4352
4388
|
"name": {
|
|
4353
4389
|
"char": "n",
|
|
4354
|
-
"description": "Scoped name of the
|
|
4390
|
+
"description": "Scoped name of the flow (e.g. global.my_flow)",
|
|
4355
4391
|
"name": "name",
|
|
4356
4392
|
"required": true,
|
|
4357
4393
|
"hasDynamicHelp": false,
|
|
@@ -4382,7 +4418,7 @@
|
|
|
4382
4418
|
"type": "option"
|
|
4383
4419
|
},
|
|
4384
4420
|
"scope": {
|
|
4385
|
-
"description": "Scope context for script execution",
|
|
4421
|
+
"description": "Scope context for script execution (e.g. global, x_myapp)",
|
|
4386
4422
|
"name": "scope",
|
|
4387
4423
|
"required": false,
|
|
4388
4424
|
"hasDynamicHelp": false,
|
|
@@ -4399,7 +4435,7 @@
|
|
|
4399
4435
|
},
|
|
4400
4436
|
"hasDynamicHelp": false,
|
|
4401
4437
|
"hiddenAliases": [],
|
|
4402
|
-
"id": "flow:
|
|
4438
|
+
"id": "flow:run",
|
|
4403
4439
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
4404
4440
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
4405
4441
|
"pluginType": "core",
|
|
@@ -4410,25 +4446,17 @@
|
|
|
4410
4446
|
"dist",
|
|
4411
4447
|
"commands",
|
|
4412
4448
|
"flow",
|
|
4413
|
-
"
|
|
4449
|
+
"run.js"
|
|
4414
4450
|
]
|
|
4415
4451
|
},
|
|
4416
|
-
"flow:
|
|
4452
|
+
"flow:status": {
|
|
4417
4453
|
"aliases": [],
|
|
4418
4454
|
"args": {},
|
|
4419
|
-
"description": "
|
|
4455
|
+
"description": "Get the status of a flow execution context.\n\nQueries sys_flow_context to retrieve the current state of a flow execution.\n\nPossible states: QUEUED, IN_PROGRESS, WAITING, COMPLETE, CANCELLED, ERROR",
|
|
4420
4456
|
"examples": [
|
|
4421
4457
|
{
|
|
4422
|
-
"description": "
|
|
4423
|
-
"command": "<%= config.bin %> <%= command.id %> --
|
|
4424
|
-
},
|
|
4425
|
-
{
|
|
4426
|
-
"description": "Test a flow by scoped name with explicit scope",
|
|
4427
|
-
"command": "<%= config.bin %> <%= command.id %> -f x_myapp.my_flow -o '{\"current\":\"abc123\",\"table_name\":\"incident\"}' --scope x_myapp --auth dev"
|
|
4428
|
-
},
|
|
4429
|
-
{
|
|
4430
|
-
"description": "Test with JSON output",
|
|
4431
|
-
"command": "<%= config.bin %> <%= command.id %> -f 887dda5583237210fdb8f7b6feaad32c -o '{\"current\":\"abc123\"}' --json --auth dev"
|
|
4458
|
+
"description": "Check flow execution status",
|
|
4459
|
+
"command": "<%= config.bin %> <%= command.id %> --context-id abc123def456 --auth dev"
|
|
4432
4460
|
}
|
|
4433
4461
|
],
|
|
4434
4462
|
"flags": {
|
|
@@ -4514,43 +4542,27 @@
|
|
|
4514
4542
|
"allowNo": false,
|
|
4515
4543
|
"type": "boolean"
|
|
4516
4544
|
},
|
|
4517
|
-
"
|
|
4518
|
-
"char": "
|
|
4519
|
-
"description": "Flow
|
|
4520
|
-
"name": "
|
|
4521
|
-
"required": true,
|
|
4522
|
-
"hasDynamicHelp": false,
|
|
4523
|
-
"multiple": false,
|
|
4524
|
-
"type": "option"
|
|
4525
|
-
},
|
|
4526
|
-
"output-map": {
|
|
4527
|
-
"char": "o",
|
|
4528
|
-
"description": "JSON mapping of trigger output variable names to test values (e.g. '{\"current\":\"<sys_id>\",\"table_name\":\"change_request\"}')",
|
|
4529
|
-
"name": "output-map",
|
|
4545
|
+
"context-id": {
|
|
4546
|
+
"char": "c",
|
|
4547
|
+
"description": "Flow execution context sys_id",
|
|
4548
|
+
"name": "context-id",
|
|
4530
4549
|
"required": true,
|
|
4531
4550
|
"hasDynamicHelp": false,
|
|
4532
4551
|
"multiple": false,
|
|
4533
4552
|
"type": "option"
|
|
4534
4553
|
},
|
|
4535
4554
|
"scope": {
|
|
4536
|
-
"description": "Scope
|
|
4555
|
+
"description": "Scope context for script execution",
|
|
4537
4556
|
"name": "scope",
|
|
4538
4557
|
"required": false,
|
|
4539
4558
|
"hasDynamicHelp": false,
|
|
4540
4559
|
"multiple": false,
|
|
4541
4560
|
"type": "option"
|
|
4542
|
-
},
|
|
4543
|
-
"synchronous": {
|
|
4544
|
-
"description": "Run test synchronously (default: true)",
|
|
4545
|
-
"name": "synchronous",
|
|
4546
|
-
"required": false,
|
|
4547
|
-
"allowNo": true,
|
|
4548
|
-
"type": "boolean"
|
|
4549
4561
|
}
|
|
4550
4562
|
},
|
|
4551
4563
|
"hasDynamicHelp": false,
|
|
4552
4564
|
"hiddenAliases": [],
|
|
4553
|
-
"id": "flow:
|
|
4565
|
+
"id": "flow:status",
|
|
4554
4566
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
4555
4567
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
4556
4568
|
"pluginType": "core",
|
|
@@ -4561,29 +4573,21 @@
|
|
|
4561
4573
|
"dist",
|
|
4562
4574
|
"commands",
|
|
4563
4575
|
"flow",
|
|
4564
|
-
"
|
|
4576
|
+
"status.js"
|
|
4565
4577
|
]
|
|
4566
4578
|
},
|
|
4567
|
-
"
|
|
4579
|
+
"flow:subflow": {
|
|
4568
4580
|
"aliases": [],
|
|
4569
4581
|
"args": {},
|
|
4570
|
-
"description": "
|
|
4582
|
+
"description": "Execute a published Flow Designer subflow by scoped name.\n\nRuns a subflow using the sn_fd.FlowAPI ScriptableFlowRunner.\n\nNote: This command requires the subflow to be published. For testing flows that are not yet published (draft/saved state), use `flow test` instead.\n\nFeatures:\n • Execute subflows by scoped name\n • Pass input values as JSON\n • Foreground or background execution mode\n • Returns context ID, outputs, and debug information",
|
|
4571
4583
|
"examples": [
|
|
4572
4584
|
{
|
|
4573
|
-
"description": "Run
|
|
4574
|
-
"command": "<%= config.bin %> <%= command.id %> --auth dev"
|
|
4575
|
-
},
|
|
4576
|
-
{
|
|
4577
|
-
"description": "Check only version and stuck jobs",
|
|
4578
|
-
"command": "<%= config.bin %> <%= command.id %> --include-version --include-stuck-jobs --no-include-cluster --no-include-semaphores --no-include-operational-counts --auth dev"
|
|
4579
|
-
},
|
|
4580
|
-
{
|
|
4581
|
-
"description": "Health check with custom stuck job threshold",
|
|
4582
|
-
"command": "<%= config.bin %> <%= command.id %> --stuck-job-threshold 60 --auth dev"
|
|
4585
|
+
"description": "Run a subflow",
|
|
4586
|
+
"command": "<%= config.bin %> <%= command.id %> --name global.my_subflow --auth dev"
|
|
4583
4587
|
},
|
|
4584
4588
|
{
|
|
4585
|
-
"description": "
|
|
4586
|
-
"command": "<%= config.bin %> <%= command.id %> --
|
|
4589
|
+
"description": "Run with inputs",
|
|
4590
|
+
"command": "<%= config.bin %> <%= command.id %> --name x_myapp.process_record --inputs '{\"table\":\"incident\",\"sys_id\":\"abc123\"}' --auth dev"
|
|
4587
4591
|
}
|
|
4588
4592
|
],
|
|
4589
4593
|
"flags": {
|
|
@@ -4669,54 +4673,57 @@
|
|
|
4669
4673
|
"allowNo": false,
|
|
4670
4674
|
"type": "boolean"
|
|
4671
4675
|
},
|
|
4672
|
-
"
|
|
4673
|
-
"
|
|
4674
|
-
"
|
|
4675
|
-
"
|
|
4676
|
-
"
|
|
4677
|
-
"
|
|
4678
|
-
|
|
4679
|
-
|
|
4680
|
-
"description": "Include cluster node status",
|
|
4681
|
-
"name": "include-cluster",
|
|
4682
|
-
"required": false,
|
|
4683
|
-
"allowNo": true,
|
|
4684
|
-
"type": "boolean"
|
|
4685
|
-
},
|
|
4686
|
-
"include-stuck-jobs": {
|
|
4687
|
-
"description": "Include stuck job detection",
|
|
4688
|
-
"name": "include-stuck-jobs",
|
|
4689
|
-
"required": false,
|
|
4690
|
-
"allowNo": true,
|
|
4691
|
-
"type": "boolean"
|
|
4676
|
+
"name": {
|
|
4677
|
+
"char": "n",
|
|
4678
|
+
"description": "Scoped name of the subflow (e.g. global.my_subflow)",
|
|
4679
|
+
"name": "name",
|
|
4680
|
+
"required": true,
|
|
4681
|
+
"hasDynamicHelp": false,
|
|
4682
|
+
"multiple": false,
|
|
4683
|
+
"type": "option"
|
|
4692
4684
|
},
|
|
4693
|
-
"
|
|
4694
|
-
"
|
|
4695
|
-
"
|
|
4685
|
+
"inputs": {
|
|
4686
|
+
"char": "i",
|
|
4687
|
+
"description": "JSON object of input name-value pairs",
|
|
4688
|
+
"name": "inputs",
|
|
4696
4689
|
"required": false,
|
|
4697
|
-
"
|
|
4698
|
-
"
|
|
4690
|
+
"hasDynamicHelp": false,
|
|
4691
|
+
"multiple": false,
|
|
4692
|
+
"type": "option"
|
|
4699
4693
|
},
|
|
4700
|
-
"
|
|
4701
|
-
"
|
|
4702
|
-
"
|
|
4694
|
+
"mode": {
|
|
4695
|
+
"char": "m",
|
|
4696
|
+
"description": "Execution mode",
|
|
4697
|
+
"name": "mode",
|
|
4703
4698
|
"required": false,
|
|
4704
|
-
"
|
|
4705
|
-
"
|
|
4699
|
+
"default": "foreground",
|
|
4700
|
+
"hasDynamicHelp": false,
|
|
4701
|
+
"multiple": false,
|
|
4702
|
+
"options": [
|
|
4703
|
+
"foreground",
|
|
4704
|
+
"background"
|
|
4705
|
+
],
|
|
4706
|
+
"type": "option"
|
|
4706
4707
|
},
|
|
4707
|
-
"
|
|
4708
|
-
"description": "
|
|
4709
|
-
"name": "
|
|
4708
|
+
"scope": {
|
|
4709
|
+
"description": "Scope context for script execution",
|
|
4710
|
+
"name": "scope",
|
|
4710
4711
|
"required": false,
|
|
4711
|
-
"default": 30,
|
|
4712
4712
|
"hasDynamicHelp": false,
|
|
4713
4713
|
"multiple": false,
|
|
4714
4714
|
"type": "option"
|
|
4715
|
+
},
|
|
4716
|
+
"quick": {
|
|
4717
|
+
"description": "Skip execution detail records for better performance",
|
|
4718
|
+
"name": "quick",
|
|
4719
|
+
"required": false,
|
|
4720
|
+
"allowNo": false,
|
|
4721
|
+
"type": "boolean"
|
|
4715
4722
|
}
|
|
4716
4723
|
},
|
|
4717
4724
|
"hasDynamicHelp": false,
|
|
4718
4725
|
"hiddenAliases": [],
|
|
4719
|
-
"id": "
|
|
4726
|
+
"id": "flow:subflow",
|
|
4720
4727
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
4721
4728
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
4722
4729
|
"pluginType": "core",
|
|
@@ -4725,54 +4732,35 @@
|
|
|
4725
4732
|
"isESM": true,
|
|
4726
4733
|
"relativePath": [
|
|
4727
4734
|
"dist",
|
|
4728
|
-
"commands",
|
|
4729
|
-
"
|
|
4730
|
-
"
|
|
4735
|
+
"commands",
|
|
4736
|
+
"flow",
|
|
4737
|
+
"subflow.js"
|
|
4731
4738
|
]
|
|
4732
4739
|
},
|
|
4733
|
-
"
|
|
4740
|
+
"flow:test": {
|
|
4734
4741
|
"aliases": [],
|
|
4735
4742
|
"args": {},
|
|
4736
|
-
"description": "
|
|
4743
|
+
"description": "Test a Flow Designer flow without requiring it to be published.\n\nInvokes the same API as the \"Test\" button in Flow Designer, running the flow in its current saved (draft) state. Unlike `flow run` which requires a published flow and uses sn_fd.FlowAPI, `flow test` works on unpublished drafts via the ProcessFlow REST API.\n\nFeatures:\n • Test flows by sys_id or scoped name\n • Pass trigger output values as JSON via --output-map\n • Auto-resolves scope from flow definition if not provided\n • Synchronous or asynchronous execution",
|
|
4737
4744
|
"examples": [
|
|
4738
4745
|
{
|
|
4739
|
-
"description": "
|
|
4740
|
-
"command": "<%= config.bin %> <%= command.id %> --auth dev
|
|
4741
|
-
},
|
|
4742
|
-
{
|
|
4743
|
-
"description": "Tail logs and save to a file",
|
|
4744
|
-
"command": "<%= config.bin %> <%= command.id %> --output ./logs/instance-logs.txt --auth dev-instance"
|
|
4745
|
-
},
|
|
4746
|
-
{
|
|
4747
|
-
"description": "Tail logs with custom polling interval (500ms for faster updates)",
|
|
4748
|
-
"command": "<%= config.bin %> <%= command.id %> --interval 500 --auth dev-instance"
|
|
4749
|
-
},
|
|
4750
|
-
{
|
|
4751
|
-
"description": "Filter logs containing specific text (case-insensitive)",
|
|
4752
|
-
"command": "<%= config.bin %> <%= command.id %> --filter \"message CONTAINS_CI error\" --auth dev-instance"
|
|
4753
|
-
},
|
|
4754
|
-
{
|
|
4755
|
-
"description": "Filter logs with multiple conditions (AND logic)",
|
|
4756
|
-
"command": "<%= config.bin %> <%= command.id %> --filter \"message CONTAINS x_acme_app\" --filter \"message CONTAINS error\" --auth dev-instance"
|
|
4757
|
-
},
|
|
4758
|
-
{
|
|
4759
|
-
"description": "Filter logs using regex pattern",
|
|
4760
|
-
"command": "<%= config.bin %> <%= command.id %> --filter \"message REGEX .*exception.*\" --auth dev-instance"
|
|
4746
|
+
"description": "Test a flow by sys_id",
|
|
4747
|
+
"command": "<%= config.bin %> <%= command.id %> --flow-id 887dda5583237210fdb8f7b6feaad32c --output-map '{\"current\":\"0ecd7552db252200a6a2b31be0b8f5e6\",\"table_name\":\"change_request\"}' --auth dev"
|
|
4761
4748
|
},
|
|
4762
4749
|
{
|
|
4763
|
-
"description": "
|
|
4764
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
4750
|
+
"description": "Test a flow by scoped name with explicit scope",
|
|
4751
|
+
"command": "<%= config.bin %> <%= command.id %> -f x_myapp.my_flow -o '{\"current\":\"abc123\",\"table_name\":\"incident\"}' --scope x_myapp --auth dev"
|
|
4765
4752
|
},
|
|
4766
4753
|
{
|
|
4767
|
-
"description": "
|
|
4768
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
4754
|
+
"description": "Test with JSON output",
|
|
4755
|
+
"command": "<%= config.bin %> <%= command.id %> -f 887dda5583237210fdb8f7b6feaad32c -o '{\"current\":\"abc123\"}' --json --auth dev"
|
|
4769
4756
|
}
|
|
4770
4757
|
],
|
|
4771
4758
|
"flags": {
|
|
4772
4759
|
"json": {
|
|
4773
|
-
"
|
|
4774
|
-
"
|
|
4760
|
+
"char": "j",
|
|
4761
|
+
"description": "Output results as JSON",
|
|
4775
4762
|
"name": "json",
|
|
4763
|
+
"required": false,
|
|
4776
4764
|
"allowNo": false,
|
|
4777
4765
|
"type": "boolean"
|
|
4778
4766
|
},
|
|
@@ -4850,45 +4838,43 @@
|
|
|
4850
4838
|
"allowNo": false,
|
|
4851
4839
|
"type": "boolean"
|
|
4852
4840
|
},
|
|
4853
|
-
"
|
|
4841
|
+
"flow-id": {
|
|
4842
|
+
"char": "f",
|
|
4843
|
+
"description": "Flow sys_id or scoped name (e.g. x_myapp.my_flow)",
|
|
4844
|
+
"name": "flow-id",
|
|
4845
|
+
"required": true,
|
|
4846
|
+
"hasDynamicHelp": false,
|
|
4847
|
+
"multiple": false,
|
|
4848
|
+
"type": "option"
|
|
4849
|
+
},
|
|
4850
|
+
"output-map": {
|
|
4854
4851
|
"char": "o",
|
|
4855
|
-
"description": "
|
|
4856
|
-
"name": "output",
|
|
4857
|
-
"required":
|
|
4852
|
+
"description": "JSON mapping of trigger output variable names to test values (e.g. '{\"current\":\"<sys_id>\",\"table_name\":\"change_request\"}')",
|
|
4853
|
+
"name": "output-map",
|
|
4854
|
+
"required": true,
|
|
4858
4855
|
"hasDynamicHelp": false,
|
|
4859
4856
|
"multiple": false,
|
|
4860
4857
|
"type": "option"
|
|
4861
4858
|
},
|
|
4862
|
-
"
|
|
4863
|
-
"
|
|
4864
|
-
"
|
|
4865
|
-
"name": "interval",
|
|
4859
|
+
"scope": {
|
|
4860
|
+
"description": "Scope sys_id for transaction scope (auto-resolved from flow definition if omitted)",
|
|
4861
|
+
"name": "scope",
|
|
4866
4862
|
"required": false,
|
|
4867
|
-
"default": 1000,
|
|
4868
4863
|
"hasDynamicHelp": false,
|
|
4869
4864
|
"multiple": false,
|
|
4870
4865
|
"type": "option"
|
|
4871
4866
|
},
|
|
4872
|
-
"
|
|
4873
|
-
"description": "
|
|
4874
|
-
"name": "
|
|
4867
|
+
"synchronous": {
|
|
4868
|
+
"description": "Run test synchronously (default: true)",
|
|
4869
|
+
"name": "synchronous",
|
|
4875
4870
|
"required": false,
|
|
4876
|
-
"allowNo":
|
|
4871
|
+
"allowNo": true,
|
|
4877
4872
|
"type": "boolean"
|
|
4878
|
-
},
|
|
4879
|
-
"filter": {
|
|
4880
|
-
"char": "f",
|
|
4881
|
-
"description": "Filter logs by field and value. Syntax: field OPERATOR value. Operators: CONTAINS, CONTAINS_CI (case-insensitive), EQUALS, EQUALS_CI, STARTS_WITH, STARTS_WITH_CI, ENDS_WITH, ENDS_WITH_CI, REGEX, NOT_CONTAINS, NOT_EQUALS. Field defaults to \"message\" if omitted. Multiple filters are combined with AND logic.",
|
|
4882
|
-
"name": "filter",
|
|
4883
|
-
"required": false,
|
|
4884
|
-
"hasDynamicHelp": false,
|
|
4885
|
-
"multiple": true,
|
|
4886
|
-
"type": "option"
|
|
4887
4873
|
}
|
|
4888
4874
|
},
|
|
4889
4875
|
"hasDynamicHelp": false,
|
|
4890
4876
|
"hiddenAliases": [],
|
|
4891
|
-
"id": "
|
|
4877
|
+
"id": "flow:test",
|
|
4892
4878
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
4893
4879
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
4894
4880
|
"pluginType": "core",
|
|
@@ -4898,8 +4884,8 @@
|
|
|
4898
4884
|
"relativePath": [
|
|
4899
4885
|
"dist",
|
|
4900
4886
|
"commands",
|
|
4901
|
-
"
|
|
4902
|
-
"
|
|
4887
|
+
"flow",
|
|
4888
|
+
"test.js"
|
|
4903
4889
|
]
|
|
4904
4890
|
},
|
|
4905
4891
|
"policy:status": {
|
|
@@ -5938,22 +5924,42 @@
|
|
|
5938
5924
|
"validate-catalog.js"
|
|
5939
5925
|
]
|
|
5940
5926
|
},
|
|
5941
|
-
"
|
|
5927
|
+
"log": {
|
|
5942
5928
|
"aliases": [],
|
|
5943
5929
|
"args": {},
|
|
5944
|
-
"description": "
|
|
5930
|
+
"description": "Tail and monitor ServiceNow system logs in real-time with beautiful formatting.\n\nThis command provides real-time log monitoring with enhanced visual formatting using color-coded output that makes logs easy to scan and understand at a glance. Automatically highlights errors, warnings, success messages, and important keywords.\n\nKey Features:\n • Real-time log tailing (like Unix tail -f)\n • Powerful filtering with multiple operators (CONTAINS, REGEX, EQUALS, etc.)\n • Smart keyword highlighting (errors in red, warnings in yellow, etc.)\n • Beautiful color-coded console output with chalk\n • Export logs to file with automatic appending\n • Fast 1-second default polling interval\n • Timestamps and sequence numbers for each log\n • Graceful shutdown with Ctrl+C\n • Clean output without colors (--no-color flag)\n\nSmart Highlighting:\n • Error terms (error, exception, failed) - highlighted in RED\n • Warning terms (warn, warning, deprecated) - highlighted in YELLOW\n • Success terms (success, completed, done) - highlighted in GREEN\n • System terms (system, user, transaction) - highlighted in BLUE\n\nFiltering:\n • Apply filters using --filter flag with syntax: \"field OPERATOR value\"\n • Supports case-sensitive and case-insensitive operations\n • Multiple filters are combined with AND logic\n • Operators: CONTAINS, CONTAINS_CI, EQUALS, EQUALS_CI, STARTS_WITH, STARTS_WITH_CI,\n ENDS_WITH, ENDS_WITH_CI, REGEX, NOT_CONTAINS, NOT_CONTAINS_CI, NOT_EQUALS, NOT_EQUALS_CI\n\nUse Cases:\n • Monitor logs during application development\n • Debug issues in real-time\n • Track system events during deployments\n • Filter logs for specific application or component\n • Quickly spot errors and warnings\n • Collect logs for analysis or audit trails\n\n⚠️ IMPORTANT NOTES:\n • Press Ctrl+C to stop tailing and exit gracefully\n • Log files are created/appended automatically\n • Uses ChannelAjax when available for better performance\n • Default poll interval is 1 second for real-time monitoring",
|
|
5945
5931
|
"examples": [
|
|
5946
5932
|
{
|
|
5947
|
-
"
|
|
5948
|
-
"
|
|
5933
|
+
"description": "Tail all logs in real-time",
|
|
5934
|
+
"command": "<%= config.bin %> <%= command.id %> --auth dev-instance"
|
|
5949
5935
|
},
|
|
5950
5936
|
{
|
|
5951
|
-
"
|
|
5952
|
-
"
|
|
5937
|
+
"description": "Tail logs and save to a file",
|
|
5938
|
+
"command": "<%= config.bin %> <%= command.id %> --output ./logs/instance-logs.txt --auth dev-instance"
|
|
5953
5939
|
},
|
|
5954
5940
|
{
|
|
5955
|
-
"
|
|
5956
|
-
"
|
|
5941
|
+
"description": "Tail logs with custom polling interval (500ms for faster updates)",
|
|
5942
|
+
"command": "<%= config.bin %> <%= command.id %> --interval 500 --auth dev-instance"
|
|
5943
|
+
},
|
|
5944
|
+
{
|
|
5945
|
+
"description": "Filter logs containing specific text (case-insensitive)",
|
|
5946
|
+
"command": "<%= config.bin %> <%= command.id %> --filter \"message CONTAINS_CI error\" --auth dev-instance"
|
|
5947
|
+
},
|
|
5948
|
+
{
|
|
5949
|
+
"description": "Filter logs with multiple conditions (AND logic)",
|
|
5950
|
+
"command": "<%= config.bin %> <%= command.id %> --filter \"message CONTAINS x_acme_app\" --filter \"message CONTAINS error\" --auth dev-instance"
|
|
5951
|
+
},
|
|
5952
|
+
{
|
|
5953
|
+
"description": "Filter logs using regex pattern",
|
|
5954
|
+
"command": "<%= config.bin %> <%= command.id %> --filter \"message REGEX .*exception.*\" --auth dev-instance"
|
|
5955
|
+
},
|
|
5956
|
+
{
|
|
5957
|
+
"description": "Filter logs by message starting with a pattern",
|
|
5958
|
+
"command": "<%= config.bin %> <%= command.id %> --filter \"message STARTS_WITH [ERROR]\" --auth dev-instance"
|
|
5959
|
+
},
|
|
5960
|
+
{
|
|
5961
|
+
"description": "Tail logs without colored output",
|
|
5962
|
+
"command": "<%= config.bin %> <%= command.id %> --no-color --auth dev-instance"
|
|
5957
5963
|
}
|
|
5958
5964
|
],
|
|
5959
5965
|
"flags": {
|
|
@@ -6038,140 +6044,45 @@
|
|
|
6038
6044
|
"allowNo": false,
|
|
6039
6045
|
"type": "boolean"
|
|
6040
6046
|
},
|
|
6041
|
-
"
|
|
6042
|
-
"char": "
|
|
6043
|
-
"description": "
|
|
6044
|
-
"name": "
|
|
6045
|
-
"required": false,
|
|
6046
|
-
"allowNo": false,
|
|
6047
|
-
"type": "boolean"
|
|
6048
|
-
}
|
|
6049
|
-
},
|
|
6050
|
-
"hasDynamicHelp": false,
|
|
6051
|
-
"hiddenAliases": [],
|
|
6052
|
-
"id": "scope",
|
|
6053
|
-
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
6054
|
-
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
6055
|
-
"pluginType": "core",
|
|
6056
|
-
"strict": true,
|
|
6057
|
-
"enableJsonFlag": true,
|
|
6058
|
-
"isESM": true,
|
|
6059
|
-
"relativePath": [
|
|
6060
|
-
"dist",
|
|
6061
|
-
"commands",
|
|
6062
|
-
"scope",
|
|
6063
|
-
"index.js"
|
|
6064
|
-
]
|
|
6065
|
-
},
|
|
6066
|
-
"scope:set": {
|
|
6067
|
-
"aliases": [],
|
|
6068
|
-
"args": {},
|
|
6069
|
-
"description": "Set the current application scope on a ServiceNow instance.",
|
|
6070
|
-
"examples": [
|
|
6071
|
-
{
|
|
6072
|
-
"command": "<%= config.bin %> <%= command.id %> --app-id abc123def456ghi789jkl012mno345pq --auth dev",
|
|
6073
|
-
"description": "Set application scope by sys_id"
|
|
6074
|
-
},
|
|
6075
|
-
{
|
|
6076
|
-
"command": "<%= config.bin %> <%= command.id %> -a abc123def456ghi789jkl012mno345pq --json --auth dev",
|
|
6077
|
-
"description": "Set application scope and output as JSON"
|
|
6078
|
-
}
|
|
6079
|
-
],
|
|
6080
|
-
"flags": {
|
|
6081
|
-
"json": {
|
|
6082
|
-
"description": "Format output as json.",
|
|
6083
|
-
"helpGroup": "GLOBAL",
|
|
6084
|
-
"name": "json",
|
|
6085
|
-
"allowNo": false,
|
|
6086
|
-
"type": "boolean"
|
|
6087
|
-
},
|
|
6088
|
-
"auth": {
|
|
6089
|
-
"char": "a",
|
|
6090
|
-
"description": "Auth alias to use.",
|
|
6091
|
-
"name": "auth",
|
|
6092
|
-
"required": false,
|
|
6093
|
-
"hasDynamicHelp": false,
|
|
6094
|
-
"multiple": false,
|
|
6095
|
-
"type": "option"
|
|
6096
|
-
},
|
|
6097
|
-
"cred-store": {
|
|
6098
|
-
"description": "Read credentials from @sonisoft/sn-credstore instead of the OS keyring. Use this in headless sessions (SSH, systemd, CI, agents) where the keyring cannot be unlocked.",
|
|
6099
|
-
"helpGroup": "GLOBAL",
|
|
6100
|
-
"name": "cred-store",
|
|
6101
|
-
"required": false,
|
|
6102
|
-
"allowNo": false,
|
|
6103
|
-
"type": "boolean"
|
|
6104
|
-
},
|
|
6105
|
-
"deny-execute": {
|
|
6106
|
-
"description": "Refuse background scripts, flow runs and ATF runs for this invocation.",
|
|
6107
|
-
"helpGroup": "GLOBAL",
|
|
6108
|
-
"name": "deny-execute",
|
|
6109
|
-
"required": false,
|
|
6110
|
-
"allowNo": false,
|
|
6111
|
-
"type": "boolean"
|
|
6112
|
-
},
|
|
6113
|
-
"deny-write": {
|
|
6114
|
-
"description": "Refuse any change to instance data for this invocation.",
|
|
6115
|
-
"helpGroup": "GLOBAL",
|
|
6116
|
-
"name": "deny-write",
|
|
6117
|
-
"required": false,
|
|
6118
|
-
"allowNo": false,
|
|
6119
|
-
"type": "boolean"
|
|
6120
|
-
},
|
|
6121
|
-
"log-dir": {
|
|
6122
|
-
"description": "Directory to write log files to. Implies --log-file.",
|
|
6123
|
-
"helpGroup": "GLOBAL",
|
|
6124
|
-
"name": "log-dir",
|
|
6047
|
+
"output": {
|
|
6048
|
+
"char": "o",
|
|
6049
|
+
"description": "Output file path to save logs. Creates parent directories if needed.",
|
|
6050
|
+
"name": "output",
|
|
6125
6051
|
"required": false,
|
|
6126
6052
|
"hasDynamicHelp": false,
|
|
6127
6053
|
"multiple": false,
|
|
6128
6054
|
"type": "option"
|
|
6129
6055
|
},
|
|
6130
|
-
"
|
|
6131
|
-
"
|
|
6132
|
-
"
|
|
6133
|
-
"name": "
|
|
6056
|
+
"interval": {
|
|
6057
|
+
"char": "i",
|
|
6058
|
+
"description": "Polling interval in milliseconds",
|
|
6059
|
+
"name": "interval",
|
|
6134
6060
|
"required": false,
|
|
6135
|
-
"
|
|
6136
|
-
"type": "boolean"
|
|
6137
|
-
},
|
|
6138
|
-
"log-level": {
|
|
6139
|
-
"helpGroup": "GLOBAL",
|
|
6140
|
-
"name": "log-level",
|
|
6141
|
-
"summary": "Specify level for logging.",
|
|
6142
|
-
"default": "info",
|
|
6061
|
+
"default": 1000,
|
|
6143
6062
|
"hasDynamicHelp": false,
|
|
6144
6063
|
"multiple": false,
|
|
6145
|
-
"options": [
|
|
6146
|
-
"debug",
|
|
6147
|
-
"warn",
|
|
6148
|
-
"error",
|
|
6149
|
-
"info",
|
|
6150
|
-
"trace"
|
|
6151
|
-
],
|
|
6152
6064
|
"type": "option"
|
|
6153
6065
|
},
|
|
6154
|
-
"
|
|
6155
|
-
"description": "
|
|
6156
|
-
"
|
|
6157
|
-
"name": "read-only",
|
|
6066
|
+
"no-color": {
|
|
6067
|
+
"description": "Disable colored output",
|
|
6068
|
+
"name": "no-color",
|
|
6158
6069
|
"required": false,
|
|
6159
6070
|
"allowNo": false,
|
|
6160
6071
|
"type": "boolean"
|
|
6161
6072
|
},
|
|
6162
|
-
"
|
|
6163
|
-
"char": "
|
|
6164
|
-
"description": "
|
|
6165
|
-
"name": "
|
|
6166
|
-
"required":
|
|
6073
|
+
"filter": {
|
|
6074
|
+
"char": "f",
|
|
6075
|
+
"description": "Filter logs by field and value. Syntax: field OPERATOR value. Operators: CONTAINS, CONTAINS_CI (case-insensitive), EQUALS, EQUALS_CI, STARTS_WITH, STARTS_WITH_CI, ENDS_WITH, ENDS_WITH_CI, REGEX, NOT_CONTAINS, NOT_EQUALS. Field defaults to \"message\" if omitted. Multiple filters are combined with AND logic.",
|
|
6076
|
+
"name": "filter",
|
|
6077
|
+
"required": false,
|
|
6167
6078
|
"hasDynamicHelp": false,
|
|
6168
|
-
"multiple":
|
|
6079
|
+
"multiple": true,
|
|
6169
6080
|
"type": "option"
|
|
6170
6081
|
}
|
|
6171
6082
|
},
|
|
6172
6083
|
"hasDynamicHelp": false,
|
|
6173
6084
|
"hiddenAliases": [],
|
|
6174
|
-
"id": "
|
|
6085
|
+
"id": "log",
|
|
6175
6086
|
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
6176
6087
|
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
6177
6088
|
"pluginType": "core",
|
|
@@ -6181,8 +6092,8 @@
|
|
|
6181
6092
|
"relativePath": [
|
|
6182
6093
|
"dist",
|
|
6183
6094
|
"commands",
|
|
6184
|
-
"
|
|
6185
|
-
"
|
|
6095
|
+
"log",
|
|
6096
|
+
"index.js"
|
|
6186
6097
|
]
|
|
6187
6098
|
},
|
|
6188
6099
|
"script-sync:pull": {
|
|
@@ -9940,7 +9851,254 @@
|
|
|
9940
9851
|
"xml",
|
|
9941
9852
|
"import.js"
|
|
9942
9853
|
]
|
|
9854
|
+
},
|
|
9855
|
+
"scope": {
|
|
9856
|
+
"aliases": [],
|
|
9857
|
+
"args": {},
|
|
9858
|
+
"description": "Get the current application scope or list available applications.",
|
|
9859
|
+
"examples": [
|
|
9860
|
+
{
|
|
9861
|
+
"command": "<%= config.bin %> <%= command.id %> --auth dev",
|
|
9862
|
+
"description": "Get the current application scope"
|
|
9863
|
+
},
|
|
9864
|
+
{
|
|
9865
|
+
"command": "<%= config.bin %> <%= command.id %> --list --auth dev",
|
|
9866
|
+
"description": "List all available applications"
|
|
9867
|
+
},
|
|
9868
|
+
{
|
|
9869
|
+
"command": "<%= config.bin %> <%= command.id %> -l --json --auth dev",
|
|
9870
|
+
"description": "List applications as JSON"
|
|
9871
|
+
}
|
|
9872
|
+
],
|
|
9873
|
+
"flags": {
|
|
9874
|
+
"json": {
|
|
9875
|
+
"description": "Format output as json.",
|
|
9876
|
+
"helpGroup": "GLOBAL",
|
|
9877
|
+
"name": "json",
|
|
9878
|
+
"allowNo": false,
|
|
9879
|
+
"type": "boolean"
|
|
9880
|
+
},
|
|
9881
|
+
"auth": {
|
|
9882
|
+
"char": "a",
|
|
9883
|
+
"description": "Auth alias to use.",
|
|
9884
|
+
"name": "auth",
|
|
9885
|
+
"required": false,
|
|
9886
|
+
"hasDynamicHelp": false,
|
|
9887
|
+
"multiple": false,
|
|
9888
|
+
"type": "option"
|
|
9889
|
+
},
|
|
9890
|
+
"cred-store": {
|
|
9891
|
+
"description": "Read credentials from @sonisoft/sn-credstore instead of the OS keyring. Use this in headless sessions (SSH, systemd, CI, agents) where the keyring cannot be unlocked.",
|
|
9892
|
+
"helpGroup": "GLOBAL",
|
|
9893
|
+
"name": "cred-store",
|
|
9894
|
+
"required": false,
|
|
9895
|
+
"allowNo": false,
|
|
9896
|
+
"type": "boolean"
|
|
9897
|
+
},
|
|
9898
|
+
"deny-execute": {
|
|
9899
|
+
"description": "Refuse background scripts, flow runs and ATF runs for this invocation.",
|
|
9900
|
+
"helpGroup": "GLOBAL",
|
|
9901
|
+
"name": "deny-execute",
|
|
9902
|
+
"required": false,
|
|
9903
|
+
"allowNo": false,
|
|
9904
|
+
"type": "boolean"
|
|
9905
|
+
},
|
|
9906
|
+
"deny-write": {
|
|
9907
|
+
"description": "Refuse any change to instance data for this invocation.",
|
|
9908
|
+
"helpGroup": "GLOBAL",
|
|
9909
|
+
"name": "deny-write",
|
|
9910
|
+
"required": false,
|
|
9911
|
+
"allowNo": false,
|
|
9912
|
+
"type": "boolean"
|
|
9913
|
+
},
|
|
9914
|
+
"log-dir": {
|
|
9915
|
+
"description": "Directory to write log files to. Implies --log-file.",
|
|
9916
|
+
"helpGroup": "GLOBAL",
|
|
9917
|
+
"name": "log-dir",
|
|
9918
|
+
"required": false,
|
|
9919
|
+
"hasDynamicHelp": false,
|
|
9920
|
+
"multiple": false,
|
|
9921
|
+
"type": "option"
|
|
9922
|
+
},
|
|
9923
|
+
"log-file": {
|
|
9924
|
+
"description": "Write logs to a file. Defaults to $XDG_STATE_HOME/now-sdk-ext/logs (~/.local/state/now-sdk-ext/logs). Off by default; without this, nex logs warnings and errors to stderr only.",
|
|
9925
|
+
"helpGroup": "GLOBAL",
|
|
9926
|
+
"name": "log-file",
|
|
9927
|
+
"required": false,
|
|
9928
|
+
"allowNo": false,
|
|
9929
|
+
"type": "boolean"
|
|
9930
|
+
},
|
|
9931
|
+
"log-level": {
|
|
9932
|
+
"helpGroup": "GLOBAL",
|
|
9933
|
+
"name": "log-level",
|
|
9934
|
+
"summary": "Specify level for logging.",
|
|
9935
|
+
"default": "info",
|
|
9936
|
+
"hasDynamicHelp": false,
|
|
9937
|
+
"multiple": false,
|
|
9938
|
+
"options": [
|
|
9939
|
+
"debug",
|
|
9940
|
+
"warn",
|
|
9941
|
+
"error",
|
|
9942
|
+
"info",
|
|
9943
|
+
"trace"
|
|
9944
|
+
],
|
|
9945
|
+
"type": "option"
|
|
9946
|
+
},
|
|
9947
|
+
"read-only": {
|
|
9948
|
+
"description": "Refuse every change to the instance — equivalent to --deny-write --deny-execute. Reads are unaffected.",
|
|
9949
|
+
"helpGroup": "GLOBAL",
|
|
9950
|
+
"name": "read-only",
|
|
9951
|
+
"required": false,
|
|
9952
|
+
"allowNo": false,
|
|
9953
|
+
"type": "boolean"
|
|
9954
|
+
},
|
|
9955
|
+
"list": {
|
|
9956
|
+
"char": "l",
|
|
9957
|
+
"description": "List all available applications",
|
|
9958
|
+
"name": "list",
|
|
9959
|
+
"required": false,
|
|
9960
|
+
"allowNo": false,
|
|
9961
|
+
"type": "boolean"
|
|
9962
|
+
}
|
|
9963
|
+
},
|
|
9964
|
+
"hasDynamicHelp": false,
|
|
9965
|
+
"hiddenAliases": [],
|
|
9966
|
+
"id": "scope",
|
|
9967
|
+
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
9968
|
+
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
9969
|
+
"pluginType": "core",
|
|
9970
|
+
"strict": true,
|
|
9971
|
+
"enableJsonFlag": true,
|
|
9972
|
+
"isESM": true,
|
|
9973
|
+
"relativePath": [
|
|
9974
|
+
"dist",
|
|
9975
|
+
"commands",
|
|
9976
|
+
"scope",
|
|
9977
|
+
"index.js"
|
|
9978
|
+
]
|
|
9979
|
+
},
|
|
9980
|
+
"scope:set": {
|
|
9981
|
+
"aliases": [],
|
|
9982
|
+
"args": {},
|
|
9983
|
+
"description": "Set the current application scope on a ServiceNow instance.",
|
|
9984
|
+
"examples": [
|
|
9985
|
+
{
|
|
9986
|
+
"command": "<%= config.bin %> <%= command.id %> --app-id abc123def456ghi789jkl012mno345pq --auth dev",
|
|
9987
|
+
"description": "Set application scope by sys_id"
|
|
9988
|
+
},
|
|
9989
|
+
{
|
|
9990
|
+
"command": "<%= config.bin %> <%= command.id %> -a abc123def456ghi789jkl012mno345pq --json --auth dev",
|
|
9991
|
+
"description": "Set application scope and output as JSON"
|
|
9992
|
+
}
|
|
9993
|
+
],
|
|
9994
|
+
"flags": {
|
|
9995
|
+
"json": {
|
|
9996
|
+
"description": "Format output as json.",
|
|
9997
|
+
"helpGroup": "GLOBAL",
|
|
9998
|
+
"name": "json",
|
|
9999
|
+
"allowNo": false,
|
|
10000
|
+
"type": "boolean"
|
|
10001
|
+
},
|
|
10002
|
+
"auth": {
|
|
10003
|
+
"char": "a",
|
|
10004
|
+
"description": "Auth alias to use.",
|
|
10005
|
+
"name": "auth",
|
|
10006
|
+
"required": false,
|
|
10007
|
+
"hasDynamicHelp": false,
|
|
10008
|
+
"multiple": false,
|
|
10009
|
+
"type": "option"
|
|
10010
|
+
},
|
|
10011
|
+
"cred-store": {
|
|
10012
|
+
"description": "Read credentials from @sonisoft/sn-credstore instead of the OS keyring. Use this in headless sessions (SSH, systemd, CI, agents) where the keyring cannot be unlocked.",
|
|
10013
|
+
"helpGroup": "GLOBAL",
|
|
10014
|
+
"name": "cred-store",
|
|
10015
|
+
"required": false,
|
|
10016
|
+
"allowNo": false,
|
|
10017
|
+
"type": "boolean"
|
|
10018
|
+
},
|
|
10019
|
+
"deny-execute": {
|
|
10020
|
+
"description": "Refuse background scripts, flow runs and ATF runs for this invocation.",
|
|
10021
|
+
"helpGroup": "GLOBAL",
|
|
10022
|
+
"name": "deny-execute",
|
|
10023
|
+
"required": false,
|
|
10024
|
+
"allowNo": false,
|
|
10025
|
+
"type": "boolean"
|
|
10026
|
+
},
|
|
10027
|
+
"deny-write": {
|
|
10028
|
+
"description": "Refuse any change to instance data for this invocation.",
|
|
10029
|
+
"helpGroup": "GLOBAL",
|
|
10030
|
+
"name": "deny-write",
|
|
10031
|
+
"required": false,
|
|
10032
|
+
"allowNo": false,
|
|
10033
|
+
"type": "boolean"
|
|
10034
|
+
},
|
|
10035
|
+
"log-dir": {
|
|
10036
|
+
"description": "Directory to write log files to. Implies --log-file.",
|
|
10037
|
+
"helpGroup": "GLOBAL",
|
|
10038
|
+
"name": "log-dir",
|
|
10039
|
+
"required": false,
|
|
10040
|
+
"hasDynamicHelp": false,
|
|
10041
|
+
"multiple": false,
|
|
10042
|
+
"type": "option"
|
|
10043
|
+
},
|
|
10044
|
+
"log-file": {
|
|
10045
|
+
"description": "Write logs to a file. Defaults to $XDG_STATE_HOME/now-sdk-ext/logs (~/.local/state/now-sdk-ext/logs). Off by default; without this, nex logs warnings and errors to stderr only.",
|
|
10046
|
+
"helpGroup": "GLOBAL",
|
|
10047
|
+
"name": "log-file",
|
|
10048
|
+
"required": false,
|
|
10049
|
+
"allowNo": false,
|
|
10050
|
+
"type": "boolean"
|
|
10051
|
+
},
|
|
10052
|
+
"log-level": {
|
|
10053
|
+
"helpGroup": "GLOBAL",
|
|
10054
|
+
"name": "log-level",
|
|
10055
|
+
"summary": "Specify level for logging.",
|
|
10056
|
+
"default": "info",
|
|
10057
|
+
"hasDynamicHelp": false,
|
|
10058
|
+
"multiple": false,
|
|
10059
|
+
"options": [
|
|
10060
|
+
"debug",
|
|
10061
|
+
"warn",
|
|
10062
|
+
"error",
|
|
10063
|
+
"info",
|
|
10064
|
+
"trace"
|
|
10065
|
+
],
|
|
10066
|
+
"type": "option"
|
|
10067
|
+
},
|
|
10068
|
+
"read-only": {
|
|
10069
|
+
"description": "Refuse every change to the instance — equivalent to --deny-write --deny-execute. Reads are unaffected.",
|
|
10070
|
+
"helpGroup": "GLOBAL",
|
|
10071
|
+
"name": "read-only",
|
|
10072
|
+
"required": false,
|
|
10073
|
+
"allowNo": false,
|
|
10074
|
+
"type": "boolean"
|
|
10075
|
+
},
|
|
10076
|
+
"app-id": {
|
|
10077
|
+
"char": "a",
|
|
10078
|
+
"description": "32-char sys_id of application",
|
|
10079
|
+
"name": "app-id",
|
|
10080
|
+
"required": true,
|
|
10081
|
+
"hasDynamicHelp": false,
|
|
10082
|
+
"multiple": false,
|
|
10083
|
+
"type": "option"
|
|
10084
|
+
}
|
|
10085
|
+
},
|
|
10086
|
+
"hasDynamicHelp": false,
|
|
10087
|
+
"hiddenAliases": [],
|
|
10088
|
+
"id": "scope:set",
|
|
10089
|
+
"pluginAlias": "@sonisoft/now-sdk-ext-cli",
|
|
10090
|
+
"pluginName": "@sonisoft/now-sdk-ext-cli",
|
|
10091
|
+
"pluginType": "core",
|
|
10092
|
+
"strict": true,
|
|
10093
|
+
"enableJsonFlag": true,
|
|
10094
|
+
"isESM": true,
|
|
10095
|
+
"relativePath": [
|
|
10096
|
+
"dist",
|
|
10097
|
+
"commands",
|
|
10098
|
+
"scope",
|
|
10099
|
+
"set.js"
|
|
10100
|
+
]
|
|
9943
10101
|
}
|
|
9944
10102
|
},
|
|
9945
|
-
"version": "5.
|
|
10103
|
+
"version": "5.3.0"
|
|
9946
10104
|
}
|