@scalar/cli 2.7.1 → 2.10.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 +475 -80
- package/chunks/action-4GZI2M5B.js +62 -0
- package/chunks/action-4W5GUGEG.js +63 -0
- package/chunks/{action-HJYZCPUN.js → action-5LF4XYHX.js} +10 -7
- package/chunks/{action-SRBN7N3R.js → action-5N3P43MD.js} +17 -12
- package/chunks/{action-RBOLLIGX.js → action-5RL4NWUZ.js} +17 -17
- package/chunks/{action-SNPOOW6S.js → action-657A4K2D.js} +16 -16
- package/chunks/{action-EOAVVL52.js → action-7XOHYWYM.js} +11 -14
- package/chunks/{action-AQRPFQKI.js → action-CABLS46Q.js} +9 -7
- package/chunks/{action-F7A2K74G.js → action-CB55NWAU.js} +9 -13
- package/chunks/{action-5SK5NE7E.js → action-DKDRAIKV.js} +11 -14
- package/chunks/{action-7PEQXDWT.js → action-DTEO4YNX.js} +127 -20
- package/chunks/{action-BAQYJ6UE.js → action-EAUTQ77U.js} +27 -23
- package/chunks/{action-QYGOPSTY.js → action-FBRY5JKU.js} +16 -16
- package/chunks/{action-VOFDW3U2.js → action-GFLRD7LO.js} +6 -5
- package/chunks/{action-LPVITMWA.js → action-GWYYTUTM.js} +4 -3
- package/chunks/{action-4NGK5XMD.js → action-HT42NUUX.js} +29 -24
- package/chunks/action-JEYDBB3P.js +147 -0
- package/chunks/{action-E4YSRFGT.js → action-KDUFU7TZ.js} +11 -13
- package/chunks/{action-BRSSC2SR.js → action-LYCNT3KA.js} +29 -10
- package/chunks/{action-CA4QYPI6.js → action-OJ2NK25F.js} +4 -8
- package/chunks/{action-NVI5DWFP.js → action-PAM2EZ22.js} +4 -8
- package/chunks/action-PPTFYZWD.js +1552 -0
- package/chunks/{action-OX2566BE.js → action-R4PGILN4.js} +30 -26
- package/chunks/{action-CPLH2CQ5.js → action-TOBU74JH.js} +23 -19
- package/chunks/action-U2L5DCFG.js +91 -0
- package/chunks/{action-H6OUJWWM.js → action-UUL6SWV4.js} +11 -14
- package/chunks/{action-T5XMJXPO.js → action-X7BA7PQQ.js} +10 -8
- package/chunks/{action-LVDU6YOI.js → action-XLE37MZL.js} +16 -16
- package/chunks/{action-BOZNBCNZ.js → action-XOADBXSX.js} +16 -12
- package/chunks/{action-SCOXTCPR.js → action-YSVTZVKV.js} +38 -19
- package/chunks/{action-YRX6SN5F.js → action-ZFI77WA5.js} +8 -6
- package/chunks/{action-ATGZOWSH.js → action-ZKA3RR3S.js} +15 -11
- package/chunks/actions-3SAMH7A5.js +182 -0
- package/chunks/{agent-ASPV3R5U.js → agent-2ESZI7NO.js} +7 -5
- package/chunks/{asyncapi-H4FU6GPC.js → asyncapi-4HGVM3PR.js} +14 -10
- package/chunks/{build.action-6V6GXI3X.js → build.action-VBGFGACM.js} +21 -19
- package/chunks/chunk-35Z7VTJT.js +453 -0
- package/chunks/chunk-36LXIJIZ.js +52 -0
- package/chunks/{chunk-BIKOD3SG.js → chunk-43WALAW3.js} +251 -103
- package/chunks/{chunk-C2KAWRIX.js → chunk-5ENKYZA4.js} +1 -1
- package/chunks/{chunk-ZJVYOZFB.js → chunk-5SMP756H.js} +2 -2
- package/chunks/{chunk-5JLVQVKO.js → chunk-6M7TL2G2.js} +146 -148
- package/chunks/chunk-6PSYZO3U.js +24 -0
- package/chunks/{chunk-ISXH6Q7I.js → chunk-ATNTXKMS.js} +45 -274
- package/chunks/{chunk-BDEPNGTO.js → chunk-BIMLCGKS.js} +1 -1
- package/chunks/{chunk-HGOD6THU.js → chunk-CWVYOXXM.js} +2 -19
- package/chunks/chunk-DFOZG7ZV.js +15 -0
- package/chunks/chunk-DHZW7Q7U.js +133 -0
- package/chunks/{chunk-R5LK6VPY.js → chunk-G4HRW2FZ.js} +13 -20
- package/chunks/{chunk-KCCFN4F7.js → chunk-GLWTVLKM.js} +29 -29
- package/chunks/{chunk-5UHLAJQD.js → chunk-GYRQPDTK.js} +24 -10
- package/chunks/chunk-H467HDVV.js +24 -0
- package/chunks/chunk-IPZP3VRA.js +327 -0
- package/chunks/{chunk-LG7IFACX.js → chunk-JXGF5EHC.js} +152 -18
- package/chunks/chunk-K2HIB5BA.js +92 -0
- package/chunks/{chunk-FDC2IESH.js → chunk-KHF2QXBG.js} +1352 -8327
- package/chunks/{chunk-IMG35UXX.js → chunk-KZNRQVMY.js} +1 -1
- package/chunks/{chunk-OJ2EWIJH.js → chunk-MC4EMNOR.js} +5 -1
- package/chunks/{chunk-YILQODZF.js → chunk-MMWSCTDB.js} +7 -4
- package/chunks/{chunk-6XWCMJDB.js → chunk-MNNGUUKJ.js} +12 -11
- package/chunks/chunk-NAC63XJF.js +10 -0
- package/chunks/{chunk-XXSQUBXS.js → chunk-UDBSV3CK.js} +107 -453
- package/chunks/{chunk-IKT5F47M.js → chunk-VVRUSQCY.js} +11 -11
- package/chunks/{chunk-2PPRO2QB.js → chunk-VYFGRLVQ.js} +1 -1
- package/chunks/{chunk-GPNB7ISG.js → chunk-WB6PWTMU.js} +5 -13
- package/chunks/{chunk-4X47MN6Q.js → chunk-WDIWLXLV.js} +3 -15
- package/chunks/{chunk-6YPQGVF4.js → chunk-WIEXQUTD.js} +1 -1
- package/chunks/{chunk-W24BETFG.js → chunk-XAGJJNQW.js} +3 -3
- package/chunks/{chunk-2DSVF5AD.js → chunk-ZGNDXPLU.js} +3 -3
- package/chunks/{chunk-XEDGMZJD.js → chunk-ZGVZU6L2.js} +81 -25
- package/chunks/{chunk-QXQZVEDC.js → chunk-ZKJPLWRJ.js} +2 -2
- package/chunks/{chunk-MLSZVVTT.js → chunk-ZYBLQ5CT.js} +13 -7
- package/chunks/{create.action-P6DLCK4W.js → create.action-DBNIS665.js} +21 -19
- package/chunks/{delete.action-HJKRRHE2.js → delete.action-GBOZC45K.js} +21 -19
- package/chunks/{delete.action-Z3GAA4ZN.js → delete.action-K7BLK7DK.js} +21 -19
- package/chunks/{get.action-IT4EHAV4.js → get.action-N3JOY3OU.js} +17 -12
- package/chunks/get.action-QHKMYZBK.js +91 -0
- package/chunks/{list.action-WLIAO5UW.js → list.action-6SSO3JVN.js} +45 -15
- package/chunks/{list.action-2FU5UZNH.js → list.action-TJCS6UEY.js} +41 -21
- package/chunks/{publish.action-T4J4DRXR.js → publish.action-T24VHRMR.js} +29 -24
- package/chunks/query-WKATAJJ6.js +129 -0
- package/chunks/scripts-VIBLGKYG.js +102 -0
- package/chunks/{update.action-3OVS3HWC.js → update.action-OGYNBXRU.js} +24 -19
- package/chunks/{update.action-MY7QPSSU.js → update.action-VOE6PH5F.js} +24 -19
- package/docs.html +1363 -320
- package/index.js +417 -174
- package/package.json +14 -13
- package/skills/scalar-cli/SKILL.md +13 -1
- package/template.md +157 -15
- package/chunks/action-JAHFRYWZ.js +0 -423
- package/chunks/action-N7BA5I3E.js +0 -229
- package/chunks/chunk-CWCETP6H.js +0 -610
- package/chunks/chunk-K74E42RV.js +0 -7311
package/docs.html
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
<title>Scalar CLI Documentation</title>
|
|
9
9
|
<style>
|
|
10
10
|
/* Base CSS will be injected here */
|
|
11
|
-
/* ../../node_modules/.pnpm/@scalar+themes@0.18.
|
|
11
|
+
/* ../../node_modules/.pnpm/@scalar+themes@0.18.1/node_modules/@scalar/themes/dist/style.css */
|
|
12
12
|
@layer scalar-base, scalar-theme;
|
|
13
13
|
@layer scalar-base {
|
|
14
14
|
body {
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
font-family: var(--scalar-font);
|
|
21
21
|
line-height: 1.15;
|
|
22
22
|
color: var(--scalar-color-1);
|
|
23
|
+
--scalar-focus-color: color-mix(in srgb, var(--scalar-color-accent), var(--scalar-color-1) 20%);
|
|
23
24
|
-webkit-text-size-adjust: 100%;
|
|
24
25
|
-moz-tab-size: 4;
|
|
25
26
|
tab-size: 4;
|
|
@@ -101,6 +102,11 @@
|
|
|
101
102
|
[role=button]:focus-visible {
|
|
102
103
|
outline-offset: -1px;
|
|
103
104
|
}
|
|
105
|
+
a:focus-visible,
|
|
106
|
+
button:focus-visible,
|
|
107
|
+
[role=button]:focus-visible {
|
|
108
|
+
outline-color: var(--scalar-focus-color);
|
|
109
|
+
}
|
|
104
110
|
button,
|
|
105
111
|
[role=button] {
|
|
106
112
|
cursor: pointer;
|
|
@@ -317,7 +323,7 @@
|
|
|
317
323
|
--scalar-background-3: #e7e7e7;
|
|
318
324
|
--scalar-background-accent: #8ab4f81f;
|
|
319
325
|
--scalar-color-1: #1b1b1b;
|
|
320
|
-
--scalar-color-2: #
|
|
326
|
+
--scalar-color-2: #707070;
|
|
321
327
|
--scalar-color-3: #8e8e8e;
|
|
322
328
|
--scalar-color-accent: #0099ff;
|
|
323
329
|
--scalar-border-color: #dfdfdf;
|
|
@@ -354,7 +360,7 @@
|
|
|
354
360
|
--scalar-color-green: #069061;
|
|
355
361
|
--scalar-color-red: #ef0006;
|
|
356
362
|
--scalar-color-yellow: #edbe20;
|
|
357
|
-
--scalar-color-blue: #
|
|
363
|
+
--scalar-color-blue: #0072bd;
|
|
358
364
|
--scalar-color-orange: #ff5800;
|
|
359
365
|
--scalar-color-purple: #5203d1;
|
|
360
366
|
--scalar-color-query: #007b80;
|
|
@@ -395,7 +401,7 @@
|
|
|
395
401
|
--scalar-color-green: color(display-p3 0.023529 0.564706 0.380392 / 1);
|
|
396
402
|
--scalar-color-red: color(display-p3 0.937255 0 0.023529 / 1);
|
|
397
403
|
--scalar-color-yellow: color(display-p3 0.929412 0.745098 0.12549 / 1);
|
|
398
|
-
--scalar-color-blue: color(display-p3 0 0.
|
|
404
|
+
--scalar-color-blue: color(display-p3 0 0.447059 0.741176 / 1);
|
|
399
405
|
--scalar-color-orange: color(display-p3 1 0.4 0.02);
|
|
400
406
|
--scalar-color-purple: color(display-p3 0.321569 0.011765 0.819608 / 1);
|
|
401
407
|
}
|
|
@@ -411,7 +417,7 @@
|
|
|
411
417
|
}
|
|
412
418
|
}
|
|
413
419
|
|
|
414
|
-
/* ../../node_modules/.pnpm/@scalar+themes@0.18.
|
|
420
|
+
/* ../../node_modules/.pnpm/@scalar+themes@0.18.1/node_modules/@scalar/themes/dist/fonts/fonts.css */
|
|
415
421
|
@font-face {
|
|
416
422
|
font-family: "Inter";
|
|
417
423
|
font-style: normal;
|
|
@@ -1926,8 +1932,8 @@ body {
|
|
|
1926
1932
|
.t-editor__paragraph:empty::before {
|
|
1927
1933
|
content: "\a0";
|
|
1928
1934
|
}
|
|
1929
|
-
.t-editor__paragraph img,
|
|
1930
|
-
.t-editor__paragraph svg {
|
|
1935
|
+
.t-editor__paragraph:where(:not([data-raw-html] [data-fill])) img,
|
|
1936
|
+
.t-editor__paragraph:where(:not([data-raw-html] [data-fill])) svg {
|
|
1931
1937
|
display: inline-block;
|
|
1932
1938
|
vertical-align: middle;
|
|
1933
1939
|
}
|
|
@@ -1986,7 +1992,7 @@ body {
|
|
|
1986
1992
|
display: flex;
|
|
1987
1993
|
align-items: center;
|
|
1988
1994
|
gap: 3px;
|
|
1989
|
-
scroll-margin-top: calc(var(--scalar-header-height) + 15px);
|
|
1995
|
+
scroll-margin-top: calc(var(--scalar-banner-height, 0px) + var(--scalar-header-height) + 15px);
|
|
1990
1996
|
position: relative;
|
|
1991
1997
|
overflow-wrap: anywhere;
|
|
1992
1998
|
}
|
|
@@ -2102,7 +2108,9 @@ h1.t-editor__heading:first-of-type {
|
|
|
2102
2108
|
margin-top: 40px;
|
|
2103
2109
|
}
|
|
2104
2110
|
}
|
|
2105
|
-
.t-editor__page-title .subheading
|
|
2111
|
+
.t-editor__page-title .subheading,
|
|
2112
|
+
p[role=doc-subtitle],
|
|
2113
|
+
p[role=doc-subtitle] .t-editor__paragraph {
|
|
2106
2114
|
--font-size: var(--scalar-page-description);
|
|
2107
2115
|
--font-color: var(--scalar-color-1);
|
|
2108
2116
|
--font-weight: var(--scalar-regular);
|
|
@@ -2114,13 +2122,18 @@ h1.t-editor__heading {
|
|
|
2114
2122
|
scroll-margin: 1.5em;
|
|
2115
2123
|
line-height: 1.33;
|
|
2116
2124
|
}
|
|
2117
|
-
.t-editor__page-title .subheading
|
|
2125
|
+
.t-editor__page-title .subheading,
|
|
2126
|
+
p[role=doc-subtitle],
|
|
2127
|
+
p[role=doc-subtitle] .t-editor__paragraph {
|
|
2118
2128
|
font-size: var(--font-size, var(--scalar-page-description));
|
|
2119
2129
|
font-weight: var(--font-weight, var(--scalar-regular));
|
|
2120
2130
|
color: var(--font-color, var(--scalar-color-1));
|
|
2121
2131
|
line-height: 1.625;
|
|
2122
2132
|
margin-top: 12px;
|
|
2123
2133
|
}
|
|
2134
|
+
p[role=doc-subtitle] .t-editor__paragraph {
|
|
2135
|
+
margin: 0;
|
|
2136
|
+
}
|
|
2124
2137
|
.t-editor__heading.t-editor__standard-heading {
|
|
2125
2138
|
margin-top: 0;
|
|
2126
2139
|
}
|
|
@@ -3394,6 +3407,306 @@ span.t-editor__icon {
|
|
|
3394
3407
|
--pill-color: var(--pill-info-color);
|
|
3395
3408
|
}
|
|
3396
3409
|
|
|
3410
|
+
/* ../../packages/css/src/guides/text-extensions/timeline.css */
|
|
3411
|
+
.t-editor__timeline {
|
|
3412
|
+
--timeline-spacing: 48px;
|
|
3413
|
+
display: flex;
|
|
3414
|
+
flex-direction: column;
|
|
3415
|
+
gap: var(--timeline-spacing);
|
|
3416
|
+
overflow-y: clip;
|
|
3417
|
+
}
|
|
3418
|
+
.t-editor__timeline-item {
|
|
3419
|
+
--timeline-gutter-width: 160px;
|
|
3420
|
+
--timeline-column-gap: 48px;
|
|
3421
|
+
--timeline-rail-x: 4px;
|
|
3422
|
+
--timeline-dot-size: 6px;
|
|
3423
|
+
--timeline-rail-gap: 6px;
|
|
3424
|
+
--timeline-dot-center: 13px;
|
|
3425
|
+
--timeline-sticky-top: calc( var(--scalar-header-height, 0px) + var(--timeline-sticky-offset, 24px) );
|
|
3426
|
+
}
|
|
3427
|
+
.t-editor__timeline-item .timeline-item__layout {
|
|
3428
|
+
position: relative;
|
|
3429
|
+
display: grid;
|
|
3430
|
+
grid-template-columns: minmax(0, 1fr);
|
|
3431
|
+
row-gap: 12px;
|
|
3432
|
+
padding-left: 24px;
|
|
3433
|
+
}
|
|
3434
|
+
.t-editor__timeline-item .timeline-item__layout::before {
|
|
3435
|
+
content: "";
|
|
3436
|
+
position: absolute;
|
|
3437
|
+
top: calc(var(--timeline-dot-center) + var(--timeline-dot-size) / 2 + var(--timeline-rail-gap));
|
|
3438
|
+
bottom: 0;
|
|
3439
|
+
left: var(--timeline-rail-x);
|
|
3440
|
+
width: var(--scalar-border-width, 1px);
|
|
3441
|
+
background: var(--scalar-border-color);
|
|
3442
|
+
}
|
|
3443
|
+
.t-editor__timeline .timeline-item__layout::before {
|
|
3444
|
+
bottom: calc(-1 * (var(--timeline-spacing) + var(--timeline-dot-center) - var(--timeline-dot-size) / 2 - var(--timeline-rail-gap)));
|
|
3445
|
+
}
|
|
3446
|
+
.t-editor__timeline-item .timeline-item__layout::after {
|
|
3447
|
+
content: "";
|
|
3448
|
+
position: absolute;
|
|
3449
|
+
top: calc(var(--timeline-dot-center) - var(--timeline-dot-size) / 2);
|
|
3450
|
+
left: calc(var(--timeline-rail-x) + var(--scalar-border-width, 1px) / 2 - var(--timeline-dot-size) / 2);
|
|
3451
|
+
width: var(--timeline-dot-size);
|
|
3452
|
+
height: var(--timeline-dot-size);
|
|
3453
|
+
border-radius: var(--scalar-radius-full);
|
|
3454
|
+
background: var(--scalar-color-3);
|
|
3455
|
+
}
|
|
3456
|
+
.t-editor__timeline-item .timeline-item__meta {
|
|
3457
|
+
display: flex;
|
|
3458
|
+
flex-wrap: wrap;
|
|
3459
|
+
align-items: center;
|
|
3460
|
+
gap: 4px 10px;
|
|
3461
|
+
min-width: 0;
|
|
3462
|
+
min-height: calc(var(--timeline-dot-center) * 2);
|
|
3463
|
+
}
|
|
3464
|
+
.t-editor__timeline-item .timeline-item__label {
|
|
3465
|
+
color: var(--scalar-color-1);
|
|
3466
|
+
font-size: var(--scalar-paragraph);
|
|
3467
|
+
font-weight: var(--scalar-bold);
|
|
3468
|
+
line-height: var(--scalar-prose-line-height);
|
|
3469
|
+
overflow-wrap: anywhere;
|
|
3470
|
+
}
|
|
3471
|
+
.t-editor__timeline-item .timeline-item__description {
|
|
3472
|
+
color: var(--scalar-color-2);
|
|
3473
|
+
font-size: var(--scalar-small);
|
|
3474
|
+
line-height: 20px;
|
|
3475
|
+
}
|
|
3476
|
+
.t-editor__timeline-item .timeline-item__tags {
|
|
3477
|
+
display: flex;
|
|
3478
|
+
flex-wrap: wrap;
|
|
3479
|
+
gap: 6px;
|
|
3480
|
+
}
|
|
3481
|
+
.t-editor__timeline-item .timeline-item__tags .t-editor__pill {
|
|
3482
|
+
--pill-font-size: var(--scalar-micro);
|
|
3483
|
+
--pill-color: var(--scalar-color-2);
|
|
3484
|
+
padding: 4px 8px;
|
|
3485
|
+
}
|
|
3486
|
+
.t-editor__timeline-item .timeline-item__body {
|
|
3487
|
+
min-width: 0;
|
|
3488
|
+
}
|
|
3489
|
+
.t-editor__timeline-item .timeline-item__body > :first-child {
|
|
3490
|
+
margin-top: 0;
|
|
3491
|
+
}
|
|
3492
|
+
.t-editor__timeline-item .timeline-item__body > :last-child {
|
|
3493
|
+
margin-bottom: 0;
|
|
3494
|
+
}
|
|
3495
|
+
@container scalar-docs-page (min-width: 1160px) {
|
|
3496
|
+
.t-editor__timeline-item .timeline-item__layout {
|
|
3497
|
+
--timeline-rail-x: calc( var(--timeline-gutter-width) + var(--timeline-column-gap) / 2 );
|
|
3498
|
+
grid-template-columns: var(--timeline-gutter-width) minmax(0, 1fr);
|
|
3499
|
+
column-gap: var(--timeline-column-gap);
|
|
3500
|
+
margin-left: calc(-1 * (var(--timeline-gutter-width) + var(--timeline-column-gap)));
|
|
3501
|
+
padding-left: 0;
|
|
3502
|
+
}
|
|
3503
|
+
.t-editor__timeline-item .timeline-item__meta {
|
|
3504
|
+
position: sticky;
|
|
3505
|
+
top: var(--timeline-sticky-top);
|
|
3506
|
+
align-self: start;
|
|
3507
|
+
flex-direction: column;
|
|
3508
|
+
align-items: flex-end;
|
|
3509
|
+
min-height: 0;
|
|
3510
|
+
text-align: right;
|
|
3511
|
+
}
|
|
3512
|
+
.t-editor__timeline-item .timeline-item__tags {
|
|
3513
|
+
justify-content: flex-end;
|
|
3514
|
+
margin-top: 4px;
|
|
3515
|
+
}
|
|
3516
|
+
}
|
|
3517
|
+
|
|
3518
|
+
/* ../../packages/css/src/guides/text-extensions/prompt.css */
|
|
3519
|
+
.t-editor__prompt {
|
|
3520
|
+
position: relative;
|
|
3521
|
+
margin-top: var(--scalar-block-spacing);
|
|
3522
|
+
background: var(--scalar-background-2);
|
|
3523
|
+
box-shadow: 0 0 0 var(--scalar-border-width) var(--scalar-border-color);
|
|
3524
|
+
border-radius: var(--scalar-radius-lg);
|
|
3525
|
+
overflow: hidden;
|
|
3526
|
+
}
|
|
3527
|
+
.t-editor__prompt .prompt-header {
|
|
3528
|
+
display: flex;
|
|
3529
|
+
align-items: center;
|
|
3530
|
+
justify-content: space-between;
|
|
3531
|
+
gap: 12px;
|
|
3532
|
+
padding: 10px 10px 10px 16px;
|
|
3533
|
+
border-bottom: var(--scalar-border-width) solid var(--scalar-border-color);
|
|
3534
|
+
}
|
|
3535
|
+
.t-editor__prompt .prompt-title {
|
|
3536
|
+
min-width: 0;
|
|
3537
|
+
font-family: var(--scalar-font);
|
|
3538
|
+
font-size: var(--scalar-small);
|
|
3539
|
+
font-weight: var(--scalar-semibold);
|
|
3540
|
+
line-height: 16px;
|
|
3541
|
+
color: var(--scalar-color-1);
|
|
3542
|
+
}
|
|
3543
|
+
.t-editor__prompt .prompt-copy {
|
|
3544
|
+
flex-shrink: 0;
|
|
3545
|
+
display: inline-flex;
|
|
3546
|
+
align-items: center;
|
|
3547
|
+
gap: 4px;
|
|
3548
|
+
margin: -4px;
|
|
3549
|
+
padding: 4px 8px;
|
|
3550
|
+
border-radius: var(--scalar-radius-md);
|
|
3551
|
+
font: var(--scalar-font);
|
|
3552
|
+
font-size: var(--scalar-font-size-4);
|
|
3553
|
+
font-weight: var(--scalar-semibold);
|
|
3554
|
+
line-height: 16px;
|
|
3555
|
+
color: var(--scalar-button-1-color);
|
|
3556
|
+
background: var(--scalar-button-1);
|
|
3557
|
+
cursor: pointer;
|
|
3558
|
+
}
|
|
3559
|
+
.t-editor__prompt .prompt-copy:hover {
|
|
3560
|
+
background: var(--scalar-button-1-hover);
|
|
3561
|
+
}
|
|
3562
|
+
.t-editor__prompt .prompt-copy:focus-visible {
|
|
3563
|
+
outline-offset: 1px;
|
|
3564
|
+
}
|
|
3565
|
+
.t-editor__prompt .prompt-copy-icon {
|
|
3566
|
+
position: relative;
|
|
3567
|
+
display: flex;
|
|
3568
|
+
flex-shrink: 0;
|
|
3569
|
+
width: 14px;
|
|
3570
|
+
height: 14px;
|
|
3571
|
+
}
|
|
3572
|
+
.t-editor__prompt .prompt-icon-copy,
|
|
3573
|
+
.t-editor__prompt .prompt-icon-check {
|
|
3574
|
+
position: absolute;
|
|
3575
|
+
inset: 0;
|
|
3576
|
+
width: 100%;
|
|
3577
|
+
height: 100%;
|
|
3578
|
+
transition: transform 0.15s;
|
|
3579
|
+
}
|
|
3580
|
+
.t-editor__prompt .prompt-icon-check,
|
|
3581
|
+
.t-editor__prompt .show-copied .prompt-icon-copy {
|
|
3582
|
+
transform: scale(0);
|
|
3583
|
+
}
|
|
3584
|
+
.t-editor__prompt .show-copied .prompt-icon-check {
|
|
3585
|
+
transform: scale(1);
|
|
3586
|
+
}
|
|
3587
|
+
.t-editor__prompt .prompt-copy-label {
|
|
3588
|
+
display: grid;
|
|
3589
|
+
overflow: hidden;
|
|
3590
|
+
}
|
|
3591
|
+
.t-editor__prompt .prompt-copy-label > span {
|
|
3592
|
+
grid-area: 1 / 1;
|
|
3593
|
+
white-space: nowrap;
|
|
3594
|
+
transition: transform 0.15s, opacity 0.15s;
|
|
3595
|
+
}
|
|
3596
|
+
.t-editor__prompt .prompt-copy-label-copied {
|
|
3597
|
+
opacity: 0;
|
|
3598
|
+
transform: translateY(100%);
|
|
3599
|
+
}
|
|
3600
|
+
.t-editor__prompt .show-copied .prompt-copy-label-copy {
|
|
3601
|
+
opacity: 0;
|
|
3602
|
+
transform: translateY(-100%);
|
|
3603
|
+
}
|
|
3604
|
+
.t-editor__prompt .show-copied .prompt-copy-label-copied {
|
|
3605
|
+
opacity: 1;
|
|
3606
|
+
transform: translateY(0);
|
|
3607
|
+
}
|
|
3608
|
+
.t-editor__prompt .prompt-copy-status {
|
|
3609
|
+
position: absolute;
|
|
3610
|
+
width: 1px;
|
|
3611
|
+
height: 1px;
|
|
3612
|
+
margin: -1px;
|
|
3613
|
+
overflow: hidden;
|
|
3614
|
+
clip-path: inset(50%);
|
|
3615
|
+
white-space: nowrap;
|
|
3616
|
+
}
|
|
3617
|
+
.t-editor__prompt .prompt-preview {
|
|
3618
|
+
max-height: 200px;
|
|
3619
|
+
overflow: hidden;
|
|
3620
|
+
}
|
|
3621
|
+
.t-editor__prompt[data-expanded] .prompt-preview {
|
|
3622
|
+
max-height: none;
|
|
3623
|
+
}
|
|
3624
|
+
.t-editor__prompt[data-clipped]:not([data-expanded]) .prompt-preview {
|
|
3625
|
+
mask-image:
|
|
3626
|
+
linear-gradient(
|
|
3627
|
+
to bottom,
|
|
3628
|
+
#000 45%,
|
|
3629
|
+
transparent);
|
|
3630
|
+
}
|
|
3631
|
+
.t-editor__prompt .t-editor__code-container {
|
|
3632
|
+
position: static;
|
|
3633
|
+
}
|
|
3634
|
+
.t-editor__prompt .t-editor__code,
|
|
3635
|
+
.t-editor__prompt .t-code {
|
|
3636
|
+
--hljs-color: var(--scalar-color-2);
|
|
3637
|
+
margin: 0;
|
|
3638
|
+
padding: 16px;
|
|
3639
|
+
max-height: none;
|
|
3640
|
+
overflow: visible;
|
|
3641
|
+
background: none;
|
|
3642
|
+
box-shadow: none;
|
|
3643
|
+
border-radius: 0;
|
|
3644
|
+
line-height: 1.75;
|
|
3645
|
+
}
|
|
3646
|
+
.t-editor__prompt .t-editor__code-container code,
|
|
3647
|
+
.t-editor__prompt .t-editor__code-container code.hljs {
|
|
3648
|
+
white-space: pre-wrap;
|
|
3649
|
+
overflow-wrap: anywhere;
|
|
3650
|
+
}
|
|
3651
|
+
.t-editor__prompt .t-editor__code .t-code__line {
|
|
3652
|
+
min-height: 1lh;
|
|
3653
|
+
}
|
|
3654
|
+
.t-editor__prompt .t-editor__code-container code * {
|
|
3655
|
+
color: inherit;
|
|
3656
|
+
font-style: normal;
|
|
3657
|
+
font-weight: inherit;
|
|
3658
|
+
line-height: inherit;
|
|
3659
|
+
text-decoration: none;
|
|
3660
|
+
white-space: pre-wrap;
|
|
3661
|
+
}
|
|
3662
|
+
.t-editor__prompt .language-button {
|
|
3663
|
+
display: none;
|
|
3664
|
+
}
|
|
3665
|
+
.t-editor__prompt .prompt-expand {
|
|
3666
|
+
position: absolute;
|
|
3667
|
+
bottom: 16px;
|
|
3668
|
+
left: 50%;
|
|
3669
|
+
transform: translateX(-50%);
|
|
3670
|
+
display: flex;
|
|
3671
|
+
align-items: center;
|
|
3672
|
+
justify-content: center;
|
|
3673
|
+
gap: 6px;
|
|
3674
|
+
padding: 8px 12px 8px 16px;
|
|
3675
|
+
border: var(--scalar-border-width) solid var(--scalar-border-color);
|
|
3676
|
+
border-radius: var(--scalar-radius-full);
|
|
3677
|
+
font: var(--scalar-font);
|
|
3678
|
+
font-size: var(--scalar-small);
|
|
3679
|
+
font-weight: var(--scalar-semibold);
|
|
3680
|
+
color: var(--scalar-color-2);
|
|
3681
|
+
background: var(--scalar-background-2);
|
|
3682
|
+
white-space: nowrap;
|
|
3683
|
+
cursor: pointer;
|
|
3684
|
+
}
|
|
3685
|
+
.t-editor__prompt .prompt-expand[hidden] {
|
|
3686
|
+
display: none;
|
|
3687
|
+
}
|
|
3688
|
+
.t-editor__prompt .prompt-expand:hover {
|
|
3689
|
+
color: var(--scalar-color-1);
|
|
3690
|
+
background: var(--scalar-background-3);
|
|
3691
|
+
}
|
|
3692
|
+
.t-editor__prompt .prompt-expand:active {
|
|
3693
|
+
box-shadow: 0 0 0 1px var(--scalar-border-color);
|
|
3694
|
+
}
|
|
3695
|
+
.t-editor__prompt .prompt-expand-icon {
|
|
3696
|
+
width: 12px;
|
|
3697
|
+
height: 12px;
|
|
3698
|
+
margin-top: 1px;
|
|
3699
|
+
}
|
|
3700
|
+
.t-editor__prompt[data-expanded] .prompt-expand {
|
|
3701
|
+
position: static;
|
|
3702
|
+
transform: none;
|
|
3703
|
+
width: fit-content;
|
|
3704
|
+
margin: 0 auto 16px;
|
|
3705
|
+
}
|
|
3706
|
+
.t-editor__prompt[data-expanded] .prompt-expand-icon {
|
|
3707
|
+
transform: rotate(180deg);
|
|
3708
|
+
}
|
|
3709
|
+
|
|
3397
3710
|
/* ../../packages/css/src/guides/text-extensions/quote.css */
|
|
3398
3711
|
.t-editor__quote {
|
|
3399
3712
|
--font-size: var(--scalar-paragraph);
|
|
@@ -3853,6 +4166,35 @@ blockquote.t-editor__quote > * {
|
|
|
3853
4166
|
<li>Preview your API reference</li>
|
|
3854
4167
|
<li>Bundle multiple OpenAPI files</li>
|
|
3855
4168
|
</ul>
|
|
4169
|
+
<h2 id="projects" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4170
|
+
Projects
|
|
4171
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4172
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4173
|
+
</svg>
|
|
4174
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4175
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4176
|
+
</svg></button>
|
|
4177
|
+
</h2>
|
|
4178
|
+
<p class="t-editor__paragraph">Discover project slugs and inspect project details without opening the Dashboard:</p>
|
|
4179
|
+
<div id="Rn0rOIlelZHN8kJuYwoJc" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
4180
|
+
<pre style="
|
|
4181
|
+
--line-digits: 2;
|
|
4182
|
+
--line-number-start: -1;
|
|
4183
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-bash" language="bash"><span class="t-code__line" data-line-number="0">scalar auth login</span>
|
|
4184
|
+
<span class="t-code__line" data-line-number="1">scalar project list</span>
|
|
4185
|
+
<span class="t-code__line" data-line-number="2">scalar project get my-docs</span>
|
|
4186
|
+
<span class="t-code__line" data-line-number="3">scalar project deployments list --slug my-docs</span>
|
|
4187
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">bash
|
|
4188
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4189
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4190
|
+
</svg>
|
|
4191
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4192
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4193
|
+
</svg></button>
|
|
4194
|
+
</div>
|
|
4195
|
+
<p class="t-editor__paragraph">These commands use your existing login and current team. The list includes unified docs projects and legacy sync or unlinked projects, with migrated projects shown once. Older Dashboard editor projects are not included.</p>
|
|
4196
|
+
<p class="t-editor__paragraph">Use <code inline="true" class="t-editor__inline-code">scalar project list --json</code> for an array of project details and <code inline="true" class="t-editor__inline-code">scalar project get my-docs --json</code> for one object. Both include <code inline="true" class="t-editor__inline-code">uid</code>, <code inline="true" class="t-editor__inline-code">name</code>, <code inline="true" class="t-editor__inline-code">slug</code>, <code inline="true" class="t-editor__inline-code">provider</code>, <code inline="true" class="t-editor__inline-code">isPrivate</code>, <code inline="true" class="t-editor__inline-code">repository</code>, and <code inline="true" class="t-editor__inline-code">activeDeployment</code>. An unlinked repository or absent live deployment is <code inline="true" class="t-editor__inline-code">null</code>; the provider is <code inline="true" class="t-editor__inline-code">forgejo</code>, <code inline="true" class="t-editor__inline-code">github</code>, <code inline="true" class="t-editor__inline-code">bitbucket</code>, or <code inline="true" class="t-editor__inline-code">unlinked</code>. The live deployment describes the active build, not a failed or pending publish attempt.</p>
|
|
4197
|
+
<p class="t-editor__paragraph">Project listing retrieves every page. On older servers that truncate the list without a continuation cursor, it exits with an error instead of printing an incomplete list. Errors go to stderr and exit nonzero.</p>
|
|
3856
4198
|
<h2 id="documentation" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
3857
4199
|
Documentation
|
|
3858
4200
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
@@ -3872,7 +4214,7 @@ blockquote.t-editor__quote > * {
|
|
|
3872
4214
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
3873
4215
|
</svg></button>
|
|
3874
4216
|
</h2>
|
|
3875
|
-
<div id="
|
|
4217
|
+
<div id="Yn9MUg7J7xdGI6gzFzwq4" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3876
4218
|
<pre style="
|
|
3877
4219
|
--line-digits: 2;
|
|
3878
4220
|
--line-number-start: -1;
|
|
@@ -3905,7 +4247,7 @@ blockquote.t-editor__quote > * {
|
|
|
3905
4247
|
</h3>
|
|
3906
4248
|
<p class="t-editor__paragraph">Install the latest stable release without Node.js, npm, or administrator access.</p>
|
|
3907
4249
|
<p class="t-editor__paragraph">macOS and Linux (Bash):</p>
|
|
3908
|
-
<div id="
|
|
4250
|
+
<div id="D9g8uFyvNg5pXfpgyxI3j" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3909
4251
|
<pre style="
|
|
3910
4252
|
--line-digits: 2;
|
|
3911
4253
|
--line-number-start: -1;
|
|
@@ -3919,7 +4261,7 @@ blockquote.t-editor__quote > * {
|
|
|
3919
4261
|
</svg></button>
|
|
3920
4262
|
</div>
|
|
3921
4263
|
<p class="t-editor__paragraph">Windows (PowerShell):</p>
|
|
3922
|
-
<div id="
|
|
4264
|
+
<div id="JA18e7yCY95ZPiEpEtKdz" class="t-editor__code-container" data-lang="powershell" style="position: relative;">
|
|
3923
4265
|
<pre style="
|
|
3924
4266
|
--line-digits: 2;
|
|
3925
4267
|
--line-number-start: -1;
|
|
@@ -3945,7 +4287,7 @@ blockquote.t-editor__quote > * {
|
|
|
3945
4287
|
</svg></button>
|
|
3946
4288
|
</h3>
|
|
3947
4289
|
<p class="t-editor__paragraph">If you already use Node.js, install the CLI with npm:</p>
|
|
3948
|
-
<div id="
|
|
4290
|
+
<div id="tc5qh3Xn8RmmJEBtBANGC" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3949
4291
|
<pre style="
|
|
3950
4292
|
--line-digits: 2;
|
|
3951
4293
|
--line-number-start: -1;
|
|
@@ -3969,7 +4311,7 @@ blockquote.t-editor__quote > * {
|
|
|
3969
4311
|
</svg></button>
|
|
3970
4312
|
</h3>
|
|
3971
4313
|
<p class="t-editor__paragraph">There’s another <code inline="true" class="t-editor__inline-code">scalar</code> CLI, which is bundled with <code inline="true" class="t-editor__inline-code">git</code>. If you run into naming conflicts, but never use the other CLI anyway, you can replace it like this:</p>
|
|
3972
|
-
<div id="
|
|
4314
|
+
<div id="HDXbs6cMRrX8CiPXuZ0ob" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3973
4315
|
<pre style="
|
|
3974
4316
|
--line-digits: 2;
|
|
3975
4317
|
--line-number-start: -1;
|
|
@@ -3983,7 +4325,7 @@ blockquote.t-editor__quote > * {
|
|
|
3983
4325
|
</svg></button>
|
|
3984
4326
|
</div>
|
|
3985
4327
|
<p class="t-editor__paragraph">Or, if you want to keep using the other <code inline="true" class="t-editor__inline-code">scalar</code> CLI, you can just stick to <code inline="true" class="t-editor__inline-code">npx</code> (or <code inline="true" class="t-editor__inline-code">pnpm dlx</code>):</p>
|
|
3986
|
-
<div id="
|
|
4328
|
+
<div id="MZooA3oM7ZMygosfsVnxE" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3987
4329
|
<pre style="
|
|
3988
4330
|
--line-digits: 2;
|
|
3989
4331
|
--line-number-start: -1;
|
|
@@ -4000,8 +4342,8 @@ blockquote.t-editor__quote > * {
|
|
|
4000
4342
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4001
4343
|
</svg></button>
|
|
4002
4344
|
</div>
|
|
4003
|
-
<h2 id="
|
|
4004
|
-
|
|
4345
|
+
<h2 id="shell-completion" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4346
|
+
Shell completion
|
|
4005
4347
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4006
4348
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4007
4349
|
</svg>
|
|
@@ -4009,13 +4351,24 @@ blockquote.t-editor__quote > * {
|
|
|
4009
4351
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4010
4352
|
</svg></button>
|
|
4011
4353
|
</h2>
|
|
4012
|
-
<p class="t-editor__paragraph">
|
|
4013
|
-
<
|
|
4354
|
+
<p class="t-editor__paragraph">Generate completions for Bash, Zsh, or Fish with the installed CLI on PATH. These instructions work for both <code inline="true" class="t-editor__inline-code">npm -g install @scalar/cli</code> and the standalone installer. Completion runs locally, needs no login or network access, and discovers commands, nested commands, flags, and finite option values from the installed CLI. File arguments and file options retain native filesystem completion.</p>
|
|
4355
|
+
<h3 id="bash" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4356
|
+
Bash
|
|
4357
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4358
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4359
|
+
</svg>
|
|
4360
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4361
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4362
|
+
</svg></button>
|
|
4363
|
+
</h3>
|
|
4364
|
+
<div id="2PwbU31MQtTXIlfjnzMP5" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
4014
4365
|
<pre style="
|
|
4015
4366
|
--line-digits: 2;
|
|
4016
4367
|
--line-number-start: -1;
|
|
4017
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-
|
|
4018
|
-
|
|
4368
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-bash" language="bash"><span class="t-code__line" data-line-number="0"><span class="hljs-built_in">mkdir</span> -p ~/.local/share/scalar</span>
|
|
4369
|
+
<span class="t-code__line" data-line-number="1">scalar completion bash > ~/.local/share/scalar/completion.bash</span>
|
|
4370
|
+
<span class="t-code__line" data-line-number="2"><span class="hljs-built_in">source</span> ~/.local/share/scalar/completion.bash</span>
|
|
4371
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">bash
|
|
4019
4372
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4020
4373
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4021
4374
|
</svg>
|
|
@@ -4023,15 +4376,23 @@ blockquote.t-editor__quote > * {
|
|
|
4023
4376
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4024
4377
|
</svg></button>
|
|
4025
4378
|
</div>
|
|
4026
|
-
<
|
|
4379
|
+
<p class="t-editor__paragraph">Add <code inline="true" class="t-editor__inline-code">source ~/.local/share/scalar/completion.bash</code> to <code inline="true" class="t-editor__inline-code">~/.bashrc</code>, or <code inline="true" class="t-editor__inline-code">~/.bash_profile</code> for a macOS login shell. Bash 3.2 and newer are supported. The script registers both <code inline="true" class="t-editor__inline-code">scalar</code> and <code inline="true" class="t-editor__inline-code">scalar-cli</code>.</p>
|
|
4380
|
+
<h3 id="zsh" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4381
|
+
Zsh
|
|
4382
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4383
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4384
|
+
</svg>
|
|
4385
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4386
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4387
|
+
</svg></button>
|
|
4388
|
+
</h3>
|
|
4389
|
+
<div id="vY5l1SPwoyxfhOVjSZ7YS" class="t-editor__code-container" data-lang="zsh" style="position: relative;">
|
|
4027
4390
|
<pre style="
|
|
4028
4391
|
--line-digits: 2;
|
|
4029
4392
|
--line-number-start: -1;
|
|
4030
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-
|
|
4031
|
-
<span class="t-code__line" data-line-number="1">
|
|
4032
|
-
|
|
4033
|
-
<span class="t-code__line" data-line-number="3"><span class="hljs-punctuation">}</span></span>
|
|
4034
|
-
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">json
|
|
4393
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-zsh" language="zsh"><span class="t-code__line" data-line-number="0"><span class="hljs-built_in">mkdir</span> -p ~/.zsh/completions</span>
|
|
4394
|
+
<span class="t-code__line" data-line-number="1">scalar completion zsh > ~/.zsh/completions/_scalar</span>
|
|
4395
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">zsh
|
|
4035
4396
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4036
4397
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4037
4398
|
</svg>
|
|
@@ -4039,64 +4400,40 @@ blockquote.t-editor__quote > * {
|
|
|
4039
4400
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4040
4401
|
</svg></button>
|
|
4041
4402
|
</div>
|
|
4042
|
-
<p class="t-editor__paragraph">
|
|
4043
|
-
|
|
4044
|
-
|
|
4045
|
-
|
|
4046
|
-
|
|
4047
|
-
</
|
|
4048
|
-
<
|
|
4049
|
-
|
|
4050
|
-
|
|
4051
|
-
|
|
4403
|
+
<p class="t-editor__paragraph">Add the following to <code inline="true" class="t-editor__inline-code">~/.zshrc</code>, placing the <code inline="true" class="t-editor__inline-code">fpath</code> line before your existing <code inline="true" class="t-editor__inline-code">compinit</code> setup. If your shell already initializes completion, keep that setup instead of calling <code inline="true" class="t-editor__inline-code">compinit</code> twice.</p>
|
|
4404
|
+
<div id="g8aW4YzPhQ8rA0tJY9snL" class="t-editor__code-container" data-lang="zsh" style="position: relative;">
|
|
4405
|
+
<pre style="
|
|
4406
|
+
--line-digits: 2;
|
|
4407
|
+
--line-number-start: -1;
|
|
4408
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-zsh" language="zsh"><span class="t-code__line" data-line-number="0">fpath=(~/.zsh/completions <span class="hljs-variable">$fpath</span>)</span>
|
|
4409
|
+
<span class="t-code__line" data-line-number="1"><span class="hljs-built_in">autoload</span> -Uz compinit</span>
|
|
4410
|
+
<span class="t-code__line" data-line-number="2">compinit</span>
|
|
4411
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">zsh
|
|
4412
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4413
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4052
4414
|
</svg>
|
|
4053
|
-
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256"
|
|
4054
|
-
<path d="
|
|
4415
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4416
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4055
4417
|
</svg></button>
|
|
4056
|
-
</
|
|
4057
|
-
<p class="t-editor__paragraph">
|
|
4058
|
-
|
|
4059
|
-
|
|
4060
|
-
precedence over <code inline="true" class="t-editor__inline-code">--token</code>. Unset it to use a different explicit token.
|
|
4061
|
-
</p>
|
|
4062
|
-
<p class="t-editor__paragraph">
|
|
4063
|
-
Supply required options in automation instead of relying on interactive prompts.
|
|
4064
|
-
For example, pass <code inline="true" class="t-editor__inline-code">--output</code> for document transformations.
|
|
4065
|
-
</p>
|
|
4066
|
-
<h2 id="commands" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4067
|
-
Commands
|
|
4418
|
+
</div>
|
|
4419
|
+
<p class="t-editor__paragraph">Open a new shell. Both <code inline="true" class="t-editor__inline-code">scalar</code> and <code inline="true" class="t-editor__inline-code">scalar-cli</code> use the same completion function.</p>
|
|
4420
|
+
<h3 id="fish" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4421
|
+
Fish
|
|
4068
4422
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4069
4423
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4070
4424
|
</svg>
|
|
4071
4425
|
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4072
4426
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4073
4427
|
</svg></button>
|
|
4074
|
-
</
|
|
4075
|
-
<div id="
|
|
4428
|
+
</h3>
|
|
4429
|
+
<div id="rXdSncOypqMIQ5OU8G6vC" class="t-editor__code-container" data-lang="fish" style="position: relative;">
|
|
4076
4430
|
<pre style="
|
|
4077
4431
|
--line-digits: 2;
|
|
4078
4432
|
--line-number-start: -1;
|
|
4079
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-
|
|
4080
|
-
<span class="t-code__line" data-line-number="1"
|
|
4081
|
-
<span class="t-code__line" data-line-number="2">
|
|
4082
|
-
|
|
4083
|
-
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4084
|
-
<span class="t-code__line" data-line-number="5"> -v, --version output the version number</span>
|
|
4085
|
-
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
4086
|
-
<span class="t-code__line" data-line-number="7"></span>
|
|
4087
|
-
<span class="t-code__line" data-line-number="8">Commands:</span>
|
|
4088
|
-
<span class="t-code__line" data-line-number="9"> readme Open documentation for the CLI</span>
|
|
4089
|
-
<span class="t-code__line" data-line-number="10"> upgrade Upgrade current version of your cli</span>
|
|
4090
|
-
<span class="t-code__line" data-line-number="11"> context Print every command, argument, and option as JSON for AI agents</span>
|
|
4091
|
-
<span class="t-code__line" data-line-number="12"> auth Manage authorization on scalar platform</span>
|
|
4092
|
-
<span class="t-code__line" data-line-number="13"> document Manage local openapi file</span>
|
|
4093
|
-
<span class="t-code__line" data-line-number="14"> project Manage scalar project</span>
|
|
4094
|
-
<span class="t-code__line" data-line-number="15"> registry Manage your scalar registry</span>
|
|
4095
|
-
<span class="t-code__line" data-line-number="16"> team Manage user teams</span>
|
|
4096
|
-
<span class="t-code__line" data-line-number="17"> sdk Manage your Scalar SDKs (Enterprise Only)</span>
|
|
4097
|
-
<span class="t-code__line" data-line-number="18"> schema Manage your Scalar schemas</span>
|
|
4098
|
-
<span class="t-code__line" data-line-number="19"> help [command] display help for command</span>
|
|
4099
|
-
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4433
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-fish" language="fish"><span class="t-code__line" data-line-number="0">mkdir -p ~/.config/fish/completions</span>
|
|
4434
|
+
<span class="t-code__line" data-line-number="1">scalar completion fish > ~/.config/fish/completions/scalar.fish</span>
|
|
4435
|
+
<span class="t-code__line" data-line-number="2">cp ~/.config/fish/completions/scalar.fish ~/.config/fish/completions/scalar-cli.fish</span>
|
|
4436
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">fish
|
|
4100
4437
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4101
4438
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4102
4439
|
</svg>
|
|
@@ -4104,8 +4441,9 @@ blockquote.t-editor__quote > * {
|
|
|
4104
4441
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4105
4442
|
</svg></button>
|
|
4106
4443
|
</div>
|
|
4107
|
-
<
|
|
4108
|
-
|
|
4444
|
+
<p class="t-editor__paragraph">Open a new shell. The second file enables autoloading when using <code inline="true" class="t-editor__inline-code">scalar-cli</code>; it is optional for standalone installs that only provide <code inline="true" class="t-editor__inline-code">scalar</code>.</p>
|
|
4445
|
+
<h3 id="upgrades-and-removal" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4446
|
+
Upgrades and removal
|
|
4109
4447
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4110
4448
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4111
4449
|
</svg>
|
|
@@ -4113,10 +4451,154 @@ blockquote.t-editor__quote > * {
|
|
|
4113
4451
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4114
4452
|
</svg></button>
|
|
4115
4453
|
</h3>
|
|
4116
|
-
<
|
|
4117
|
-
|
|
4118
|
-
|
|
4119
|
-
|
|
4454
|
+
<p class="t-editor__paragraph">Completion reads the installed executable's command definitions on each Tab press, so new commands and options appear after an upgrade. Regenerate your script by repeating the generation command with <code inline="true" class="t-editor__inline-code">></code> after upgrading with npm or re-running the standalone installer, then open a new shell. This also refreshes any improvements to the shell adapter. Avoid appending scripts with <code inline="true" class="t-editor__inline-code">>></code>.</p>
|
|
4455
|
+
<p class="t-editor__paragraph">To remove completion, delete the generated file (both files for Fish) and remove the <code inline="true" class="t-editor__inline-code">source</code> line for Bash or the Scalar <code inline="true" class="t-editor__inline-code">fpath</code> entry for Zsh, then open a new shell. Keep shared <code inline="true" class="t-editor__inline-code">compinit</code> setup used by other tools.</p>
|
|
4456
|
+
<p class="t-editor__paragraph">These scripts target installed <code inline="true" class="t-editor__inline-code">scalar</code> and <code inline="true" class="t-editor__inline-code">scalar-cli</code> executables, not <code inline="true" class="t-editor__inline-code">npx</code> or <code inline="true" class="t-editor__inline-code">pnpm dlx</code> invocations. If Git's unrelated <code inline="true" class="t-editor__inline-code">scalar</code> executable takes precedence on PATH, use npm's <code inline="true" class="t-editor__inline-code">scalar-cli</code> alias or correct your PATH before installing completions. Standalone installations provide <code inline="true" class="t-editor__inline-code">scalar</code>.</p>
|
|
4457
|
+
<h2 id="api-reference-configuration" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4458
|
+
API Reference configuration
|
|
4459
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4460
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4461
|
+
</svg>
|
|
4462
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4463
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4464
|
+
</svg></button>
|
|
4465
|
+
</h2>
|
|
4466
|
+
<p class="t-editor__paragraph">Pass API Reference options as a JSON object:</p>
|
|
4467
|
+
<div id="Q55Z7LCBpBO4OnevAOjhC" class="t-editor__code-container" data-lang="sh" style="position: relative;">
|
|
4468
|
+
<pre style="
|
|
4469
|
+
--line-digits: 2;
|
|
4470
|
+
--line-number-start: -1;
|
|
4471
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-sh" language="sh"><span class="t-code__line" data-line-number="0">scalar document serve openapi.yaml --config ./reference.config.json</span>
|
|
4472
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">sh
|
|
4473
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4474
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4475
|
+
</svg>
|
|
4476
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4477
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4478
|
+
</svg></button>
|
|
4479
|
+
</div>
|
|
4480
|
+
<div id="wtiKLQs3ELfxzR0Cc7RpK" class="t-editor__code-container" data-lang="json" style="position: relative;">
|
|
4481
|
+
<pre style="
|
|
4482
|
+
--line-digits: 2;
|
|
4483
|
+
--line-number-start: -1;
|
|
4484
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-json" language="json"><span class="t-code__line" data-line-number="0"><span class="hljs-punctuation">{</span></span>
|
|
4485
|
+
<span class="t-code__line" data-line-number="1"> <span class="hljs-attr">"orderRequiredPropertiesFirst"</span><span class="hljs-punctuation">:</span> <span class="hljs-keyword">false</span><span class="hljs-punctuation">,</span></span>
|
|
4486
|
+
<span class="t-code__line" data-line-number="2"> <span class="hljs-attr">"theme"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"purple"</span></span>
|
|
4487
|
+
<span class="t-code__line" data-line-number="3"><span class="hljs-punctuation">}</span></span>
|
|
4488
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">json
|
|
4489
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4490
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4491
|
+
</svg>
|
|
4492
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4493
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4494
|
+
</svg></button>
|
|
4495
|
+
</div>
|
|
4496
|
+
<p class="t-editor__paragraph">
|
|
4497
|
+
The configuration path is relative to the current working directory. Configuration
|
|
4498
|
+
is loaded at startup; restart the command after changing it. <code inline="true" class="t-editor__inline-code">--watch</code> continues
|
|
4499
|
+
to watch the API document. Options requiring JavaScript functions are not supported
|
|
4500
|
+
in a JSON file.
|
|
4501
|
+
</p>
|
|
4502
|
+
<h2 id="authentication-in-automation" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4503
|
+
Authentication in automation
|
|
4504
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4505
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4506
|
+
</svg>
|
|
4507
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4508
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4509
|
+
</svg></button>
|
|
4510
|
+
</h2>
|
|
4511
|
+
<p class="t-editor__paragraph">
|
|
4512
|
+
Use <code inline="true" class="t-editor__inline-code">scalar auth login --token <personal-token></code> to authenticate without a browser.
|
|
4513
|
+
Alternatively, set <code inline="true" class="t-editor__inline-code">SCALAR_API_KEY</code>. When both are provided, <code inline="true" class="t-editor__inline-code">SCALAR_API_KEY</code> takes
|
|
4514
|
+
precedence over <code inline="true" class="t-editor__inline-code">--token</code>. Unset it to use a different explicit token.
|
|
4515
|
+
</p>
|
|
4516
|
+
<p class="t-editor__paragraph">
|
|
4517
|
+
Supply required options in automation instead of relying on interactive prompts.
|
|
4518
|
+
For example, pass <code inline="true" class="t-editor__inline-code">--output</code> for document transformations.
|
|
4519
|
+
</p>
|
|
4520
|
+
<h2 id="team-discovery" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4521
|
+
Team discovery
|
|
4522
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4523
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4524
|
+
</svg>
|
|
4525
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4526
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4527
|
+
</svg></button>
|
|
4528
|
+
</h2>
|
|
4529
|
+
<p class="t-editor__paragraph">After logging in, run <code inline="true" class="t-editor__inline-code">scalar team list</code> to see your teams and their copyable UIDs. The current team is marked as the default. Use a UID with <code inline="true" class="t-editor__inline-code">scalar team set --team <uid></code> to switch teams.</p>
|
|
4530
|
+
<p class="t-editor__paragraph">Run <code inline="true" class="t-editor__inline-code">scalar team get</code> to see the current team's UID, name, slug, and namespaces. Both discovery commands support <code inline="true" class="t-editor__inline-code">--json</code> for scripts:</p>
|
|
4531
|
+
<div id="amFgCyEkohPM1xzDBfbtS" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
4532
|
+
<pre style="
|
|
4533
|
+
--line-digits: 2;
|
|
4534
|
+
--line-number-start: -1;
|
|
4535
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-bash" language="bash"><span class="t-code__line" data-line-number="0">scalar team list --json</span>
|
|
4536
|
+
<span class="t-code__line" data-line-number="1">scalar team get --json</span>
|
|
4537
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">bash
|
|
4538
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4539
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4540
|
+
</svg>
|
|
4541
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4542
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4543
|
+
</svg></button>
|
|
4544
|
+
</div>
|
|
4545
|
+
<p class="t-editor__paragraph"><code inline="true" class="t-editor__inline-code">team list --json</code> returns an array of <code inline="true" class="t-editor__inline-code">{ uid, name, current }</code> objects. <code inline="true" class="t-editor__inline-code">team get --json</code> returns <code inline="true" class="t-editor__inline-code">{ uid, name, slug, namespaces }</code>. Empty lists and namespace arrays remain empty arrays in JSON output. Personal-token logins can inspect their current team, but switching teams still requires logging in with a token for that team.</p>
|
|
4546
|
+
<h2 id="commands" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4547
|
+
Commands
|
|
4548
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4549
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4550
|
+
</svg>
|
|
4551
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4552
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4553
|
+
</svg></button>
|
|
4554
|
+
</h2>
|
|
4555
|
+
<div id="GkM4RmJJNQUvZ3SioC7TO" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4556
|
+
<pre style="
|
|
4557
|
+
--line-digits: 2;
|
|
4558
|
+
--line-number-start: -1;
|
|
4559
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar [options] [command]</span>
|
|
4560
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4561
|
+
<span class="t-code__line" data-line-number="2">CLI to work with your OpenAPI files</span>
|
|
4562
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4563
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4564
|
+
<span class="t-code__line" data-line-number="5"> -v, --version output the version number</span>
|
|
4565
|
+
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
4566
|
+
<span class="t-code__line" data-line-number="7"></span>
|
|
4567
|
+
<span class="t-code__line" data-line-number="8">Commands:</span>
|
|
4568
|
+
<span class="t-code__line" data-line-number="9"> readme Open documentation for the CLI</span>
|
|
4569
|
+
<span class="t-code__line" data-line-number="10"> upgrade Upgrade current version of your cli</span>
|
|
4570
|
+
<span class="t-code__line" data-line-number="11"> context Print every command, argument, and option as JSON for AI agents</span>
|
|
4571
|
+
<span class="t-code__line" data-line-number="12"> completion <shell> Generate shell completion definitions</span>
|
|
4572
|
+
<span class="t-code__line" data-line-number="13"> auth Manage authorization on scalar platform</span>
|
|
4573
|
+
<span class="t-code__line" data-line-number="14"> access-group Manage access groups and allowed email domains for the current team</span>
|
|
4574
|
+
<span class="t-code__line" data-line-number="15"> document Manage local openapi file</span>
|
|
4575
|
+
<span class="t-code__line" data-line-number="16"> project Manage scalar project</span>
|
|
4576
|
+
<span class="t-code__line" data-line-number="17"> registry Manage your scalar registry</span>
|
|
4577
|
+
<span class="t-code__line" data-line-number="18"> team Manage user teams</span>
|
|
4578
|
+
<span class="t-code__line" data-line-number="19"> sdk Manage your Scalar SDKs (Enterprise Only)</span>
|
|
4579
|
+
<span class="t-code__line" data-line-number="20"> schema Manage your Scalar schemas</span>
|
|
4580
|
+
<span class="t-code__line" data-line-number="21"> help [command] display help for command</span>
|
|
4581
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4582
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4583
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4584
|
+
</svg>
|
|
4585
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4586
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4587
|
+
</svg></button>
|
|
4588
|
+
</div>
|
|
4589
|
+
<h3 id="readme" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4590
|
+
readme
|
|
4591
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4592
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4593
|
+
</svg>
|
|
4594
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4595
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4596
|
+
</svg></button>
|
|
4597
|
+
</h3>
|
|
4598
|
+
<div id="FoBcmDi0EPbCogY32kzTY" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4599
|
+
<pre style="
|
|
4600
|
+
--line-digits: 2;
|
|
4601
|
+
--line-number-start: -1;
|
|
4120
4602
|
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar readme [options] [command]</span>
|
|
4121
4603
|
<span class="t-code__line" data-line-number="1"></span>
|
|
4122
4604
|
<span class="t-code__line" data-line-number="2">Open documentation for the CLI</span>
|
|
@@ -4143,7 +4625,7 @@ blockquote.t-editor__quote > * {
|
|
|
4143
4625
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4144
4626
|
</svg></button>
|
|
4145
4627
|
</h4>
|
|
4146
|
-
<div id="
|
|
4628
|
+
<div id="46NOb7I7NKg8sAgdxLTmJ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4147
4629
|
<pre style="
|
|
4148
4630
|
--line-digits: 2;
|
|
4149
4631
|
--line-number-start: -1;
|
|
@@ -4171,7 +4653,7 @@ blockquote.t-editor__quote > * {
|
|
|
4171
4653
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4172
4654
|
</svg></button>
|
|
4173
4655
|
</h3>
|
|
4174
|
-
<div id="
|
|
4656
|
+
<div id="MRBy9YcpnsjBHRnSHstBM" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4175
4657
|
<pre style="
|
|
4176
4658
|
--line-digits: 2;
|
|
4177
4659
|
--line-number-start: -1;
|
|
@@ -4198,7 +4680,7 @@ blockquote.t-editor__quote > * {
|
|
|
4198
4680
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4199
4681
|
</svg></button>
|
|
4200
4682
|
</h3>
|
|
4201
|
-
<div id="
|
|
4683
|
+
<div id="OfqXgd6VYZoQjR6xhm6u8" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4202
4684
|
<pre style="
|
|
4203
4685
|
--line-digits: 2;
|
|
4204
4686
|
--line-number-start: -1;
|
|
@@ -4216,6 +4698,36 @@ blockquote.t-editor__quote > * {
|
|
|
4216
4698
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4217
4699
|
</svg></button>
|
|
4218
4700
|
</div>
|
|
4701
|
+
<h3 id="completion" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4702
|
+
completion
|
|
4703
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4704
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4705
|
+
</svg>
|
|
4706
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4707
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4708
|
+
</svg></button>
|
|
4709
|
+
</h3>
|
|
4710
|
+
<div id="GYERxlhsE5EiMYAUM4wFq" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4711
|
+
<pre style="
|
|
4712
|
+
--line-digits: 2;
|
|
4713
|
+
--line-number-start: -1;
|
|
4714
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar completion [options] <shell></span>
|
|
4715
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4716
|
+
<span class="t-code__line" data-line-number="2">Generate shell completion definitions</span>
|
|
4717
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4718
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4719
|
+
<span class="t-code__line" data-line-number="5"> shell Shell to configure (choices: "bash", "zsh", "fish")</span>
|
|
4720
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
4721
|
+
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
4722
|
+
<span class="t-code__line" data-line-number="8"> -h, --help display help for command</span>
|
|
4723
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4724
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4725
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4726
|
+
</svg>
|
|
4727
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4728
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4729
|
+
</svg></button>
|
|
4730
|
+
</div>
|
|
4219
4731
|
<h3 id="auth" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4220
4732
|
auth
|
|
4221
4733
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
@@ -4225,7 +4737,7 @@ blockquote.t-editor__quote > * {
|
|
|
4225
4737
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4226
4738
|
</svg></button>
|
|
4227
4739
|
</h3>
|
|
4228
|
-
<div id="
|
|
4740
|
+
<div id="g1lB5G9zvy1xPRyvHNRaB" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4229
4741
|
<pre style="
|
|
4230
4742
|
--line-digits: 2;
|
|
4231
4743
|
--line-number-start: -1;
|
|
@@ -4249,8 +4761,284 @@ blockquote.t-editor__quote > * {
|
|
|
4249
4761
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4250
4762
|
</svg></button>
|
|
4251
4763
|
</div>
|
|
4252
|
-
<h4 id="login" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4253
|
-
login
|
|
4764
|
+
<h4 id="login" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4765
|
+
login
|
|
4766
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4767
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4768
|
+
</svg>
|
|
4769
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4770
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4771
|
+
</svg></button>
|
|
4772
|
+
</h4>
|
|
4773
|
+
<div id="YMRVeXMZAcrH0MH3OEYwa" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4774
|
+
<pre style="
|
|
4775
|
+
--line-digits: 2;
|
|
4776
|
+
--line-number-start: -1;
|
|
4777
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar auth login [options]</span>
|
|
4778
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4779
|
+
<span class="t-code__line" data-line-number="2">Login to scalar</span>
|
|
4780
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4781
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4782
|
+
<span class="t-code__line" data-line-number="5"> --token <token> Personal token</span>
|
|
4783
|
+
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
4784
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4785
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4786
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4787
|
+
</svg>
|
|
4788
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4789
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4790
|
+
</svg></button>
|
|
4791
|
+
</div>
|
|
4792
|
+
<h4 id="whoami" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4793
|
+
whoami
|
|
4794
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4795
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4796
|
+
</svg>
|
|
4797
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4798
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4799
|
+
</svg></button>
|
|
4800
|
+
</h4>
|
|
4801
|
+
<div id="5iy2Za9PGW0fwtypuEL2v" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4802
|
+
<pre style="
|
|
4803
|
+
--line-digits: 2;
|
|
4804
|
+
--line-number-start: -1;
|
|
4805
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar auth whoami [options]</span>
|
|
4806
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4807
|
+
<span class="t-code__line" data-line-number="2">Display the current user</span>
|
|
4808
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4809
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4810
|
+
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
4811
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4812
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4813
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4814
|
+
</svg>
|
|
4815
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4816
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4817
|
+
</svg></button>
|
|
4818
|
+
</div>
|
|
4819
|
+
<h4 id="logout" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4820
|
+
logout
|
|
4821
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4822
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4823
|
+
</svg>
|
|
4824
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4825
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4826
|
+
</svg></button>
|
|
4827
|
+
</h4>
|
|
4828
|
+
<div id="tidjSb8c5n8H5PI37Be9f" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4829
|
+
<pre style="
|
|
4830
|
+
--line-digits: 2;
|
|
4831
|
+
--line-number-start: -1;
|
|
4832
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar auth logout [options]</span>
|
|
4833
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4834
|
+
<span class="t-code__line" data-line-number="2">Logout from scalar</span>
|
|
4835
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4836
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4837
|
+
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
4838
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4839
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4840
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4841
|
+
</svg>
|
|
4842
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4843
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4844
|
+
</svg></button>
|
|
4845
|
+
</div>
|
|
4846
|
+
<h3 id="access-group" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4847
|
+
access-group
|
|
4848
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4849
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4850
|
+
</svg>
|
|
4851
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4852
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4853
|
+
</svg></button>
|
|
4854
|
+
</h3>
|
|
4855
|
+
<div id="OFnpZdjkubzjCNr4AsAmw" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4856
|
+
<pre style="
|
|
4857
|
+
--line-digits: 2;
|
|
4858
|
+
--line-number-start: -1;
|
|
4859
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group [options] [command]</span>
|
|
4860
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4861
|
+
<span class="t-code__line" data-line-number="2">Manage access groups and allowed email domains for the current team</span>
|
|
4862
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4863
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4864
|
+
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
4865
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
4866
|
+
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
4867
|
+
<span class="t-code__line" data-line-number="8"> list [options] List access groups for the current team</span>
|
|
4868
|
+
<span class="t-code__line" data-line-number="9"> create [options] <slug> Create an access group (Pro or above)</span>
|
|
4869
|
+
<span class="t-code__line" data-line-number="10"> get [options] <slug> Get an access group and its allowlists</span>
|
|
4870
|
+
<span class="t-code__line" data-line-number="11"> update [options] <slug> Update access group metadata</span>
|
|
4871
|
+
<span class="t-code__line" data-line-number="12"> delete [options] <slug> Delete an access group and remove its project</span>
|
|
4872
|
+
<span class="t-code__line" data-line-number="13"> assignments</span>
|
|
4873
|
+
<span class="t-code__line" data-line-number="14"> domain Manage allowed email domains</span>
|
|
4874
|
+
<span class="t-code__line" data-line-number="15"> help [command] display help for command</span>
|
|
4875
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4876
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4877
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4878
|
+
</svg>
|
|
4879
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4880
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4881
|
+
</svg></button>
|
|
4882
|
+
</div>
|
|
4883
|
+
<h4 id="list" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4884
|
+
list
|
|
4885
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4886
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4887
|
+
</svg>
|
|
4888
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4889
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4890
|
+
</svg></button>
|
|
4891
|
+
</h4>
|
|
4892
|
+
<div id="Uib4f1QF4ilcuTiYIYCbD" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4893
|
+
<pre style="
|
|
4894
|
+
--line-digits: 2;
|
|
4895
|
+
--line-number-start: -1;
|
|
4896
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group list [options]</span>
|
|
4897
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4898
|
+
<span class="t-code__line" data-line-number="2">List access groups for the current team</span>
|
|
4899
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4900
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4901
|
+
<span class="t-code__line" data-line-number="5"> --json Print the result as JSON</span>
|
|
4902
|
+
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
4903
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4904
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4905
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4906
|
+
</svg>
|
|
4907
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4908
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4909
|
+
</svg></button>
|
|
4910
|
+
</div>
|
|
4911
|
+
<h4 id="create" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4912
|
+
create
|
|
4913
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4914
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4915
|
+
</svg>
|
|
4916
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4917
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4918
|
+
</svg></button>
|
|
4919
|
+
</h4>
|
|
4920
|
+
<div id="DQzVGyk2S8oCG6Tyaxsmq" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4921
|
+
<pre style="
|
|
4922
|
+
--line-digits: 2;
|
|
4923
|
+
--line-number-start: -1;
|
|
4924
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group create [options] <slug></span>
|
|
4925
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4926
|
+
<span class="t-code__line" data-line-number="2">Create an access group (Pro or above)</span>
|
|
4927
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4928
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4929
|
+
<span class="t-code__line" data-line-number="5"> slug New access group slug</span>
|
|
4930
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
4931
|
+
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
4932
|
+
<span class="t-code__line" data-line-number="8"> --name <name> Display name</span>
|
|
4933
|
+
<span class="t-code__line" data-line-number="9"> --domain <domains...> Allowed email domains</span>
|
|
4934
|
+
<span class="t-code__line" data-line-number="10"> --json Print the result as JSON</span>
|
|
4935
|
+
<span class="t-code__line" data-line-number="11"> -h, --help display help for command</span>
|
|
4936
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4937
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4938
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4939
|
+
</svg>
|
|
4940
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4941
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4942
|
+
</svg></button>
|
|
4943
|
+
</div>
|
|
4944
|
+
<h4 id="get" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4945
|
+
get
|
|
4946
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4947
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4948
|
+
</svg>
|
|
4949
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4950
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4951
|
+
</svg></button>
|
|
4952
|
+
</h4>
|
|
4953
|
+
<div id="WN1AIfHcGySPeGk6nZ4Lf" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4954
|
+
<pre style="
|
|
4955
|
+
--line-digits: 2;
|
|
4956
|
+
--line-number-start: -1;
|
|
4957
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group get [options] <slug></span>
|
|
4958
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4959
|
+
<span class="t-code__line" data-line-number="2">Get an access group and its allowlists</span>
|
|
4960
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4961
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4962
|
+
<span class="t-code__line" data-line-number="5"> slug Access group slug</span>
|
|
4963
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
4964
|
+
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
4965
|
+
<span class="t-code__line" data-line-number="8"> --json Print the result as JSON</span>
|
|
4966
|
+
<span class="t-code__line" data-line-number="9"> -h, --help display help for command</span>
|
|
4967
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4968
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4969
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
4970
|
+
</svg>
|
|
4971
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4972
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4973
|
+
</svg></button>
|
|
4974
|
+
</div>
|
|
4975
|
+
<h4 id="update" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4976
|
+
update
|
|
4977
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4978
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4979
|
+
</svg>
|
|
4980
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4981
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4982
|
+
</svg></button>
|
|
4983
|
+
</h4>
|
|
4984
|
+
<div id="t8jF7ixMZPbAkqUcq2Wri" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4985
|
+
<pre style="
|
|
4986
|
+
--line-digits: 2;
|
|
4987
|
+
--line-number-start: -1;
|
|
4988
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group update [options] <slug></span>
|
|
4989
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
4990
|
+
<span class="t-code__line" data-line-number="2">Update access group metadata</span>
|
|
4991
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
4992
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4993
|
+
<span class="t-code__line" data-line-number="5"> slug Current access group slug</span>
|
|
4994
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
4995
|
+
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
4996
|
+
<span class="t-code__line" data-line-number="8"> --name <name> New display name</span>
|
|
4997
|
+
<span class="t-code__line" data-line-number="9"> --new-slug <slug> New access group slug</span>
|
|
4998
|
+
<span class="t-code__line" data-line-number="10"> --json Print the result as JSON</span>
|
|
4999
|
+
<span class="t-code__line" data-line-number="11"> -h, --help display help for command</span>
|
|
5000
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5001
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5002
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5003
|
+
</svg>
|
|
5004
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5005
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5006
|
+
</svg></button>
|
|
5007
|
+
</div>
|
|
5008
|
+
<h4 id="delete" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5009
|
+
delete
|
|
5010
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5011
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5012
|
+
</svg>
|
|
5013
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
5014
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5015
|
+
</svg></button>
|
|
5016
|
+
</h4>
|
|
5017
|
+
<div id="HQatpyDPTNw3VVRCjeYCI" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5018
|
+
<pre style="
|
|
5019
|
+
--line-digits: 2;
|
|
5020
|
+
--line-number-start: -1;
|
|
5021
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group delete [options] <slug></span>
|
|
5022
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
5023
|
+
<span class="t-code__line" data-line-number="2">Delete an access group and remove its project assignments</span>
|
|
5024
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
5025
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
5026
|
+
<span class="t-code__line" data-line-number="5"> slug Access group slug</span>
|
|
5027
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
5028
|
+
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
5029
|
+
<span class="t-code__line" data-line-number="8"> -y, --yes Confirm deletion without prompting</span>
|
|
5030
|
+
<span class="t-code__line" data-line-number="9"> --json Print the result as JSON (requires --yes)</span>
|
|
5031
|
+
<span class="t-code__line" data-line-number="10"> -h, --help display help for command</span>
|
|
5032
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5033
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5034
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5035
|
+
</svg>
|
|
5036
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5037
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5038
|
+
</svg></button>
|
|
5039
|
+
</div>
|
|
5040
|
+
<h4 id="domain" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5041
|
+
domain
|
|
4254
5042
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4255
5043
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4256
5044
|
</svg>
|
|
@@ -4258,19 +5046,22 @@ blockquote.t-editor__quote > * {
|
|
|
4258
5046
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4259
5047
|
</svg></button>
|
|
4260
5048
|
</h4>
|
|
4261
|
-
<div id="
|
|
5049
|
+
<div id="RlMa3XioA7HQY70mXvwbq" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4262
5050
|
<pre style="
|
|
4263
5051
|
--line-digits: 2;
|
|
4264
5052
|
--line-number-start: -1;
|
|
4265
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar
|
|
5053
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group domain [options] [command]</span>
|
|
4266
5054
|
<span class="t-code__line" data-line-number="1"></span>
|
|
4267
|
-
<span class="t-code__line" data-line-number="2">
|
|
5055
|
+
<span class="t-code__line" data-line-number="2">Manage allowed email domains</span>
|
|
4268
5056
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4269
5057
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4270
|
-
<span class="t-code__line" data-line-number="5"> --
|
|
4271
|
-
<span class="t-code__line" data-line-number="6"
|
|
4272
|
-
<span class="t-code__line" data-line-number="7">
|
|
4273
|
-
<span class="t-code__line" data-line-number="8">
|
|
5058
|
+
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
5059
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
5060
|
+
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
5061
|
+
<span class="t-code__line" data-line-number="8"> add [options] <slug> <domain> Add an exact email domain to an access group</span>
|
|
5062
|
+
<span class="t-code__line" data-line-number="9"> remove [options] <slug> <domain> Remove an exact email domain from an access</span>
|
|
5063
|
+
<span class="t-code__line" data-line-number="10"> group</span>
|
|
5064
|
+
<span class="t-code__line" data-line-number="11"> help [command] display help for command</span>
|
|
4274
5065
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4275
5066
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4276
5067
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4279,25 +5070,22 @@ blockquote.t-editor__quote > * {
|
|
|
4279
5070
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4280
5071
|
</svg></button>
|
|
4281
5072
|
</div>
|
|
4282
|
-
<
|
|
4283
|
-
|
|
4284
|
-
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4285
|
-
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4286
|
-
</svg>
|
|
4287
|
-
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4288
|
-
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4289
|
-
</svg></button>
|
|
4290
|
-
</h4>
|
|
4291
|
-
<div id="aPhCXlkhttujepxM4SS9X" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5073
|
+
<h5 id="" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="5" data-scalar-type="heading">add</h5>
|
|
5074
|
+
<div id="6iD06LiHpAILCP18z27F2" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4292
5075
|
<pre style="
|
|
4293
5076
|
--line-digits: 2;
|
|
4294
5077
|
--line-number-start: -1;
|
|
4295
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar
|
|
5078
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group domain add [options] <slug> <domain></span>
|
|
4296
5079
|
<span class="t-code__line" data-line-number="1"></span>
|
|
4297
|
-
<span class="t-code__line" data-line-number="2">
|
|
5080
|
+
<span class="t-code__line" data-line-number="2">Add an exact email domain to an access group</span>
|
|
4298
5081
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4299
|
-
<span class="t-code__line" data-line-number="4">
|
|
4300
|
-
<span class="t-code__line" data-line-number="5">
|
|
5082
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
5083
|
+
<span class="t-code__line" data-line-number="5"> slug Access group slug</span>
|
|
5084
|
+
<span class="t-code__line" data-line-number="6"> domain Email domain, such as example.com</span>
|
|
5085
|
+
<span class="t-code__line" data-line-number="7"></span>
|
|
5086
|
+
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
5087
|
+
<span class="t-code__line" data-line-number="9"> --json Print the result as JSON</span>
|
|
5088
|
+
<span class="t-code__line" data-line-number="10"> -h, --help display help for command</span>
|
|
4301
5089
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4302
5090
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4303
5091
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4306,25 +5094,22 @@ blockquote.t-editor__quote > * {
|
|
|
4306
5094
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4307
5095
|
</svg></button>
|
|
4308
5096
|
</div>
|
|
4309
|
-
<
|
|
4310
|
-
|
|
4311
|
-
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4312
|
-
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4313
|
-
</svg>
|
|
4314
|
-
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
4315
|
-
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4316
|
-
</svg></button>
|
|
4317
|
-
</h4>
|
|
4318
|
-
<div id="WpnKGEPYOtAj4XvwLZKNp" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5097
|
+
<h5 id="" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="5" data-scalar-type="heading">remove</h5>
|
|
5098
|
+
<div id="va4KG29xTzimaBU3Dcw1Y" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4319
5099
|
<pre style="
|
|
4320
5100
|
--line-digits: 2;
|
|
4321
5101
|
--line-number-start: -1;
|
|
4322
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar
|
|
5102
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar access-group domain remove [options] <slug> <domain></span>
|
|
4323
5103
|
<span class="t-code__line" data-line-number="1"></span>
|
|
4324
|
-
<span class="t-code__line" data-line-number="2">
|
|
5104
|
+
<span class="t-code__line" data-line-number="2">Remove an exact email domain from an access group</span>
|
|
4325
5105
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4326
|
-
<span class="t-code__line" data-line-number="4">
|
|
4327
|
-
<span class="t-code__line" data-line-number="5">
|
|
5106
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
5107
|
+
<span class="t-code__line" data-line-number="5"> slug Access group slug</span>
|
|
5108
|
+
<span class="t-code__line" data-line-number="6"> domain Email domain, such as example.com</span>
|
|
5109
|
+
<span class="t-code__line" data-line-number="7"></span>
|
|
5110
|
+
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
5111
|
+
<span class="t-code__line" data-line-number="9"> --json Print the result as JSON</span>
|
|
5112
|
+
<span class="t-code__line" data-line-number="10"> -h, --help display help for command</span>
|
|
4328
5113
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4329
5114
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4330
5115
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4342,7 +5127,7 @@ blockquote.t-editor__quote > * {
|
|
|
4342
5127
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4343
5128
|
</svg></button>
|
|
4344
5129
|
</h3>
|
|
4345
|
-
<div id="
|
|
5130
|
+
<div id="DJ1xMo9COaG4mrs9SkApL" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4346
5131
|
<pre style="
|
|
4347
5132
|
--line-digits: 2;
|
|
4348
5133
|
--line-number-start: -1;
|
|
@@ -4354,20 +5139,28 @@ blockquote.t-editor__quote > * {
|
|
|
4354
5139
|
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
4355
5140
|
<span class="t-code__line" data-line-number="6"></span>
|
|
4356
5141
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
4357
|
-
<span class="t-code__line" data-line-number="8"> bundle [options] [file|url] Bundle an OpenAPI document by resolving all
|
|
4358
|
-
<span class="t-code__line" data-line-number="9">
|
|
4359
|
-
<span class="t-code__line" data-line-number="10">
|
|
4360
|
-
<span class="t-code__line" data-line-number="11">
|
|
4361
|
-
<span class="t-code__line" data-line-number="12">
|
|
4362
|
-
<span class="t-code__line" data-line-number="13">
|
|
4363
|
-
<span class="t-code__line" data-line-number="14">
|
|
4364
|
-
<span class="t-code__line" data-line-number="15">
|
|
4365
|
-
<span class="t-code__line" data-line-number="16">
|
|
4366
|
-
<span class="t-code__line" data-line-number="17">
|
|
4367
|
-
<span class="t-code__line" data-line-number="18">
|
|
4368
|
-
<span class="t-code__line" data-line-number="19">
|
|
4369
|
-
<span class="t-code__line" data-line-number="20">
|
|
4370
|
-
<span class="t-code__line" data-line-number="21">
|
|
5142
|
+
<span class="t-code__line" data-line-number="8"> bundle [options] [file|url] Bundle an OpenAPI document by resolving all</span>
|
|
5143
|
+
<span class="t-code__line" data-line-number="9"> references and external dependencies</span>
|
|
5144
|
+
<span class="t-code__line" data-line-number="10"> split [options] [file|url] Split OpenAPI or AsyncAPI documents into small</span>
|
|
5145
|
+
<span class="t-code__line" data-line-number="11"> chunks</span>
|
|
5146
|
+
<span class="t-code__line" data-line-number="12"> join [options] <files...> Merge multiple OpenAPI or AsyncAPI documents</span>
|
|
5147
|
+
<span class="t-code__line" data-line-number="13"> into a single unified document</span>
|
|
5148
|
+
<span class="t-code__line" data-line-number="14"> format [options] [file|url] Format an OpenAPI or AsyncAPI file</span>
|
|
5149
|
+
<span class="t-code__line" data-line-number="15"> convert [options] [file|url] Convert a Postman collection to an OpenAPI</span>
|
|
5150
|
+
<span class="t-code__line" data-line-number="16"> document</span>
|
|
5151
|
+
<span class="t-code__line" data-line-number="17"> markdown [options] [file|url] Generate Markdown from an OpenAPI file</span>
|
|
5152
|
+
<span class="t-code__line" data-line-number="18"> mock [options] [file|url] Mock an OpenAPI API or AsyncAPI WebSocket and</span>
|
|
5153
|
+
<span class="t-code__line" data-line-number="19"> SSE channels</span>
|
|
5154
|
+
<span class="t-code__line" data-line-number="20"> serve [options] [file|url] Serve an API Reference from an OpenAPI or</span>
|
|
5155
|
+
<span class="t-code__line" data-line-number="21"> AsyncAPI file</span>
|
|
5156
|
+
<span class="t-code__line" data-line-number="22"> share [options] [file] Share an OpenAPI or AsyncAPI file</span>
|
|
5157
|
+
<span class="t-code__line" data-line-number="23"> validate [file|url] Validate an OpenAPI or AsyncAPI file</span>
|
|
5158
|
+
<span class="t-code__line" data-line-number="24"> void [options] Boot a server to mirror HTTP requests</span>
|
|
5159
|
+
<span class="t-code__line" data-line-number="25"> lint [options] [file|url] Lint your OpenAPI or AsyncAPI file using</span>
|
|
5160
|
+
<span class="t-code__line" data-line-number="26"> spectral rules</span>
|
|
5161
|
+
<span class="t-code__line" data-line-number="27"> upgrade [options] [file|url] Upgrade an OpenAPI or AsyncAPI document to</span>
|
|
5162
|
+
<span class="t-code__line" data-line-number="28"> version 3.1</span>
|
|
5163
|
+
<span class="t-code__line" data-line-number="29"> help [command] display help for command</span>
|
|
4371
5164
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4372
5165
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4373
5166
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4385,7 +5178,7 @@ blockquote.t-editor__quote > * {
|
|
|
4385
5178
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4386
5179
|
</svg></button>
|
|
4387
5180
|
</h4>
|
|
4388
|
-
<div id="
|
|
5181
|
+
<div id="yk6dqyO1j2oJ2n3srsI2Y" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4389
5182
|
<pre style="
|
|
4390
5183
|
--line-digits: 2;
|
|
4391
5184
|
--line-number-start: -1;
|
|
@@ -4400,8 +5193,9 @@ blockquote.t-editor__quote > * {
|
|
|
4400
5193
|
<span class="t-code__line" data-line-number="8"> -o, --output <file> Path to save the bundled output file</span>
|
|
4401
5194
|
<span class="t-code__line" data-line-number="9"> --treeShake Remove unused components from the bundled output</span>
|
|
4402
5195
|
<span class="t-code__line" data-line-number="10"> --urlMap Generate a map of resolved URLs in the bundled output</span>
|
|
4403
|
-
<span class="t-code__line" data-line-number="11"> --fetchLimit <limit> Maximum number of URLs to fetch during bundling at the
|
|
4404
|
-
<span class="t-code__line" data-line-number="12">
|
|
5196
|
+
<span class="t-code__line" data-line-number="11"> --fetchLimit <limit> Maximum number of URLs to fetch during bundling at the</span>
|
|
5197
|
+
<span class="t-code__line" data-line-number="12"> same time</span>
|
|
5198
|
+
<span class="t-code__line" data-line-number="13"> -h, --help display help for command</span>
|
|
4405
5199
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4406
5200
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4407
5201
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4419,7 +5213,7 @@ blockquote.t-editor__quote > * {
|
|
|
4419
5213
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4420
5214
|
</svg></button>
|
|
4421
5215
|
</h4>
|
|
4422
|
-
<div id="
|
|
5216
|
+
<div id="7J4fRrNTSPAGPQZxxMmWG" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4423
5217
|
<pre style="
|
|
4424
5218
|
--line-digits: 2;
|
|
4425
5219
|
--line-number-start: -1;
|
|
@@ -4450,7 +5244,7 @@ blockquote.t-editor__quote > * {
|
|
|
4450
5244
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4451
5245
|
</svg></button>
|
|
4452
5246
|
</h4>
|
|
4453
|
-
<div id="
|
|
5247
|
+
<div id="qRnHpLg64ykOmMadVH512" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4454
5248
|
<pre style="
|
|
4455
5249
|
--line-digits: 2;
|
|
4456
5250
|
--line-number-start: -1;
|
|
@@ -4459,12 +5253,12 @@ blockquote.t-editor__quote > * {
|
|
|
4459
5253
|
<span class="t-code__line" data-line-number="2">Merge multiple OpenAPI or AsyncAPI documents into a single unified document</span>
|
|
4460
5254
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4461
5255
|
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4462
|
-
<span class="t-code__line" data-line-number="5"> files
|
|
5256
|
+
<span class="t-code__line" data-line-number="5"> files Paths to the OpenAPI or AsyncAPI files to merge</span>
|
|
4463
5257
|
<span class="t-code__line" data-line-number="6"></span>
|
|
4464
5258
|
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
4465
|
-
<span class="t-code__line" data-line-number="8"> --output
|
|
4466
|
-
<span class="t-code__line" data-line-number="9"> --prefix-components-with-path-value
|
|
4467
|
-
<span class="t-code__line" data-line-number="10"> -h, --help
|
|
5259
|
+
<span class="t-code__line" data-line-number="8"> -o, --output <file> Path to save the merged output file</span>
|
|
5260
|
+
<span class="t-code__line" data-line-number="9"> -p, --prefix-components-with-path-value <path> Dot-separated path to extract a prefix value from each input file for component names</span>
|
|
5261
|
+
<span class="t-code__line" data-line-number="10"> -h, --help display help for command</span>
|
|
4468
5262
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4469
5263
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4470
5264
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4482,7 +5276,7 @@ blockquote.t-editor__quote > * {
|
|
|
4482
5276
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4483
5277
|
</svg></button>
|
|
4484
5278
|
</h4>
|
|
4485
|
-
<div id="
|
|
5279
|
+
<div id="3WTqsazC4BJt89sXz8LaZ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4486
5280
|
<pre style="
|
|
4487
5281
|
--line-digits: 2;
|
|
4488
5282
|
--line-number-start: -1;
|
|
@@ -4513,7 +5307,7 @@ blockquote.t-editor__quote > * {
|
|
|
4513
5307
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4514
5308
|
</svg></button>
|
|
4515
5309
|
</h4>
|
|
4516
|
-
<div id="
|
|
5310
|
+
<div id="asfS3KQ3RXKmDeHPQuMrI" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4517
5311
|
<pre style="
|
|
4518
5312
|
--line-digits: 2;
|
|
4519
5313
|
--line-number-start: -1;
|
|
@@ -4545,7 +5339,7 @@ blockquote.t-editor__quote > * {
|
|
|
4545
5339
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4546
5340
|
</svg></button>
|
|
4547
5341
|
</h4>
|
|
4548
|
-
<div id="
|
|
5342
|
+
<div id="2ZN4xs0PZJvZ3t9zoqxNQ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4549
5343
|
<pre style="
|
|
4550
5344
|
--line-digits: 2;
|
|
4551
5345
|
--line-number-start: -1;
|
|
@@ -4576,7 +5370,7 @@ blockquote.t-editor__quote > * {
|
|
|
4576
5370
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4577
5371
|
</svg></button>
|
|
4578
5372
|
</h4>
|
|
4579
|
-
<div id="
|
|
5373
|
+
<div id="ewpsXzDCAOYAxSE9DrVAS" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4580
5374
|
<pre style="
|
|
4581
5375
|
--line-digits: 2;
|
|
4582
5376
|
--line-number-start: -1;
|
|
@@ -4609,7 +5403,7 @@ blockquote.t-editor__quote > * {
|
|
|
4609
5403
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4610
5404
|
</svg></button>
|
|
4611
5405
|
</h4>
|
|
4612
|
-
<div id="
|
|
5406
|
+
<div id="CcMRBmW1XZnmSfc3D0moe" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4613
5407
|
<pre style="
|
|
4614
5408
|
--line-digits: 2;
|
|
4615
5409
|
--line-number-start: -1;
|
|
@@ -4643,7 +5437,7 @@ blockquote.t-editor__quote > * {
|
|
|
4643
5437
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4644
5438
|
</svg></button>
|
|
4645
5439
|
</h4>
|
|
4646
|
-
<div id="
|
|
5440
|
+
<div id="8znhgzY74xDDA7UUYArch" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4647
5441
|
<pre style="
|
|
4648
5442
|
--line-digits: 2;
|
|
4649
5443
|
--line-number-start: -1;
|
|
@@ -4674,7 +5468,7 @@ blockquote.t-editor__quote > * {
|
|
|
4674
5468
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4675
5469
|
</svg></button>
|
|
4676
5470
|
</h4>
|
|
4677
|
-
<div id="
|
|
5471
|
+
<div id="oAH4NcHIlBAkfw2Pa0PlS" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4678
5472
|
<pre style="
|
|
4679
5473
|
--line-digits: 2;
|
|
4680
5474
|
--line-number-start: -1;
|
|
@@ -4704,7 +5498,7 @@ blockquote.t-editor__quote > * {
|
|
|
4704
5498
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4705
5499
|
</svg></button>
|
|
4706
5500
|
</h4>
|
|
4707
|
-
<div id="
|
|
5501
|
+
<div id="Z9VyuY28wg3II89spZtxO" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4708
5502
|
<pre style="
|
|
4709
5503
|
--line-digits: 2;
|
|
4710
5504
|
--line-number-start: -1;
|
|
@@ -4733,7 +5527,7 @@ blockquote.t-editor__quote > * {
|
|
|
4733
5527
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4734
5528
|
</svg></button>
|
|
4735
5529
|
</h4>
|
|
4736
|
-
<div id="
|
|
5530
|
+
<div id="flwpLRoGTGBJmOsOp3Pln" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4737
5531
|
<pre style="
|
|
4738
5532
|
--line-digits: 2;
|
|
4739
5533
|
--line-number-start: -1;
|
|
@@ -4742,11 +5536,20 @@ blockquote.t-editor__quote > * {
|
|
|
4742
5536
|
<span class="t-code__line" data-line-number="2">Lint your OpenAPI or AsyncAPI file using spectral rules</span>
|
|
4743
5537
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4744
5538
|
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4745
|
-
<span class="t-code__line" data-line-number="5"> file|url
|
|
5539
|
+
<span class="t-code__line" data-line-number="5"> file|url OpenAPI or AsyncAPI file path or url</span>
|
|
4746
5540
|
<span class="t-code__line" data-line-number="6"></span>
|
|
4747
5541
|
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
4748
|
-
<span class="t-code__line" data-line-number="8"> -r, --rule <file|url>
|
|
4749
|
-
<span class="t-code__line" data-line-number="9">
|
|
5542
|
+
<span class="t-code__line" data-line-number="8"> -r, --rule <file|url> Rule path or url</span>
|
|
5543
|
+
<span class="t-code__line" data-line-number="9"> --format <format> Report format (choices: "text", "codeframe",</span>
|
|
5544
|
+
<span class="t-code__line" data-line-number="10"> "markdown", "summary", "json", "github-actions",</span>
|
|
5545
|
+
<span class="t-code__line" data-line-number="11"> "junit", default: "codeframe")</span>
|
|
5546
|
+
<span class="t-code__line" data-line-number="12"> --max-problems <number> Maximum displayed findings (totals and exit status</span>
|
|
5547
|
+
<span class="t-code__line" data-line-number="13"> include all findings) (default: 100)</span>
|
|
5548
|
+
<span class="t-code__line" data-line-number="14"> -o, --output <file> Write the report to a file instead of stdout</span>
|
|
5549
|
+
<span class="t-code__line" data-line-number="15"> --generate-ignore-file Record current findings in the ignore baseline</span>
|
|
5550
|
+
<span class="t-code__line" data-line-number="16"> --ignore-file <file> Ignore baseline path (Scalar file takes priority over</span>
|
|
5551
|
+
<span class="t-code__line" data-line-number="17"> Redocly fallback in the current directory)</span>
|
|
5552
|
+
<span class="t-code__line" data-line-number="18"> -h, --help display help for command</span>
|
|
4750
5553
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4751
5554
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4752
5555
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4764,7 +5567,7 @@ blockquote.t-editor__quote > * {
|
|
|
4764
5567
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4765
5568
|
</svg></button>
|
|
4766
5569
|
</h4>
|
|
4767
|
-
<div id="
|
|
5570
|
+
<div id="f8GnURWXzQGd5mAEHVJTM" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4768
5571
|
<pre style="
|
|
4769
5572
|
--line-digits: 2;
|
|
4770
5573
|
--line-number-start: -1;
|
|
@@ -4795,7 +5598,7 @@ blockquote.t-editor__quote > * {
|
|
|
4795
5598
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4796
5599
|
</svg></button>
|
|
4797
5600
|
</h3>
|
|
4798
|
-
<div id="
|
|
5601
|
+
<div id="QwG6sIqq9ROCIOWiAFh0o" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4799
5602
|
<pre style="
|
|
4800
5603
|
--line-digits: 2;
|
|
4801
5604
|
--line-number-start: -1;
|
|
@@ -4807,15 +5610,80 @@ blockquote.t-editor__quote > * {
|
|
|
4807
5610
|
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
4808
5611
|
<span class="t-code__line" data-line-number="6"></span>
|
|
4809
5612
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
4810
|
-
<span class="t-code__line" data-line-number="8">
|
|
4811
|
-
<span class="t-code__line" data-line-number="9">
|
|
4812
|
-
<span class="t-code__line" data-line-number="10">
|
|
4813
|
-
<span class="t-code__line" data-line-number="11">
|
|
4814
|
-
<span class="t-code__line" data-line-number="12">
|
|
4815
|
-
<span class="t-code__line" data-line-number="13">
|
|
4816
|
-
<span class="t-code__line" data-line-number="14">
|
|
4817
|
-
<span class="t-code__line" data-line-number="15">
|
|
4818
|
-
<span class="t-code__line" data-line-number="16">
|
|
5613
|
+
<span class="t-code__line" data-line-number="8"> list [options] List projects and their slugs for the current</span>
|
|
5614
|
+
<span class="t-code__line" data-line-number="9"> team.</span>
|
|
5615
|
+
<span class="t-code__line" data-line-number="10"> get [options] <slug> Get project details for the current team.</span>
|
|
5616
|
+
<span class="t-code__line" data-line-number="11"> init [options] Create a new Scalar Docs project.</span>
|
|
5617
|
+
<span class="t-code__line" data-line-number="12"> check-config [file] Check a Scalar Configuration file</span>
|
|
5618
|
+
<span class="t-code__line" data-line-number="13"> create [options] Create a new project that is not linked to a</span>
|
|
5619
|
+
<span class="t-code__line" data-line-number="14"> github project.</span>
|
|
5620
|
+
<span class="t-code__line" data-line-number="15"> preview [options] [config] Preview scalar guides</span>
|
|
5621
|
+
<span class="t-code__line" data-line-number="16"> publish [options] Publish new build for a github sync project that</span>
|
|
5622
|
+
<span class="t-code__line" data-line-number="17"> is not linked.</span>
|
|
5623
|
+
<span class="t-code__line" data-line-number="18"> rollback [options] Roll the live deployment back to a previously</span>
|
|
5624
|
+
<span class="t-code__line" data-line-number="19"> deployed build.</span>
|
|
5625
|
+
<span class="t-code__line" data-line-number="20"> deployments Inspect a project deployment history.</span>
|
|
5626
|
+
<span class="t-code__line" data-line-number="21"> upgrade [config] Upgrade scalar project</span>
|
|
5627
|
+
<span class="t-code__line" data-line-number="22"> help [command] display help for command</span>
|
|
5628
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5629
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5630
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5631
|
+
</svg>
|
|
5632
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5633
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5634
|
+
</svg></button>
|
|
5635
|
+
</div>
|
|
5636
|
+
<h4 id="list-1" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5637
|
+
list
|
|
5638
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5639
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5640
|
+
</svg>
|
|
5641
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
5642
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5643
|
+
</svg></button>
|
|
5644
|
+
</h4>
|
|
5645
|
+
<div id="wEZLZmwdKoi13k2B5Azzp" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5646
|
+
<pre style="
|
|
5647
|
+
--line-digits: 2;
|
|
5648
|
+
--line-number-start: -1;
|
|
5649
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar project list [options]</span>
|
|
5650
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
5651
|
+
<span class="t-code__line" data-line-number="2">List projects and their slugs for the current team.</span>
|
|
5652
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
5653
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5654
|
+
<span class="t-code__line" data-line-number="5"> --json Print project details as JSON</span>
|
|
5655
|
+
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
5656
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5657
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5658
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5659
|
+
</svg>
|
|
5660
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5661
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5662
|
+
</svg></button>
|
|
5663
|
+
</div>
|
|
5664
|
+
<h4 id="get-1" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5665
|
+
get
|
|
5666
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5667
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5668
|
+
</svg>
|
|
5669
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
5670
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5671
|
+
</svg></button>
|
|
5672
|
+
</h4>
|
|
5673
|
+
<div id="Q6m6ZJRBcvqCb5ZHoCZac" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5674
|
+
<pre style="
|
|
5675
|
+
--line-digits: 2;
|
|
5676
|
+
--line-number-start: -1;
|
|
5677
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar project get [options] <slug></span>
|
|
5678
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
5679
|
+
<span class="t-code__line" data-line-number="2">Get project details for the current team.</span>
|
|
5680
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
5681
|
+
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
5682
|
+
<span class="t-code__line" data-line-number="5"> slug Project slug from scalar project list</span>
|
|
5683
|
+
<span class="t-code__line" data-line-number="6"></span>
|
|
5684
|
+
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
5685
|
+
<span class="t-code__line" data-line-number="8"> --json Print project details as JSON</span>
|
|
5686
|
+
<span class="t-code__line" data-line-number="9"> -h, --help display help for command</span>
|
|
4819
5687
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4820
5688
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4821
5689
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4833,7 +5701,7 @@ blockquote.t-editor__quote > * {
|
|
|
4833
5701
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4834
5702
|
</svg></button>
|
|
4835
5703
|
</h4>
|
|
4836
|
-
<div id="
|
|
5704
|
+
<div id="7qUDf2WhPUNiwlg1PlM0H" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4837
5705
|
<pre style="
|
|
4838
5706
|
--line-digits: 2;
|
|
4839
5707
|
--line-number-start: -1;
|
|
@@ -4862,7 +5730,7 @@ blockquote.t-editor__quote > * {
|
|
|
4862
5730
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4863
5731
|
</svg></button>
|
|
4864
5732
|
</h4>
|
|
4865
|
-
<div id="
|
|
5733
|
+
<div id="AL8JzAHLpQcztnfGkoAkQ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4866
5734
|
<pre style="
|
|
4867
5735
|
--line-digits: 2;
|
|
4868
5736
|
--line-number-start: -1;
|
|
@@ -4883,7 +5751,7 @@ blockquote.t-editor__quote > * {
|
|
|
4883
5751
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
4884
5752
|
</svg></button>
|
|
4885
5753
|
</div>
|
|
4886
|
-
<h4 id="create" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5754
|
+
<h4 id="create-1" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
4887
5755
|
create
|
|
4888
5756
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
4889
5757
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -4892,7 +5760,7 @@ blockquote.t-editor__quote > * {
|
|
|
4892
5760
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4893
5761
|
</svg></button>
|
|
4894
5762
|
</h4>
|
|
4895
|
-
<div id="
|
|
5763
|
+
<div id="XTkg7kx8myunLp2BHXxH8" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4896
5764
|
<pre style="
|
|
4897
5765
|
--line-digits: 2;
|
|
4898
5766
|
--line-number-start: -1;
|
|
@@ -4921,7 +5789,7 @@ blockquote.t-editor__quote > * {
|
|
|
4921
5789
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4922
5790
|
</svg></button>
|
|
4923
5791
|
</h4>
|
|
4924
|
-
<div id="
|
|
5792
|
+
<div id="hw6zbDKzioJTt9YwyXR9T" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4925
5793
|
<pre style="
|
|
4926
5794
|
--line-digits: 2;
|
|
4927
5795
|
--line-number-start: -1;
|
|
@@ -4930,14 +5798,19 @@ blockquote.t-editor__quote > * {
|
|
|
4930
5798
|
<span class="t-code__line" data-line-number="2">Preview scalar guides</span>
|
|
4931
5799
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4932
5800
|
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4933
|
-
<span class="t-code__line" data-line-number="5"> config Path to the Scalar configuration file (usually
|
|
4934
|
-
<span class="t-code__line" data-line-number="6"
|
|
4935
|
-
<span class="t-code__line" data-line-number="7"
|
|
4936
|
-
<span class="t-code__line" data-line-number="8">
|
|
4937
|
-
<span class="t-code__line" data-line-number="9"> -
|
|
4938
|
-
<span class="t-code__line" data-line-number="10">
|
|
4939
|
-
<span class="t-code__line" data-line-number="11">
|
|
4940
|
-
<span class="t-code__line" data-line-number="12"> -
|
|
5801
|
+
<span class="t-code__line" data-line-number="5"> config Path to the Scalar configuration file (usually</span>
|
|
5802
|
+
<span class="t-code__line" data-line-number="6"> `scalar.config.json5` or `scalar.config.json`)</span>
|
|
5803
|
+
<span class="t-code__line" data-line-number="7"></span>
|
|
5804
|
+
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
5805
|
+
<span class="t-code__line" data-line-number="9"> -p, --port [port] port to run the server on. If the port is not</span>
|
|
5806
|
+
<span class="t-code__line" data-line-number="10"> available, it will select another one. (default:</span>
|
|
5807
|
+
<span class="t-code__line" data-line-number="11"> "7970")</span>
|
|
5808
|
+
<span class="t-code__line" data-line-number="12"> -H, --host [host] Specify which IP addresses the server should listen</span>
|
|
5809
|
+
<span class="t-code__line" data-line-number="13"> on.</span>
|
|
5810
|
+
<span class="t-code__line" data-line-number="14"> -L, --log-level <level> Set the log level (choices: "debug", "info", default:</span>
|
|
5811
|
+
<span class="t-code__line" data-line-number="15"> "info")</span>
|
|
5812
|
+
<span class="t-code__line" data-line-number="16"> -N, --no-open Do not open the browser automatically</span>
|
|
5813
|
+
<span class="t-code__line" data-line-number="17"> -h, --help display help for command</span>
|
|
4941
5814
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4942
5815
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4943
5816
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -4955,7 +5828,7 @@ blockquote.t-editor__quote > * {
|
|
|
4955
5828
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4956
5829
|
</svg></button>
|
|
4957
5830
|
</h4>
|
|
4958
|
-
<div id="
|
|
5831
|
+
<div id="6bhYY2xkfQ56alaibtzGN" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4959
5832
|
<pre style="
|
|
4960
5833
|
--line-digits: 2;
|
|
4961
5834
|
--line-number-start: -1;
|
|
@@ -4964,7 +5837,7 @@ blockquote.t-editor__quote > * {
|
|
|
4964
5837
|
<span class="t-code__line" data-line-number="2">Publish new build for a github sync project that is not linked.</span>
|
|
4965
5838
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4966
5839
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4967
|
-
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug
|
|
5840
|
+
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug from scalar project list</span>
|
|
4968
5841
|
<span class="t-code__line" data-line-number="6"> -c, --config [config] Your config file of the project</span>
|
|
4969
5842
|
<span class="t-code__line" data-line-number="7"> -p, --preview Publish in preview mode</span>
|
|
4970
5843
|
<span class="t-code__line" data-line-number="8"> -g, --github Publish from your linked remote GitHub repository</span>
|
|
@@ -4986,7 +5859,7 @@ blockquote.t-editor__quote > * {
|
|
|
4986
5859
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
4987
5860
|
</svg></button>
|
|
4988
5861
|
</h4>
|
|
4989
|
-
<div id="
|
|
5862
|
+
<div id="DxJll5B0UvyLX6JbvOjRQ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4990
5863
|
<pre style="
|
|
4991
5864
|
--line-digits: 2;
|
|
4992
5865
|
--line-number-start: -1;
|
|
@@ -4995,10 +5868,11 @@ blockquote.t-editor__quote > * {
|
|
|
4995
5868
|
<span class="t-code__line" data-line-number="2">Roll the live deployment back to a previously deployed build.</span>
|
|
4996
5869
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4997
5870
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4998
|
-
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug
|
|
4999
|
-
<span class="t-code__line" data-line-number="6"> -t, --to <publishUid> Roll back to a specific build id (defaults to the next
|
|
5000
|
-
<span class="t-code__line" data-line-number="7">
|
|
5001
|
-
<span class="t-code__line" data-line-number="8"> -
|
|
5871
|
+
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug from scalar project list</span>
|
|
5872
|
+
<span class="t-code__line" data-line-number="6"> -t, --to <publishUid> Roll back to a specific build id (defaults to the next</span>
|
|
5873
|
+
<span class="t-code__line" data-line-number="7"> older deployed build)</span>
|
|
5874
|
+
<span class="t-code__line" data-line-number="8"> -y, --yes Skip the confirmation prompt</span>
|
|
5875
|
+
<span class="t-code__line" data-line-number="9"> -h, --help display help for command</span>
|
|
5002
5876
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5003
5877
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5004
5878
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5016,7 +5890,7 @@ blockquote.t-editor__quote > * {
|
|
|
5016
5890
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5017
5891
|
</svg></button>
|
|
5018
5892
|
</h4>
|
|
5019
|
-
<div id="
|
|
5893
|
+
<div id="23tJqJaiHjb8SEaUWOZII" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5020
5894
|
<pre style="
|
|
5021
5895
|
--line-digits: 2;
|
|
5022
5896
|
--line-number-start: -1;
|
|
@@ -5039,7 +5913,7 @@ blockquote.t-editor__quote > * {
|
|
|
5039
5913
|
</svg></button>
|
|
5040
5914
|
</div>
|
|
5041
5915
|
<h5 id="" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="5" data-scalar-type="heading">list</h5>
|
|
5042
|
-
<div id="
|
|
5916
|
+
<div id="jysHg9mXCiGL5ONMeZsak" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5043
5917
|
<pre style="
|
|
5044
5918
|
--line-digits: 2;
|
|
5045
5919
|
--line-number-start: -1;
|
|
@@ -5048,7 +5922,7 @@ blockquote.t-editor__quote > * {
|
|
|
5048
5922
|
<span class="t-code__line" data-line-number="2">List the production deployment history for a project.</span>
|
|
5049
5923
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5050
5924
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5051
|
-
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug
|
|
5925
|
+
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug from scalar project list</span>
|
|
5052
5926
|
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
5053
5927
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5054
5928
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
@@ -5067,7 +5941,7 @@ blockquote.t-editor__quote > * {
|
|
|
5067
5941
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5068
5942
|
</svg></button>
|
|
5069
5943
|
</h4>
|
|
5070
|
-
<div id="
|
|
5944
|
+
<div id="Aqb3cF5RxH7gB2h2HrXxr" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5071
5945
|
<pre style="
|
|
5072
5946
|
--line-digits: 2;
|
|
5073
5947
|
--line-number-start: -1;
|
|
@@ -5076,10 +5950,11 @@ blockquote.t-editor__quote > * {
|
|
|
5076
5950
|
<span class="t-code__line" data-line-number="2">Upgrade scalar project</span>
|
|
5077
5951
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5078
5952
|
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
5079
|
-
<span class="t-code__line" data-line-number="5"> config Path to the Scalar configuration file (usually
|
|
5080
|
-
<span class="t-code__line" data-line-number="6"
|
|
5081
|
-
<span class="t-code__line" data-line-number="7"
|
|
5082
|
-
<span class="t-code__line" data-line-number="8">
|
|
5953
|
+
<span class="t-code__line" data-line-number="5"> config Path to the Scalar configuration file (usually</span>
|
|
5954
|
+
<span class="t-code__line" data-line-number="6"> `scalar.config.json5` or `scalar.config.json`)</span>
|
|
5955
|
+
<span class="t-code__line" data-line-number="7"></span>
|
|
5956
|
+
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
5957
|
+
<span class="t-code__line" data-line-number="9"> -h, --help display help for command</span>
|
|
5083
5958
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5084
5959
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5085
5960
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5097,7 +5972,7 @@ blockquote.t-editor__quote > * {
|
|
|
5097
5972
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5098
5973
|
</svg></button>
|
|
5099
5974
|
</h3>
|
|
5100
|
-
<div id="
|
|
5975
|
+
<div id="I9v483HCxLJqDzW3qSydr" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5101
5976
|
<pre style="
|
|
5102
5977
|
--line-digits: 2;
|
|
5103
5978
|
--line-number-start: -1;
|
|
@@ -5109,12 +5984,16 @@ blockquote.t-editor__quote > * {
|
|
|
5109
5984
|
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
5110
5985
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5111
5986
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
5112
|
-
<span class="t-code__line" data-line-number="8"> publish [options] [file] Publish an OpenAPI document to the Scalar
|
|
5113
|
-
<span class="t-code__line" data-line-number="9">
|
|
5114
|
-
<span class="t-code__line" data-line-number="10">
|
|
5115
|
-
<span class="t-code__line" data-line-number="11">
|
|
5116
|
-
<span class="t-code__line" data-line-number="12">
|
|
5117
|
-
<span class="t-code__line" data-line-number="13">
|
|
5987
|
+
<span class="t-code__line" data-line-number="8"> publish [options] [file] Publish an OpenAPI document to the Scalar</span>
|
|
5988
|
+
<span class="t-code__line" data-line-number="9"> registry</span>
|
|
5989
|
+
<span class="t-code__line" data-line-number="10"> update [options] [namespace] [slug] Update document metadata on scalar</span>
|
|
5990
|
+
<span class="t-code__line" data-line-number="11"> registry</span>
|
|
5991
|
+
<span class="t-code__line" data-line-number="12"> delete [namespace] [slug] Delete a document from scalar registry</span>
|
|
5992
|
+
<span class="t-code__line" data-line-number="13"> list [options] List all registry APIs for a team</span>
|
|
5993
|
+
<span class="t-code__line" data-line-number="14"> namespace</span>
|
|
5994
|
+
<span class="t-code__line" data-line-number="15"> get [options] [namespace] [slug] Get a document version from scalar</span>
|
|
5995
|
+
<span class="t-code__line" data-line-number="16"> registry</span>
|
|
5996
|
+
<span class="t-code__line" data-line-number="17"> help [command] display help for command</span>
|
|
5118
5997
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5119
5998
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5120
5999
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5132,7 +6011,7 @@ blockquote.t-editor__quote > * {
|
|
|
5132
6011
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5133
6012
|
</svg></button>
|
|
5134
6013
|
</h4>
|
|
5135
|
-
<div id="
|
|
6014
|
+
<div id="q3CumzEA1G5KzY12MjYOe" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5136
6015
|
<pre style="
|
|
5137
6016
|
--line-digits: 2;
|
|
5138
6017
|
--line-number-start: -1;
|
|
@@ -5144,17 +6023,20 @@ blockquote.t-editor__quote > * {
|
|
|
5144
6023
|
<span class="t-code__line" data-line-number="5"> file OpenAPI file to upload</span>
|
|
5145
6024
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5146
6025
|
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
5147
|
-
<span class="t-code__line" data-line-number="8"> --slug <slug> Slug identifier for the registry entry. Defaults to
|
|
5148
|
-
<span class="t-code__line" data-line-number="9">
|
|
5149
|
-
<span class="t-code__line" data-line-number="10"> --
|
|
5150
|
-
<span class="t-code__line" data-line-number="11"> --
|
|
5151
|
-
<span class="t-code__line" data-line-number="12"> --
|
|
5152
|
-
<span class="t-code__line" data-line-number="13"> --
|
|
5153
|
-
<span class="t-code__line" data-line-number="14"> --
|
|
5154
|
-
<span class="t-code__line" data-line-number="15"> --
|
|
5155
|
-
<span class="t-code__line" data-line-number="16"> --
|
|
5156
|
-
<span class="t-code__line" data-line-number="17"> --
|
|
5157
|
-
<span class="t-code__line" data-line-number="18">
|
|
6026
|
+
<span class="t-code__line" data-line-number="8"> --slug <slug> Slug identifier for the registry entry. Defaults to</span>
|
|
6027
|
+
<span class="t-code__line" data-line-number="9"> title.</span>
|
|
6028
|
+
<span class="t-code__line" data-line-number="10"> --namespace <namespace> Scalar team namespace</span>
|
|
6029
|
+
<span class="t-code__line" data-line-number="11"> --version <version> API version (e.g. 0.1.0)</span>
|
|
6030
|
+
<span class="t-code__line" data-line-number="12"> --private Make API private (default: false)</span>
|
|
6031
|
+
<span class="t-code__line" data-line-number="13"> --no-current Do not set as the current version</span>
|
|
6032
|
+
<span class="t-code__line" data-line-number="14"> --force Force override an existing version (default: false)</span>
|
|
6033
|
+
<span class="t-code__line" data-line-number="15"> --bundle Bundle all external references before uploading</span>
|
|
6034
|
+
<span class="t-code__line" data-line-number="16"> --treeShake Remove unused components from the bundled document</span>
|
|
6035
|
+
<span class="t-code__line" data-line-number="17"> --urlMap Generate a map of resolved URLs when bundling the</span>
|
|
6036
|
+
<span class="t-code__line" data-line-number="18"> document</span>
|
|
6037
|
+
<span class="t-code__line" data-line-number="19"> --fetchLimit <limit> Maximum number of concurrent URLs to fetch when</span>
|
|
6038
|
+
<span class="t-code__line" data-line-number="20"> bundling the document</span>
|
|
6039
|
+
<span class="t-code__line" data-line-number="21"> -h, --help display help for command</span>
|
|
5158
6040
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5159
6041
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5160
6042
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5163,7 +6045,7 @@ blockquote.t-editor__quote > * {
|
|
|
5163
6045
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5164
6046
|
</svg></button>
|
|
5165
6047
|
</div>
|
|
5166
|
-
<h4 id="update" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6048
|
+
<h4 id="update-1" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5167
6049
|
update
|
|
5168
6050
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5169
6051
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5172,7 +6054,7 @@ blockquote.t-editor__quote > * {
|
|
|
5172
6054
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5173
6055
|
</svg></button>
|
|
5174
6056
|
</h4>
|
|
5175
|
-
<div id="
|
|
6057
|
+
<div id="9ILDopCZjNXsQFysLyJJu" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5176
6058
|
<pre style="
|
|
5177
6059
|
--line-digits: 2;
|
|
5178
6060
|
--line-number-start: -1;
|
|
@@ -5196,7 +6078,7 @@ blockquote.t-editor__quote > * {
|
|
|
5196
6078
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5197
6079
|
</svg></button>
|
|
5198
6080
|
</div>
|
|
5199
|
-
<h4 id="delete" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6081
|
+
<h4 id="delete-1" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5200
6082
|
delete
|
|
5201
6083
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5202
6084
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5205,7 +6087,7 @@ blockquote.t-editor__quote > * {
|
|
|
5205
6087
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5206
6088
|
</svg></button>
|
|
5207
6089
|
</h4>
|
|
5208
|
-
<div id="
|
|
6090
|
+
<div id="QBnP9Bjgnzh90dcK6l0Zc" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5209
6091
|
<pre style="
|
|
5210
6092
|
--line-digits: 2;
|
|
5211
6093
|
--line-number-start: -1;
|
|
@@ -5227,7 +6109,7 @@ blockquote.t-editor__quote > * {
|
|
|
5227
6109
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5228
6110
|
</svg></button>
|
|
5229
6111
|
</div>
|
|
5230
|
-
<h4 id="list" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6112
|
+
<h4 id="list-2" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5231
6113
|
list
|
|
5232
6114
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5233
6115
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5236,7 +6118,7 @@ blockquote.t-editor__quote > * {
|
|
|
5236
6118
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5237
6119
|
</svg></button>
|
|
5238
6120
|
</h4>
|
|
5239
|
-
<div id="
|
|
6121
|
+
<div id="MQilJ749gZp3D2Wk6UJpJ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5240
6122
|
<pre style="
|
|
5241
6123
|
--line-digits: 2;
|
|
5242
6124
|
--line-number-start: -1;
|
|
@@ -5246,7 +6128,8 @@ blockquote.t-editor__quote > * {
|
|
|
5246
6128
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5247
6129
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5248
6130
|
<span class="t-code__line" data-line-number="5"> --namespace <namespace> Team namespace</span>
|
|
5249
|
-
<span class="t-code__line" data-line-number="6">
|
|
6131
|
+
<span class="t-code__line" data-line-number="6"> --json Output registry API metadata as JSON</span>
|
|
6132
|
+
<span class="t-code__line" data-line-number="7"> -h, --help display help for command</span>
|
|
5250
6133
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5251
6134
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5252
6135
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5255,7 +6138,7 @@ blockquote.t-editor__quote > * {
|
|
|
5255
6138
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5256
6139
|
</svg></button>
|
|
5257
6140
|
</div>
|
|
5258
|
-
<h4 id="get" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6141
|
+
<h4 id="get-2" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5259
6142
|
get
|
|
5260
6143
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5261
6144
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5264,7 +6147,7 @@ blockquote.t-editor__quote > * {
|
|
|
5264
6147
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5265
6148
|
</svg></button>
|
|
5266
6149
|
</h4>
|
|
5267
|
-
<div id="
|
|
6150
|
+
<div id="zZ6suZaXzWH6gmG70kaTY" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5268
6151
|
<pre style="
|
|
5269
6152
|
--line-digits: 2;
|
|
5270
6153
|
--line-number-start: -1;
|
|
@@ -5278,7 +6161,7 @@ blockquote.t-editor__quote > * {
|
|
|
5278
6161
|
<span class="t-code__line" data-line-number="7"></span>
|
|
5279
6162
|
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
5280
6163
|
<span class="t-code__line" data-line-number="9"> --version <version> Document version (defaults to latest)</span>
|
|
5281
|
-
<span class="t-code__line" data-line-number="10"> --format <format> Output format (json or yaml) (default: "json")</span>
|
|
6164
|
+
<span class="t-code__line" data-line-number="10"> --format <format> Output format (json or yaml) (choices: "json", "yaml", default: "json")</span>
|
|
5282
6165
|
<span class="t-code__line" data-line-number="11"> -o, --output <file> Output file (defaults to stdout)</span>
|
|
5283
6166
|
<span class="t-code__line" data-line-number="12"> -h, --help display help for command</span>
|
|
5284
6167
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
@@ -5298,7 +6181,7 @@ blockquote.t-editor__quote > * {
|
|
|
5298
6181
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5299
6182
|
</svg></button>
|
|
5300
6183
|
</h3>
|
|
5301
|
-
<div id="
|
|
6184
|
+
<div id="YgeN5IlVU3cNPTxOIYDX2" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5302
6185
|
<pre style="
|
|
5303
6186
|
--line-digits: 2;
|
|
5304
6187
|
--line-number-start: -1;
|
|
@@ -5310,9 +6193,10 @@ blockquote.t-editor__quote > * {
|
|
|
5310
6193
|
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
5311
6194
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5312
6195
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
5313
|
-
<span class="t-code__line" data-line-number="8"> list
|
|
5314
|
-
<span class="t-code__line" data-line-number="9">
|
|
5315
|
-
<span class="t-code__line" data-line-number="10">
|
|
6196
|
+
<span class="t-code__line" data-line-number="8"> list [options] List all teams current user is part of</span>
|
|
6197
|
+
<span class="t-code__line" data-line-number="9"> get [options] Get the current team and its namespaces</span>
|
|
6198
|
+
<span class="t-code__line" data-line-number="10"> set [options] Set current active team for the user</span>
|
|
6199
|
+
<span class="t-code__line" data-line-number="11"> help [command] display help for command</span>
|
|
5316
6200
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5317
6201
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5318
6202
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5321,7 +6205,7 @@ blockquote.t-editor__quote > * {
|
|
|
5321
6205
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5322
6206
|
</svg></button>
|
|
5323
6207
|
</div>
|
|
5324
|
-
<h4 id="list-
|
|
6208
|
+
<h4 id="list-3" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5325
6209
|
list
|
|
5326
6210
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5327
6211
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5330,7 +6214,7 @@ blockquote.t-editor__quote > * {
|
|
|
5330
6214
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5331
6215
|
</svg></button>
|
|
5332
6216
|
</h4>
|
|
5333
|
-
<div id="
|
|
6217
|
+
<div id="91W7Dfax9hoqMujKIaXMw" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5334
6218
|
<pre style="
|
|
5335
6219
|
--line-digits: 2;
|
|
5336
6220
|
--line-number-start: -1;
|
|
@@ -5339,7 +6223,36 @@ blockquote.t-editor__quote > * {
|
|
|
5339
6223
|
<span class="t-code__line" data-line-number="2">List all teams current user is part of</span>
|
|
5340
6224
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5341
6225
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5342
|
-
<span class="t-code__line" data-line-number="5">
|
|
6226
|
+
<span class="t-code__line" data-line-number="5"> --json Output teams as JSON</span>
|
|
6227
|
+
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
6228
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
6229
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6230
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
6231
|
+
</svg>
|
|
6232
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6233
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6234
|
+
</svg></button>
|
|
6235
|
+
</div>
|
|
6236
|
+
<h4 id="get-3" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6237
|
+
get
|
|
6238
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
6239
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6240
|
+
</svg>
|
|
6241
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
6242
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
6243
|
+
</svg></button>
|
|
6244
|
+
</h4>
|
|
6245
|
+
<div id="V3zB6gBaCdhqn4RFrXJTa" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
6246
|
+
<pre style="
|
|
6247
|
+
--line-digits: 2;
|
|
6248
|
+
--line-number-start: -1;
|
|
6249
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar team get [options]</span>
|
|
6250
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
6251
|
+
<span class="t-code__line" data-line-number="2">Get the current team and its namespaces</span>
|
|
6252
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
6253
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
6254
|
+
<span class="t-code__line" data-line-number="5"> --json Output the current team as JSON</span>
|
|
6255
|
+
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
5343
6256
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5344
6257
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5345
6258
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5357,7 +6270,7 @@ blockquote.t-editor__quote > * {
|
|
|
5357
6270
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5358
6271
|
</svg></button>
|
|
5359
6272
|
</h4>
|
|
5360
|
-
<div id="
|
|
6273
|
+
<div id="bwoNpNRDxPo0DNtR02zfI" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5361
6274
|
<pre style="
|
|
5362
6275
|
--line-digits: 2;
|
|
5363
6276
|
--line-number-start: -1;
|
|
@@ -5385,7 +6298,7 @@ blockquote.t-editor__quote > * {
|
|
|
5385
6298
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5386
6299
|
</svg></button>
|
|
5387
6300
|
</h3>
|
|
5388
|
-
<div id="
|
|
6301
|
+
<div id="yDQKlce1C1OPuakcuYLeu" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5389
6302
|
<pre style="
|
|
5390
6303
|
--line-digits: 2;
|
|
5391
6304
|
--line-number-start: -1;
|
|
@@ -5398,11 +6311,13 @@ blockquote.t-editor__quote > * {
|
|
|
5398
6311
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5399
6312
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
5400
6313
|
<span class="t-code__line" data-line-number="8"> list [options] List all SDKs for a team namespace</span>
|
|
5401
|
-
<span class="t-code__line" data-line-number="9">
|
|
5402
|
-
<span class="t-code__line" data-line-number="10">
|
|
5403
|
-
<span class="t-code__line" data-line-number="11">
|
|
5404
|
-
<span class="t-code__line" data-line-number="12">
|
|
5405
|
-
<span class="t-code__line" data-line-number="13">
|
|
6314
|
+
<span class="t-code__line" data-line-number="9"> get [options] Inspect SDK metadata, API source, versions, and build status</span>
|
|
6315
|
+
<span class="t-code__line" data-line-number="10"> create [options] Create a new SDK. The SDK is created in the namespace of the</span>
|
|
6316
|
+
<span class="t-code__line" data-line-number="11"> API it is built from.</span>
|
|
6317
|
+
<span class="t-code__line" data-line-number="12"> update [options] Update SDK metadata.</span>
|
|
6318
|
+
<span class="t-code__line" data-line-number="13"> delete [options] Delete an SDK.</span>
|
|
6319
|
+
<span class="t-code__line" data-line-number="14"> build [options] Build an SDK.</span>
|
|
6320
|
+
<span class="t-code__line" data-line-number="15"> help [command] display help for command</span>
|
|
5406
6321
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5407
6322
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5408
6323
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5411,7 +6326,7 @@ blockquote.t-editor__quote > * {
|
|
|
5411
6326
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5412
6327
|
</svg></button>
|
|
5413
6328
|
</div>
|
|
5414
|
-
<h4 id="list-
|
|
6329
|
+
<h4 id="list-4" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5415
6330
|
list
|
|
5416
6331
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5417
6332
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5420,7 +6335,7 @@ blockquote.t-editor__quote > * {
|
|
|
5420
6335
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5421
6336
|
</svg></button>
|
|
5422
6337
|
</h4>
|
|
5423
|
-
<div id="
|
|
6338
|
+
<div id="njmil0U05gwXN9xfvZPul" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5424
6339
|
<pre style="
|
|
5425
6340
|
--line-digits: 2;
|
|
5426
6341
|
--line-number-start: -1;
|
|
@@ -5429,8 +6344,9 @@ blockquote.t-editor__quote > * {
|
|
|
5429
6344
|
<span class="t-code__line" data-line-number="2">List all SDKs for a team namespace</span>
|
|
5430
6345
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5431
6346
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5432
|
-
<span class="t-code__line" data-line-number="5"> --
|
|
5433
|
-
<span class="t-code__line" data-line-number="6">
|
|
6347
|
+
<span class="t-code__line" data-line-number="5"> --json Output structured SDK metadata as JSON</span>
|
|
6348
|
+
<span class="t-code__line" data-line-number="6"> --namespace <namespace> Team namespace</span>
|
|
6349
|
+
<span class="t-code__line" data-line-number="7"> -h, --help display help for command</span>
|
|
5434
6350
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5435
6351
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5436
6352
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5439,8 +6355,8 @@ blockquote.t-editor__quote > * {
|
|
|
5439
6355
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5440
6356
|
</svg></button>
|
|
5441
6357
|
</div>
|
|
5442
|
-
<h4 id="
|
|
5443
|
-
|
|
6358
|
+
<h4 id="get-4" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6359
|
+
get
|
|
5444
6360
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5445
6361
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5446
6362
|
</svg>
|
|
@@ -5448,18 +6364,18 @@ blockquote.t-editor__quote > * {
|
|
|
5448
6364
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5449
6365
|
</svg></button>
|
|
5450
6366
|
</h4>
|
|
5451
|
-
<div id="
|
|
6367
|
+
<div id="6gaoWouUrFhQl8426bXXU" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5452
6368
|
<pre style="
|
|
5453
6369
|
--line-digits: 2;
|
|
5454
6370
|
--line-number-start: -1;
|
|
5455
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar sdk
|
|
6371
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar sdk get [options]</span>
|
|
5456
6372
|
<span class="t-code__line" data-line-number="1"></span>
|
|
5457
|
-
<span class="t-code__line" data-line-number="2">
|
|
6373
|
+
<span class="t-code__line" data-line-number="2">Inspect SDK metadata, API source, versions, and build status</span>
|
|
5458
6374
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5459
6375
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5460
|
-
<span class="t-code__line" data-line-number="5"> -
|
|
5461
|
-
<span class="t-code__line" data-line-number="6"> -n, --namespace <namespace> Team namespace
|
|
5462
|
-
<span class="t-code__line" data-line-number="7">
|
|
6376
|
+
<span class="t-code__line" data-line-number="5"> -s, --slug <slug> SDK slug</span>
|
|
6377
|
+
<span class="t-code__line" data-line-number="6"> -n, --namespace <namespace> Team namespace</span>
|
|
6378
|
+
<span class="t-code__line" data-line-number="7"> --json Output structured SDK metadata as JSON</span>
|
|
5463
6379
|
<span class="t-code__line" data-line-number="8"> -h, --help display help for command</span>
|
|
5464
6380
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5465
6381
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
@@ -5469,7 +6385,40 @@ blockquote.t-editor__quote > * {
|
|
|
5469
6385
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5470
6386
|
</svg></button>
|
|
5471
6387
|
</div>
|
|
5472
|
-
<h4 id="
|
|
6388
|
+
<h4 id="create-2" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6389
|
+
create
|
|
6390
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
6391
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6392
|
+
</svg>
|
|
6393
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
6394
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
6395
|
+
</svg></button>
|
|
6396
|
+
</h4>
|
|
6397
|
+
<div id="cV607F0jk87TBENioYin8" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
6398
|
+
<pre style="
|
|
6399
|
+
--line-digits: 2;
|
|
6400
|
+
--line-number-start: -1;
|
|
6401
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-plaintext" language="plaintext"><span class="t-code__line" data-line-number="0">Usage: scalar sdk create [options]</span>
|
|
6402
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
6403
|
+
<span class="t-code__line" data-line-number="2">Create a new SDK. The SDK is created in the namespace of the API it is built</span>
|
|
6404
|
+
<span class="t-code__line" data-line-number="3">from.</span>
|
|
6405
|
+
<span class="t-code__line" data-line-number="4"></span>
|
|
6406
|
+
<span class="t-code__line" data-line-number="5">Options:</span>
|
|
6407
|
+
<span class="t-code__line" data-line-number="6"> -a, --api <api> Registry API slug</span>
|
|
6408
|
+
<span class="t-code__line" data-line-number="7"> -n, --namespace <namespace> Team namespace to look the API up in</span>
|
|
6409
|
+
<span class="t-code__line" data-line-number="8"> -l, --language <language> Language of your SDK (choices: "typescript",</span>
|
|
6410
|
+
<span class="t-code__line" data-line-number="9"> "python", "cli", "csharp", "java", "ruby", "php",</span>
|
|
6411
|
+
<span class="t-code__line" data-line-number="10"> "go", "rust", "kotlin", "swift", "cpp", "dart")</span>
|
|
6412
|
+
<span class="t-code__line" data-line-number="11"> -h, --help display help for command</span>
|
|
6413
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
6414
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6415
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
6416
|
+
</svg>
|
|
6417
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6418
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6419
|
+
</svg></button>
|
|
6420
|
+
</div>
|
|
6421
|
+
<h4 id="update-2" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5473
6422
|
update
|
|
5474
6423
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5475
6424
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5478,7 +6427,7 @@ blockquote.t-editor__quote > * {
|
|
|
5478
6427
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5479
6428
|
</svg></button>
|
|
5480
6429
|
</h4>
|
|
5481
|
-
<div id="
|
|
6430
|
+
<div id="rTPQByHjXmUZSyIrCz4qo" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5482
6431
|
<pre style="
|
|
5483
6432
|
--line-digits: 2;
|
|
5484
6433
|
--line-number-start: -1;
|
|
@@ -5490,7 +6439,7 @@ blockquote.t-editor__quote > * {
|
|
|
5490
6439
|
<span class="t-code__line" data-line-number="5"> -s, --slug <slug> SDK slug</span>
|
|
5491
6440
|
<span class="t-code__line" data-line-number="6"> -n, --namespace <namespace> Team namespace</span>
|
|
5492
6441
|
<span class="t-code__line" data-line-number="7"> --title <title> Title</span>
|
|
5493
|
-
<span class="t-code__line" data-line-number="8"> --isPrivate <isPrivate> Privacy (true/false or public/private)</span>
|
|
6442
|
+
<span class="t-code__line" data-line-number="8"> --isPrivate <isPrivate> Privacy (true/false or public/private) (choices: "true", "false", "public", "private")</span>
|
|
5494
6443
|
<span class="t-code__line" data-line-number="9"> -h, --help display help for command</span>
|
|
5495
6444
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5496
6445
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
@@ -5500,7 +6449,7 @@ blockquote.t-editor__quote > * {
|
|
|
5500
6449
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5501
6450
|
</svg></button>
|
|
5502
6451
|
</div>
|
|
5503
|
-
<h4 id="delete-
|
|
6452
|
+
<h4 id="delete-2" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5504
6453
|
delete
|
|
5505
6454
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5506
6455
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5509,7 +6458,7 @@ blockquote.t-editor__quote > * {
|
|
|
5509
6458
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5510
6459
|
</svg></button>
|
|
5511
6460
|
</h4>
|
|
5512
|
-
<div id="
|
|
6461
|
+
<div id="S8BGJdLDDnMysLZmF6W18" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5513
6462
|
<pre style="
|
|
5514
6463
|
--line-digits: 2;
|
|
5515
6464
|
--line-number-start: -1;
|
|
@@ -5538,7 +6487,7 @@ blockquote.t-editor__quote > * {
|
|
|
5538
6487
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5539
6488
|
</svg></button>
|
|
5540
6489
|
</h4>
|
|
5541
|
-
<div id="
|
|
6490
|
+
<div id="TmYNbc4lw9NulEjOvdVVO" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5542
6491
|
<pre style="
|
|
5543
6492
|
--line-digits: 2;
|
|
5544
6493
|
--line-number-start: -1;
|
|
@@ -5567,7 +6516,7 @@ blockquote.t-editor__quote > * {
|
|
|
5567
6516
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5568
6517
|
</svg></button>
|
|
5569
6518
|
</h3>
|
|
5570
|
-
<div id="
|
|
6519
|
+
<div id="WqKKAggZTDZLtpLyrXR6k" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5571
6520
|
<pre style="
|
|
5572
6521
|
--line-digits: 2;
|
|
5573
6522
|
--line-number-start: -1;
|
|
@@ -5582,9 +6531,11 @@ blockquote.t-editor__quote > * {
|
|
|
5582
6531
|
<span class="t-code__line" data-line-number="8"> delete [options] Delete a schema.</span>
|
|
5583
6532
|
<span class="t-code__line" data-line-number="9"> update [options] Update schema metadata.</span>
|
|
5584
6533
|
<span class="t-code__line" data-line-number="10"> list [options] List all schemas for a team namespace</span>
|
|
5585
|
-
<span class="t-code__line" data-line-number="11"> get [options] [namespace] [slug] Get a schema document version from the
|
|
5586
|
-
<span class="t-code__line" data-line-number="12">
|
|
5587
|
-
<span class="t-code__line" data-line-number="13">
|
|
6534
|
+
<span class="t-code__line" data-line-number="11"> get [options] [namespace] [slug] Get a schema document version from the</span>
|
|
6535
|
+
<span class="t-code__line" data-line-number="12"> Scalar registry</span>
|
|
6536
|
+
<span class="t-code__line" data-line-number="13"> publish [options] [file] Publish a shared schema to the Scalar</span>
|
|
6537
|
+
<span class="t-code__line" data-line-number="14"> registry</span>
|
|
6538
|
+
<span class="t-code__line" data-line-number="15"> help [command] display help for command</span>
|
|
5588
6539
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5589
6540
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5590
6541
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5593,7 +6544,7 @@ blockquote.t-editor__quote > * {
|
|
|
5593
6544
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5594
6545
|
</svg></button>
|
|
5595
6546
|
</div>
|
|
5596
|
-
<h4 id="delete-
|
|
6547
|
+
<h4 id="delete-3" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5597
6548
|
delete
|
|
5598
6549
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5599
6550
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5602,7 +6553,7 @@ blockquote.t-editor__quote > * {
|
|
|
5602
6553
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5603
6554
|
</svg></button>
|
|
5604
6555
|
</h4>
|
|
5605
|
-
<div id="
|
|
6556
|
+
<div id="BivMshI2Ax9rA9qwk7p5L" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5606
6557
|
<pre style="
|
|
5607
6558
|
--line-digits: 2;
|
|
5608
6559
|
--line-number-start: -1;
|
|
@@ -5622,7 +6573,7 @@ blockquote.t-editor__quote > * {
|
|
|
5622
6573
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5623
6574
|
</svg></button>
|
|
5624
6575
|
</div>
|
|
5625
|
-
<h4 id="update-
|
|
6576
|
+
<h4 id="update-3" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5626
6577
|
update
|
|
5627
6578
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5628
6579
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5631,7 +6582,7 @@ blockquote.t-editor__quote > * {
|
|
|
5631
6582
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5632
6583
|
</svg></button>
|
|
5633
6584
|
</h4>
|
|
5634
|
-
<div id="
|
|
6585
|
+
<div id="F1WgsxEudRVTpHeoiCIGV" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5635
6586
|
<pre style="
|
|
5636
6587
|
--line-digits: 2;
|
|
5637
6588
|
--line-number-start: -1;
|
|
@@ -5644,7 +6595,7 @@ blockquote.t-editor__quote > * {
|
|
|
5644
6595
|
<span class="t-code__line" data-line-number="6"> -n, --namespace <namespace> Team namespace</span>
|
|
5645
6596
|
<span class="t-code__line" data-line-number="7"> --title <title> Title</span>
|
|
5646
6597
|
<span class="t-code__line" data-line-number="8"> --description <description> Description</span>
|
|
5647
|
-
<span class="t-code__line" data-line-number="9"> --isPrivate <isPrivate> Privacy (true/false or public/private)</span>
|
|
6598
|
+
<span class="t-code__line" data-line-number="9"> --isPrivate <isPrivate> Privacy (true/false or public/private) (choices: "true", "false", "public", "private")</span>
|
|
5648
6599
|
<span class="t-code__line" data-line-number="10"> -h, --help display help for command</span>
|
|
5649
6600
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5650
6601
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
@@ -5654,7 +6605,7 @@ blockquote.t-editor__quote > * {
|
|
|
5654
6605
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5655
6606
|
</svg></button>
|
|
5656
6607
|
</div>
|
|
5657
|
-
<h4 id="list-
|
|
6608
|
+
<h4 id="list-5" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5658
6609
|
list
|
|
5659
6610
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5660
6611
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5663,7 +6614,7 @@ blockquote.t-editor__quote > * {
|
|
|
5663
6614
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5664
6615
|
</svg></button>
|
|
5665
6616
|
</h4>
|
|
5666
|
-
<div id="
|
|
6617
|
+
<div id="w2bTuHxcVYIgiCOuNUqXr" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5667
6618
|
<pre style="
|
|
5668
6619
|
--line-digits: 2;
|
|
5669
6620
|
--line-number-start: -1;
|
|
@@ -5673,7 +6624,8 @@ blockquote.t-editor__quote > * {
|
|
|
5673
6624
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5674
6625
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5675
6626
|
<span class="t-code__line" data-line-number="5"> --namespace <namespace> Team namespace</span>
|
|
5676
|
-
<span class="t-code__line" data-line-number="6">
|
|
6627
|
+
<span class="t-code__line" data-line-number="6"> --json Output schema metadata as JSON</span>
|
|
6628
|
+
<span class="t-code__line" data-line-number="7"> -h, --help display help for command</span>
|
|
5677
6629
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5678
6630
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5679
6631
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5682,7 +6634,7 @@ blockquote.t-editor__quote > * {
|
|
|
5682
6634
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5683
6635
|
</svg></button>
|
|
5684
6636
|
</div>
|
|
5685
|
-
<h4 id="get-
|
|
6637
|
+
<h4 id="get-5" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5686
6638
|
get
|
|
5687
6639
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5688
6640
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
@@ -5691,7 +6643,7 @@ blockquote.t-editor__quote > * {
|
|
|
5691
6643
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5692
6644
|
</svg></button>
|
|
5693
6645
|
</h4>
|
|
5694
|
-
<div id="
|
|
6646
|
+
<div id="gCGYrw94P2BsTRRthKvCF" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5695
6647
|
<pre style="
|
|
5696
6648
|
--line-digits: 2;
|
|
5697
6649
|
--line-number-start: -1;
|
|
@@ -5705,7 +6657,7 @@ blockquote.t-editor__quote > * {
|
|
|
5705
6657
|
<span class="t-code__line" data-line-number="7"></span>
|
|
5706
6658
|
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
5707
6659
|
<span class="t-code__line" data-line-number="9"> --version <version> Schema version (defaults to latest)</span>
|
|
5708
|
-
<span class="t-code__line" data-line-number="10"> --format <format> Output format (json or yaml) (default: "json")</span>
|
|
6660
|
+
<span class="t-code__line" data-line-number="10"> --format <format> Output format (json or yaml) (choices: "json", "yaml", default: "json")</span>
|
|
5709
6661
|
<span class="t-code__line" data-line-number="11"> -o, --output <file> Output file (defaults to stdout)</span>
|
|
5710
6662
|
<span class="t-code__line" data-line-number="12"> -h, --help display help for command</span>
|
|
5711
6663
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
@@ -5725,7 +6677,7 @@ blockquote.t-editor__quote > * {
|
|
|
5725
6677
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5726
6678
|
</svg></button>
|
|
5727
6679
|
</h4>
|
|
5728
|
-
<div id="
|
|
6680
|
+
<div id="ZkPnWlecb3PnHlWVWthFW" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5729
6681
|
<pre style="
|
|
5730
6682
|
--line-digits: 2;
|
|
5731
6683
|
--line-number-start: -1;
|
|
@@ -5737,17 +6689,20 @@ blockquote.t-editor__quote > * {
|
|
|
5737
6689
|
<span class="t-code__line" data-line-number="5"> file OpenAPI file to upload</span>
|
|
5738
6690
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5739
6691
|
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
5740
|
-
<span class="t-code__line" data-line-number="8"> --slug <slug> Slug identifier for the registry entry. Defaults to
|
|
5741
|
-
<span class="t-code__line" data-line-number="9">
|
|
5742
|
-
<span class="t-code__line" data-line-number="10"> --
|
|
5743
|
-
<span class="t-code__line" data-line-number="11"> --
|
|
5744
|
-
<span class="t-code__line" data-line-number="12"> --
|
|
5745
|
-
<span class="t-code__line" data-line-number="13"> --
|
|
5746
|
-
<span class="t-code__line" data-line-number="14"> --
|
|
5747
|
-
<span class="t-code__line" data-line-number="15"> --
|
|
5748
|
-
<span class="t-code__line" data-line-number="16"> --
|
|
5749
|
-
<span class="t-code__line" data-line-number="17"> --
|
|
5750
|
-
<span class="t-code__line" data-line-number="18">
|
|
6692
|
+
<span class="t-code__line" data-line-number="8"> --slug <slug> Slug identifier for the registry entry. Defaults to</span>
|
|
6693
|
+
<span class="t-code__line" data-line-number="9"> title.</span>
|
|
6694
|
+
<span class="t-code__line" data-line-number="10"> --title <title> Schema title</span>
|
|
6695
|
+
<span class="t-code__line" data-line-number="11"> --namespace <namespace> Scalar team namespace</span>
|
|
6696
|
+
<span class="t-code__line" data-line-number="12"> --version <version> API version (e.g. 0.1.0)</span>
|
|
6697
|
+
<span class="t-code__line" data-line-number="13"> --private Make API private (default: false)</span>
|
|
6698
|
+
<span class="t-code__line" data-line-number="14"> --force Force override an existing version (default: false)</span>
|
|
6699
|
+
<span class="t-code__line" data-line-number="15"> --bundle Bundle all external references before uploading</span>
|
|
6700
|
+
<span class="t-code__line" data-line-number="16"> --treeShake Remove unused components from the bundled document</span>
|
|
6701
|
+
<span class="t-code__line" data-line-number="17"> --urlMap Generate a map of resolved URLs when bundling the</span>
|
|
6702
|
+
<span class="t-code__line" data-line-number="18"> document</span>
|
|
6703
|
+
<span class="t-code__line" data-line-number="19"> --fetchLimit <limit> Maximum number of concurrent URLs to fetch when</span>
|
|
6704
|
+
<span class="t-code__line" data-line-number="20"> bundling the document</span>
|
|
6705
|
+
<span class="t-code__line" data-line-number="21"> -h, --help display help for command</span>
|
|
5751
6706
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5752
6707
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5753
6708
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
@@ -5766,7 +6721,7 @@ blockquote.t-editor__quote > * {
|
|
|
5766
6721
|
</svg></button>
|
|
5767
6722
|
</h2>
|
|
5768
6723
|
<p class="t-editor__paragraph"><code inline="true" class="t-editor__inline-code">scalar context</code> prints the whole command tree as JSON: every command with its arguments, options, defaults, and choices, plus notes on running the CLI without prompts and what each exit code means. Point an agent at it instead of having it scrape <code inline="true" class="t-editor__inline-code">--help</code>:</p>
|
|
5769
|
-
<div id="
|
|
6724
|
+
<div id="EApDO86JGGcmW3MUsE6kj" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
5770
6725
|
<pre style="
|
|
5771
6726
|
--line-digits: 2;
|
|
5772
6727
|
--line-number-start: -1;
|
|
@@ -5780,7 +6735,7 @@ blockquote.t-editor__quote > * {
|
|
|
5780
6735
|
</svg></button>
|
|
5781
6736
|
</div>
|
|
5782
6737
|
<p class="t-editor__paragraph">The CLI also ships an <a href="https://agentskills.io" class="t-editor__anchor">Agent Skill</a> at <code inline="true" class="t-editor__inline-code">skills/scalar-cli/SKILL.md</code>, in the npm package and in the <code inline="true" class="t-editor__inline-code">app</code> directory of the standalone archives. Copy it into your agent's skills directory to teach the agent how to use the CLI:</p>
|
|
5783
|
-
<div id="
|
|
6738
|
+
<div id="M50JAC4y51BNIjWKVTGlY" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
5784
6739
|
<pre style="
|
|
5785
6740
|
--line-digits: 2;
|
|
5786
6741
|
--line-number-start: -1;
|
|
@@ -5800,6 +6755,68 @@ blockquote.t-editor__quote > * {
|
|
|
5800
6755
|
</svg></button>
|
|
5801
6756
|
</div>
|
|
5802
6757
|
<p class="t-editor__paragraph">With the standalone CLI on Windows, the skill is in <code inline="true" class="t-editor__inline-code">%LOCALAPPDATA%\Scalar\current\app\skills\scalar-cli</code>.</p>
|
|
6758
|
+
<h2 id="inspect-sdks" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
6759
|
+
Inspect SDKs
|
|
6760
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
6761
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6762
|
+
</svg>
|
|
6763
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
6764
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
6765
|
+
</svg></button>
|
|
6766
|
+
</h2>
|
|
6767
|
+
<p class="t-editor__paragraph">Use your current team login to inspect an SDK by slug. The namespace defaults to the team's first namespace.</p>
|
|
6768
|
+
<div id="TS0BRPlyt4NwZ38O2sxud" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
6769
|
+
<pre style="
|
|
6770
|
+
--line-digits: 2;
|
|
6771
|
+
--line-number-start: -1;
|
|
6772
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-bash" language="bash"><span class="t-code__line" data-line-number="0">scalar sdk get --slug widgets --namespace acme</span>
|
|
6773
|
+
<span class="t-code__line" data-line-number="1">scalar sdk get --slug widgets --namespace acme --json</span>
|
|
6774
|
+
<span class="t-code__line" data-line-number="2">scalar sdk list --namespace acme --json</span>
|
|
6775
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">bash
|
|
6776
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6777
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
6778
|
+
</svg>
|
|
6779
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6780
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6781
|
+
</svg></button>
|
|
6782
|
+
</div>
|
|
6783
|
+
<p class="t-editor__paragraph">JSON output is a metadata object for <code inline="true" class="t-editor__inline-code">get</code> and an array for <code inline="true" class="t-editor__inline-code">list</code> (including <code inline="true" class="t-editor__inline-code">[]</code> when empty). It includes the linked registry API, tracked API version, target languages and slugs, current SDK version, version history with active build IDs, and the latest attempted build with per-language generation and Git sync status. The latest attempt may be a different version or have failed; it does not replace the current version or active artifacts. Timestamps are Unix seconds; absent builds and unlinked API sources are <code inline="true" class="t-editor__inline-code">null</code>. Generator configuration, repository auth bindings, and raw build messages are excluded.</p>
|
|
6784
|
+
<h2 id="registry-metadata-for-scripts" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
6785
|
+
Registry metadata for scripts
|
|
6786
|
+
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
6787
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6788
|
+
</svg>
|
|
6789
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
6790
|
+
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
6791
|
+
</svg></button>
|
|
6792
|
+
</h2>
|
|
6793
|
+
<p class="t-editor__paragraph">
|
|
6794
|
+
Use <code inline="true" class="t-editor__inline-code">scalar registry list --json</code> to write a JSON array to stdout. Without
|
|
6795
|
+
<code inline="true" class="t-editor__inline-code">--namespace</code>, the command uses the first namespace of your current team, just
|
|
6796
|
+
like the default table output. You must be logged in; errors go to stderr and
|
|
6797
|
+
exit with a nonzero status.
|
|
6798
|
+
</p>
|
|
6799
|
+
<div id="Ne1COOsP5zHJKV6x0GdO0" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
6800
|
+
<pre style="
|
|
6801
|
+
--line-digits: 2;
|
|
6802
|
+
--line-number-start: -1;
|
|
6803
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-bash" language="bash"><span class="t-code__line" data-line-number="0">scalar registry list --namespace scalar --json > registry-apis.json</span>
|
|
6804
|
+
<span class="t-code__line" data-line-number="1">scalar registry get scalar demo-api --version 1.2.3 > openapi.json</span>
|
|
6805
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">bash
|
|
6806
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6807
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
6808
|
+
</svg>
|
|
6809
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6810
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6811
|
+
</svg></button>
|
|
6812
|
+
</div>
|
|
6813
|
+
<p class="t-editor__paragraph">
|
|
6814
|
+
Each array entry contains <code inline="true" class="t-editor__inline-code">namespace</code> and <code inline="true" class="t-editor__inline-code">slug</code> (the coordinates accepted by
|
|
6815
|
+
<code inline="true" class="t-editor__inline-code">registry get</code>), <code inline="true" class="t-editor__inline-code">title</code> (a string, which may be empty), <code inline="true" class="t-editor__inline-code">version</code> (the current
|
|
6816
|
+
version served by default), and <code inline="true" class="t-editor__inline-code">isPrivate</code> (a boolean). JSON output includes
|
|
6817
|
+
only these metadata fields, without document content or credentials. An empty
|
|
6818
|
+
namespace returns <code inline="true" class="t-editor__inline-code">[]</code>. Omit <code inline="true" class="t-editor__inline-code">--json</code> for the human-readable table.
|
|
6819
|
+
</p>
|
|
5803
6820
|
<h2 id="github-actions" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
5804
6821
|
GitHub Actions
|
|
5805
6822
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
@@ -5810,7 +6827,7 @@ blockquote.t-editor__quote > * {
|
|
|
5810
6827
|
</svg></button>
|
|
5811
6828
|
</h2>
|
|
5812
6829
|
<p class="t-editor__paragraph">To validate your OpenAPI file in GitHub Actions, add this workflow:</p>
|
|
5813
|
-
<div id="
|
|
6830
|
+
<div id="nXxsncjamCjwl06aJAWUL" class="t-editor__code-container" data-lang="yml" style="position: relative;">
|
|
5814
6831
|
<pre style="
|
|
5815
6832
|
--line-digits: 2;
|
|
5816
6833
|
--line-number-start: -1;
|
|
@@ -5846,8 +6863,8 @@ blockquote.t-editor__quote > * {
|
|
|
5846
6863
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5847
6864
|
</svg></button>
|
|
5848
6865
|
</div>
|
|
5849
|
-
<h2 id="
|
|
5850
|
-
|
|
6866
|
+
<h2 id="ci-lint-reports-and-baselines" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
6867
|
+
CI lint reports and baselines
|
|
5851
6868
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5852
6869
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5853
6870
|
</svg>
|
|
@@ -5855,14 +6872,18 @@ blockquote.t-editor__quote > * {
|
|
|
5855
6872
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5856
6873
|
</svg></button>
|
|
5857
6874
|
</h2>
|
|
5858
|
-
<p class="t-editor__paragraph">
|
|
5859
|
-
<div id="
|
|
6875
|
+
<p class="t-editor__paragraph">Lint reports support CI annotations, test-report viewers, and readable reviews:</p>
|
|
6876
|
+
<div id="BbU80neY7qE9eJ6ErSs3f" class="t-editor__code-container" data-lang="sh" style="position: relative;">
|
|
5860
6877
|
<pre style="
|
|
5861
6878
|
--line-digits: 2;
|
|
5862
6879
|
--line-number-start: -1;
|
|
5863
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-
|
|
5864
|
-
<span class="t-code__line" data-line-number="1">
|
|
5865
|
-
|
|
6880
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-sh" language="sh"><span class="t-code__line" data-line-number="0">scalar document lint openapi.yaml --format codeframe</span>
|
|
6881
|
+
<span class="t-code__line" data-line-number="1">scalar document lint openapi.yaml --format markdown --output lint-results.md</span>
|
|
6882
|
+
<span class="t-code__line" data-line-number="2">scalar document lint openapi.yaml --format summary</span>
|
|
6883
|
+
<span class="t-code__line" data-line-number="3">scalar document lint openapi.yaml --format github-actions</span>
|
|
6884
|
+
<span class="t-code__line" data-line-number="4">scalar document lint openapi.yaml --format json --output lint-results.json</span>
|
|
6885
|
+
<span class="t-code__line" data-line-number="5">scalar document lint openapi.yaml --format junit --output lint-results.xml</span>
|
|
6886
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">sh
|
|
5866
6887
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5867
6888
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5868
6889
|
</svg>
|
|
@@ -5870,14 +6891,16 @@ blockquote.t-editor__quote > * {
|
|
|
5870
6891
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5871
6892
|
</svg></button>
|
|
5872
6893
|
</div>
|
|
5873
|
-
<p class="t-editor__paragraph">
|
|
5874
|
-
<
|
|
6894
|
+
<p class="t-editor__paragraph">The default is <code inline="true" class="t-editor__inline-code">codeframe</code>, which shows source excerpts with severity colors and highlighted carets when terminal colors are enabled. <code inline="true" class="t-editor__inline-code">NO_COLOR=1</code> disables colors, and reports saved with <code inline="true" class="t-editor__inline-code">--output</code> are always plain text. Use <code inline="true" class="t-editor__inline-code">--format text</code> for the native report. <code inline="true" class="t-editor__inline-code">markdown</code> produces tables grouped by source, and <code inline="true" class="t-editor__inline-code">summary</code> counts findings by rule and severity. Machine-readable reports use 1-based locations; text retains engine-native coordinates. Codeframes omit excerpts for unavailable sources.</p>
|
|
6895
|
+
<p class="t-editor__paragraph"><code inline="true" class="t-editor__inline-code">--max-problems <number></code> limits displayed findings to 100 by default. Findings are ordered by severity, with errors first. Use <code inline="true" class="t-editor__inline-code">--max-problems 0</code> to hide all findings. Counts and the exit status always include every active finding, and baseline generation records all findings regardless of this limit. Summary rule counts cover the displayed findings; its final error/warning totals cover all findings. Truncation notices go to stderr, keeping JSON and XML valid.</p>
|
|
6896
|
+
<p class="t-editor__paragraph">Reports go to stdout unless <code inline="true" class="t-editor__inline-code">--output</code> is given. Status, upgrade, and truncation notices go to stderr. Reports are written even when lint findings cause a nonzero exit. Both shell redirection and <code inline="true" class="t-editor__inline-code">--output</code> work:</p>
|
|
6897
|
+
<div id="222GmXZbhLMUQ2oWkIX78" class="t-editor__code-container" data-lang="sh" style="position: relative;">
|
|
5875
6898
|
<pre style="
|
|
5876
6899
|
--line-digits: 2;
|
|
5877
6900
|
--line-number-start: -1;
|
|
5878
|
-
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-
|
|
5879
|
-
<span class="t-code__line" data-line-number="1">scalar --
|
|
5880
|
-
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">
|
|
6901
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-sh" language="sh"><span class="t-code__line" data-line-number="0">scalar document lint openapi.yaml --format json > lint-results.json</span>
|
|
6902
|
+
<span class="t-code__line" data-line-number="1">scalar document lint openapi.yaml --format json --output lint-results.json</span>
|
|
6903
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">sh
|
|
5881
6904
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5882
6905
|
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5883
6906
|
</svg>
|
|
@@ -5885,36 +6908,56 @@ blockquote.t-editor__quote > * {
|
|
|
5885
6908
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5886
6909
|
</svg></button>
|
|
5887
6910
|
</div>
|
|
5888
|
-
<
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
6911
|
+
<p class="t-editor__paragraph">Prefer <code inline="true" class="t-editor__inline-code">--output</code> in scripts when you want Scalar to check the destination against the input, custom ruleset, baseline, and referenced source files (including clean nested references and file aliases). Shell redirection is convenient for piping; the shell opens or truncates the destination before Scalar starts, so Scalar cannot protect that destination. Parent directories for <code inline="true" class="t-editor__inline-code">--output</code> must already exist.</p>
|
|
6912
|
+
<p class="t-editor__paragraph">JSON follows Redocly's report shape: <code inline="true" class="t-editor__inline-code">totals</code> contains error, warning, and ignored counts; <code inline="true" class="t-editor__inline-code">version</code> is the Scalar CLI version; <code inline="true" class="t-editor__inline-code">problems</code> is the displayed findings array. Each problem includes <code inline="true" class="t-editor__inline-code">ruleId</code>, <code inline="true" class="t-editor__inline-code">severity</code> (<code inline="true" class="t-editor__inline-code">error</code>, <code inline="true" class="t-editor__inline-code">warn</code>, <code inline="true" class="t-editor__inline-code">info</code>, or <code inline="true" class="t-editor__inline-code">hint</code>), <code inline="true" class="t-editor__inline-code">message</code>, <code inline="true" class="t-editor__inline-code">suggest</code>, optional rule <code inline="true" class="t-editor__inline-code">reference</code>, and a <code inline="true" class="t-editor__inline-code">location</code> array. Locations contain <code inline="true" class="t-editor__inline-code">source.ref</code>, a JSON <code inline="true" class="t-editor__inline-code">pointer</code>, and 1-based <code inline="true" class="t-editor__inline-code">start</code>/<code inline="true" class="t-editor__inline-code">end</code> positions with <code inline="true" class="t-editor__inline-code">line</code> and <code inline="true" class="t-editor__inline-code">col</code>. Local sources are relative to the current directory; URLs remain absolute. Rule IDs and findings still come from Scalar's Vacuum/Spectral engines. Duplicate-operation-ID findings include the participating definitions, including referenced path items and callbacks. Reports preserve additional locations when supplied by the engine; totals and JUnit still count one testcase per finding, and ignore matching uses the primary location, with legacy native paths retained as matching candidates. Scalar does not yet provide Redocly's typo suggestions.</p>
|
|
6913
|
+
<p class="t-editor__paragraph">GitHub Actions reports use error, warning, and notice annotations with start and end positions and available rule documentation links. Local files are relative to <code inline="true" class="t-editor__inline-code">GITHUB_WORKSPACE</code>, or the current directory outside Actions. Remote sources appear in the message without a repository file attachment. When saved with <code inline="true" class="t-editor__inline-code">--output</code>, annotations must subsequently be printed to the runner's stdout to become visible.</p>
|
|
6914
|
+
<p class="t-editor__paragraph">JUnit groups findings into suites by source, with one testcase per displayed finding. To match Redocly, lint errors become XML <code inline="true" class="t-editor__inline-code">error</code> entries, warnings become <code inline="true" class="t-editor__inline-code">failure</code> entries, and information/hints become <code inline="true" class="t-editor__inline-code">system-out</code>. Warnings still do not make the lint command exit nonzero, and JUnit viewers classify those testcases as failed. The CLI lint report compatibility workflow verifies this behavior using the Java JUnit viewer in <code inline="true" class="t-editor__inline-code">dorny/test-reporter</code>. The <code inline="true" class="t-editor__inline-code">Scalar lint totals</code> suite records full error, warning, ignored, and hidden counts as properties. A clean run produces a valid zero-test report. Configure CI to upload reports even when the lint step fails.</p>
|
|
6915
|
+
<p class="t-editor__paragraph">To adopt linting with existing findings:</p>
|
|
6916
|
+
<div id="Cei2Ae6ullExTH928zFS8" class="t-editor__code-container" data-lang="sh" style="position: relative;">
|
|
6917
|
+
<pre style="
|
|
6918
|
+
--line-digits: 2;
|
|
6919
|
+
--line-number-start: -1;
|
|
6920
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-sh" language="sh"><span class="t-code__line" data-line-number="0">scalar document lint openapi.yaml --generate-ignore-file</span>
|
|
6921
|
+
<span class="t-code__line" data-line-number="1">scalar document lint openapi.yaml --format github-actions</span>
|
|
6922
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">sh
|
|
6923
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6924
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5892
6925
|
</svg>
|
|
5893
|
-
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256"
|
|
5894
|
-
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5895
|
-
</svg></button>
|
|
5896
|
-
</h3>
|
|
5897
|
-
<p class="t-editor__paragraph"><code inline="true" class="t-editor__inline-code">scalar project preview</code> runs the docs in a preview server that the CLI downloads to <code inline="true" class="t-editor__inline-code">~/.scalar/isolate</code> on first use. Every CLI release publishes a matching archive to the CDN, so a released CLI always finds its own. A build from source has no archive until its version ships: the CLI then falls back to the newest published release with the same major version and says which one it used, and otherwise reports that the version is missing. To pin a specific published version instead, set <code inline="true" class="t-editor__inline-code">SSG_DOCS_ISOLATE_VERSION</code> to the version of a released CLI (<code inline="true" class="t-editor__inline-code">https://cdn.scalar.com/isolates/latest.json</code> names the newest one).</p>
|
|
5898
|
-
<h2 id="community" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
5899
|
-
Community
|
|
5900
|
-
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
6926
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5901
6927
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
6928
|
+
</svg></button>
|
|
6929
|
+
</div>
|
|
6930
|
+
<p class="t-editor__paragraph">Commit the generated <code inline="true" class="t-editor__inline-code">.scalar.lint-ignore.yaml</code>. Subsequent runs automatically read it from the current directory. <code inline="true" class="t-editor__inline-code">--ignore-file <file></code> overrides that location for generation and linting, including an existing <code inline="true" class="t-editor__inline-code">.redocly.lint-ignore.yaml</code>. Relative paths resolve from the current directory; no parent-directory search is performed. If Scalar's file is absent, linting automatically falls back to <code inline="true" class="t-editor__inline-code">.redocly.lint-ignore.yaml</code>. You can also rename a Redocly ignore file to <code inline="true" class="t-editor__inline-code">.scalar.lint-ignore.yaml</code>; Scalar's file always wins when both exist. Generation defaults to Scalar's filename and leaves Redocly's file intact. Scalar does not read <code inline="true" class="t-editor__inline-code">redocly.yaml</code>.</p>
|
|
6931
|
+
<p class="t-editor__paragraph">For OpenAPI with the default ruleset, imported mappings support the audited Redocly rules <code inline="true" class="t-editor__inline-code">info-contact</code>, <code inline="true" class="t-editor__inline-code">info-license</code>, <code inline="true" class="t-editor__inline-code">operation-description</code>, <code inline="true" class="t-editor__inline-code">operation-operationId</code>, <code inline="true" class="t-editor__inline-code">operation-operationId-url-safe</code> (mapped to Scalar's <code inline="true" class="t-editor__inline-code">operation-operationId-valid-in-url</code>), <code inline="true" class="t-editor__inline-code">no-path-trailing-slash</code> (<code inline="true" class="t-editor__inline-code">path-keys-no-trailing-slash</code>), <code inline="true" class="t-editor__inline-code">path-declaration-must-exist</code> (<code inline="true" class="t-editor__inline-code">path-declarations-must-exist</code>), <code inline="true" class="t-editor__inline-code">path-not-include-query</code>, <code inline="true" class="t-editor__inline-code">tag-description</code>, and <code inline="true" class="t-editor__inline-code">operation-singular-tag</code>. Missing-field pointers are adapted where the engines report the containing object. This does not enable rules that Scalar's default engine disables. Unsupported rules produce a notice on stderr; only exact Scalar rule/pointer matches apply to those entries. Severity-only overrides of these audited built-in rules retain migration support. Custom definitions, unknown inheritance, and AsyncAPI use exact Scalar identities. Redocly’s <code inline="true" class="t-editor__inline-code">operation-2xx-response</code> is not mapped to Scalar’s <code inline="true" class="t-editor__inline-code">operation-success-response</code>, which also accepts 3xx responses. Full custom-rule compatibility would require running Redocly itself.</p>
|
|
6932
|
+
<p class="t-editor__paragraph">The YAML mapping uses Redocly's source → rule → JSON-pointer structure:</p>
|
|
6933
|
+
<div id="vqcOu6NWn3FnWCvtayAGs" class="t-editor__code-container" data-lang="yaml" style="position: relative;">
|
|
6934
|
+
<pre style="
|
|
6935
|
+
--line-digits: 2;
|
|
6936
|
+
--line-number-start: -1;
|
|
6937
|
+
" class="t-editor__code custom-code custom-scroll" data-focus="" data-highlight="" data-added="" data-removed="" data-line-number-start="0"><code class="hljs language-yaml" language="yaml"><span class="t-code__line" data-line-number="0"><span class="hljs-attr">openapi.yaml:</span></span>
|
|
6938
|
+
<span class="t-code__line" data-line-number="1"> <span class="hljs-attr">info-description:</span></span>
|
|
6939
|
+
<span class="t-code__line" data-line-number="2"> <span class="hljs-bullet">-</span> <span class="hljs-string">'#/info'</span></span>
|
|
6940
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">yaml
|
|
6941
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6942
|
+
<path d="M216,32H88a8,8,0,0,0-8,8V80H40a8,8,0,0,0-8,8V216a8,8,0,0,0,8,8H168a8,8,0,0,0,8-8V176h40a8,8,0,0,0,8-8V40A8,8,0,0,0,216,32ZM160,208H48V96H160Zm48-48H176V88a8,8,0,0,0-8-8H96V48H208Z"></path>
|
|
5902
6943
|
</svg>
|
|
5903
|
-
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256"
|
|
5904
|
-
<path d="
|
|
6944
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6945
|
+
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5905
6946
|
</svg></button>
|
|
5906
|
-
</
|
|
5907
|
-
<p class="t-editor__paragraph">
|
|
5908
|
-
<
|
|
5909
|
-
|
|
6947
|
+
</div>
|
|
6948
|
+
<p class="t-editor__paragraph">Local source paths are relative to the baseline directory. Matching ignores message, severity, and line changes. Mounted reference paths are resolved to physical source pointers, including nested references; older Scalar baselines using native mount paths continue to match. Path-key findings use the key location to distinguish specific path entries. Root pointers use <code inline="true" class="t-editor__inline-code">#</code>; <code inline="true" class="t-editor__inline-code">/</code> and <code inline="true" class="t-editor__inline-code">~</code> in property names use RFC 6901 escaping. Numeric and string path segments with the same pointer identify the same location.</p>
|
|
6949
|
+
<p class="t-editor__paragraph">Generation records all current findings and exits successfully after writing the baseline. Generation serializes baseline reads and writes to preserve concurrent updates. A leftover <code inline="true" class="t-editor__inline-code">.lock</code> directory after an interrupted process must be removed only when no generator is running. Regeneration replaces only the selected input document's entries and preserves other inputs, including shared references. Scalar stores input ownership in a YAML comment (<code inline="true" class="t-editor__inline-code">scalar-owners</code>) that Redocly ignores. Keep that comment to retain shared-reference ownership; without it, imported entries belong to their source file. Manual edits to the mapping take precedence over comment metadata. Legacy Scalar version 1 baselines remain readable and are migrated to this mapping on regeneration.</p>
|
|
6950
|
+
<p class="t-editor__paragraph">Matched findings are omitted from reports. Only unmatched errors cause exit 1; warnings, information, and hints do not fail lint. Operational failures, malformed baselines, and missing explicitly selected baselines exit nonzero. A missing default baseline is allowed. Multiple findings at the same source/rule/pointer share one entry. Resolved entries remain harmless until regeneration but can suppress a recurrence; array reordering, document renames, or rule changes may produce new identities.</p>
|
|
6951
|
+
<h3 id="schema-metadata" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
6952
|
+
Schema metadata
|
|
5910
6953
|
<button class="notify-container" aria-label="Copy link to heading"><svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon notify">
|
|
5911
6954
|
<path d="M229.66,77.66l-128,128a8,8,0,0,1-11.32,0l-56-56a8,8,0,0,1,11.32-11.32L96,188.69,218.34,66.34a8,8,0,0,1,11.32,11.32Z"></path>
|
|
5912
6955
|
</svg>
|
|
5913
6956
|
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
5914
6957
|
<path d="M224,88H175.4l8.47-46.57a8,8,0,0,0-15.74-2.86l-9,49.43H111.4l8.47-46.57a8,8,0,0,0-15.74-2.86L95.14,88H48a8,8,0,0,0,0,16H92.23L83.5,152H32a8,8,0,0,0,0,16H80.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,80,224a8,8,0,0,0,7.86-6.57l9-49.43H144.6l-8.47,46.57a8,8,0,0,0,6.44,9.3A7.79,7.79,0,0,0,144,224a8,8,0,0,0,7.86-6.57l9-49.43H208a8,8,0,0,0,0-16H163.77l8.73-48H224a8,8,0,0,0,0-16Zm-76.5,64H99.77l8.73-48h47.73Z"></path>
|
|
5915
6958
|
</svg></button>
|
|
5916
|
-
</
|
|
5917
|
-
<p class="t-editor__paragraph">
|
|
6959
|
+
</h3>
|
|
6960
|
+
<p class="t-editor__paragraph">Use <code inline="true" class="t-editor__inline-code">scalar schema list --json</code> to discover schemas in the current team namespace, or pass <code inline="true" class="t-editor__inline-code">--namespace <namespace></code> to choose one. The output is an array of objects with <code inline="true" class="t-editor__inline-code">namespace</code>, <code inline="true" class="t-editor__inline-code">slug</code>, <code inline="true" class="t-editor__inline-code">title</code>, <code inline="true" class="t-editor__inline-code">version</code>, and <code inline="true" class="t-editor__inline-code">isPrivate</code>. <code inline="true" class="t-editor__inline-code">version</code> is the latest semantic version, or <code inline="true" class="t-editor__inline-code">null</code> when there are no versions. An empty namespace returns <code inline="true" class="t-editor__inline-code">[]</code>. Schema content is omitted; use <code inline="true" class="t-editor__inline-code">scalar schema get</code> to download it.</p>
|
|
5918
6961
|
|
|
5919
6962
|
</div>
|
|
5920
6963
|
</body>
|