@scalar/cli 2.8.0 → 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 +281 -65
- package/chunks/action-4GZI2M5B.js +62 -0
- package/chunks/action-4W5GUGEG.js +63 -0
- package/chunks/{action-FCAYFPVR.js → action-5LF4XYHX.js} +10 -7
- package/chunks/{action-XIUO64C7.js → action-5N3P43MD.js} +17 -12
- package/chunks/{action-Y7OUGD56.js → action-5RL4NWUZ.js} +17 -17
- package/chunks/{action-LXGXKXZZ.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-UIKH4SZX.js → action-EAUTQ77U.js} +27 -23
- package/chunks/{action-YLF2G4G5.js → action-FBRY5JKU.js} +16 -16
- package/chunks/{action-VOFDW3U2.js → action-GFLRD7LO.js} +6 -5
- package/chunks/{action-GWXLHL2Z.js → action-GWYYTUTM.js} +4 -3
- package/chunks/{action-6BYGBXRC.js → action-HT42NUUX.js} +27 -22
- package/chunks/action-JEYDBB3P.js +147 -0
- package/chunks/{action-LLH4QPXM.js → action-KDUFU7TZ.js} +11 -13
- package/chunks/{action-W3C53GPH.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-43YBNBDR.js → action-R4PGILN4.js} +28 -24
- package/chunks/{action-QQZLPI42.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-354TUG4H.js → action-X7BA7PQQ.js} +10 -8
- package/chunks/{action-WFDNRA7D.js → action-XLE37MZL.js} +16 -16
- package/chunks/{action-Y6NXJQ4H.js → action-XOADBXSX.js} +16 -12
- package/chunks/{action-LEUD5P2U.js → action-YSVTZVKV.js} +36 -17
- package/chunks/{action-YRX6SN5F.js → action-ZFI77WA5.js} +8 -6
- package/chunks/{action-HT2DJ34Z.js → action-ZKA3RR3S.js} +15 -11
- package/chunks/{actions-OGIVBQC7.js → actions-3SAMH7A5.js} +41 -17
- package/chunks/{agent-ASPV3R5U.js → agent-2ESZI7NO.js} +7 -5
- package/chunks/{asyncapi-QNFKXHEI.js → asyncapi-4HGVM3PR.js} +14 -10
- package/chunks/{build.action-NM6CAE5F.js → build.action-VBGFGACM.js} +19 -17
- package/chunks/chunk-35Z7VTJT.js +453 -0
- package/chunks/chunk-36LXIJIZ.js +52 -0
- package/chunks/{chunk-KKRGBXCE.js → chunk-43WALAW3.js} +248 -103
- package/chunks/{chunk-C2KAWRIX.js → chunk-5ENKYZA4.js} +1 -1
- package/chunks/{chunk-GTV2BVXV.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-EXY3ZTV4.js → chunk-ATNTXKMS.js} +36 -274
- package/chunks/{chunk-PH3WFNXJ.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-2OCWX42S.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-BPGFSSUH.js → chunk-VYFGRLVQ.js} +1 -1
- package/chunks/{chunk-UXJ753NV.js → chunk-WB6PWTMU.js} +5 -13
- package/chunks/{chunk-5DEU2DVL.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-22HYZ7LE.js → chunk-ZGNDXPLU.js} +3 -3
- package/chunks/{chunk-XEDGMZJD.js → chunk-ZGVZU6L2.js} +81 -25
- package/chunks/{chunk-L3UXDCBI.js → chunk-ZKJPLWRJ.js} +2 -2
- package/chunks/{chunk-MLSZVVTT.js → chunk-ZYBLQ5CT.js} +13 -7
- package/chunks/{create.action-FUQ2BVJA.js → create.action-DBNIS665.js} +19 -17
- package/chunks/{delete.action-BTDFH7WY.js → delete.action-GBOZC45K.js} +19 -17
- package/chunks/{delete.action-47E66R3I.js → delete.action-K7BLK7DK.js} +19 -17
- package/chunks/{get.action-XC7KC2JO.js → get.action-N3JOY3OU.js} +17 -12
- package/chunks/get.action-QHKMYZBK.js +91 -0
- package/chunks/{list.action-LXKEUYKO.js → list.action-6SSO3JVN.js} +45 -15
- package/chunks/{list.action-OFGLMRE7.js → list.action-TJCS6UEY.js} +39 -19
- package/chunks/{publish.action-OS27XOX4.js → publish.action-T24VHRMR.js} +27 -22
- package/chunks/query-WKATAJJ6.js +129 -0
- package/chunks/scripts-VIBLGKYG.js +102 -0
- package/chunks/{update.action-ZMS4CQ3T.js → update.action-OGYNBXRU.js} +23 -18
- package/chunks/{update.action-AEIBLCWD.js → update.action-VOE6PH5F.js} +23 -18
- package/docs.html +941 -209
- package/index.js +374 -182
- package/package.json +14 -13
- package/skills/scalar-cli/SKILL.md +7 -1
- package/template.md +148 -26
- package/chunks/action-JAHFRYWZ.js +0 -423
- package/chunks/action-KTYOCA2V.js +0 -229
- package/chunks/chunk-K74E42RV.js +0 -7311
- package/chunks/chunk-QVQ4PNVL.js +0 -610
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,8 +4166,8 @@ blockquote.t-editor__quote > * {
|
|
|
3853
4166
|
<li>Preview your API reference</li>
|
|
3854
4167
|
<li>Bundle multiple OpenAPI files</li>
|
|
3855
4168
|
</ul>
|
|
3856
|
-
<h2 id="
|
|
3857
|
-
|
|
4169
|
+
<h2 id="projects" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4170
|
+
Projects
|
|
3858
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">
|
|
3859
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>
|
|
3860
4173
|
</svg>
|
|
@@ -3862,18 +4175,15 @@ blockquote.t-editor__quote > * {
|
|
|
3862
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>
|
|
3863
4176
|
</svg></button>
|
|
3864
4177
|
</h2>
|
|
3865
|
-
<p class="t-editor__paragraph">
|
|
3866
|
-
<div id="
|
|
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;">
|
|
3867
4180
|
<pre style="
|
|
3868
4181
|
--line-digits: 2;
|
|
3869
4182
|
--line-number-start: -1;
|
|
3870
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>
|
|
3871
|
-
<span class="t-code__line" data-line-number="1">scalar
|
|
3872
|
-
<span class="t-code__line" data-line-number="2">scalar
|
|
3873
|
-
<span class="t-code__line" data-line-number="3">scalar
|
|
3874
|
-
<span class="t-code__line" data-line-number="4">scalar access-group domain add partners partner.com</span>
|
|
3875
|
-
<span class="t-code__line" data-line-number="5">scalar access-group domain remove partners partner.com</span>
|
|
3876
|
-
<span class="t-code__line" data-line-number="6">scalar access-group delete partners --<span class="hljs-built_in">yes</span></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>
|
|
3877
4187
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">bash
|
|
3878
4188
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
3879
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>
|
|
@@ -3882,9 +4192,9 @@ blockquote.t-editor__quote > * {
|
|
|
3882
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>
|
|
3883
4193
|
</svg></button>
|
|
3884
4194
|
</div>
|
|
3885
|
-
<p class="t-editor__paragraph">
|
|
3886
|
-
<p class="t-editor__paragraph">Use <code inline="true" class="t-editor__inline-code"
|
|
3887
|
-
<p class="t-editor__paragraph">
|
|
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>
|
|
3888
4198
|
<h2 id="documentation" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
3889
4199
|
Documentation
|
|
3890
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">
|
|
@@ -3904,7 +4214,7 @@ blockquote.t-editor__quote > * {
|
|
|
3904
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>
|
|
3905
4215
|
</svg></button>
|
|
3906
4216
|
</h2>
|
|
3907
|
-
<div id="
|
|
4217
|
+
<div id="Yn9MUg7J7xdGI6gzFzwq4" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3908
4218
|
<pre style="
|
|
3909
4219
|
--line-digits: 2;
|
|
3910
4220
|
--line-number-start: -1;
|
|
@@ -3937,7 +4247,7 @@ blockquote.t-editor__quote > * {
|
|
|
3937
4247
|
</h3>
|
|
3938
4248
|
<p class="t-editor__paragraph">Install the latest stable release without Node.js, npm, or administrator access.</p>
|
|
3939
4249
|
<p class="t-editor__paragraph">macOS and Linux (Bash):</p>
|
|
3940
|
-
<div id="
|
|
4250
|
+
<div id="D9g8uFyvNg5pXfpgyxI3j" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3941
4251
|
<pre style="
|
|
3942
4252
|
--line-digits: 2;
|
|
3943
4253
|
--line-number-start: -1;
|
|
@@ -3951,7 +4261,7 @@ blockquote.t-editor__quote > * {
|
|
|
3951
4261
|
</svg></button>
|
|
3952
4262
|
</div>
|
|
3953
4263
|
<p class="t-editor__paragraph">Windows (PowerShell):</p>
|
|
3954
|
-
<div id="
|
|
4264
|
+
<div id="JA18e7yCY95ZPiEpEtKdz" class="t-editor__code-container" data-lang="powershell" style="position: relative;">
|
|
3955
4265
|
<pre style="
|
|
3956
4266
|
--line-digits: 2;
|
|
3957
4267
|
--line-number-start: -1;
|
|
@@ -3977,7 +4287,7 @@ blockquote.t-editor__quote > * {
|
|
|
3977
4287
|
</svg></button>
|
|
3978
4288
|
</h3>
|
|
3979
4289
|
<p class="t-editor__paragraph">If you already use Node.js, install the CLI with npm:</p>
|
|
3980
|
-
<div id="
|
|
4290
|
+
<div id="tc5qh3Xn8RmmJEBtBANGC" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
3981
4291
|
<pre style="
|
|
3982
4292
|
--line-digits: 2;
|
|
3983
4293
|
--line-number-start: -1;
|
|
@@ -4001,7 +4311,7 @@ blockquote.t-editor__quote > * {
|
|
|
4001
4311
|
</svg></button>
|
|
4002
4312
|
</h3>
|
|
4003
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>
|
|
4004
|
-
<div id="
|
|
4314
|
+
<div id="HDXbs6cMRrX8CiPXuZ0ob" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
4005
4315
|
<pre style="
|
|
4006
4316
|
--line-digits: 2;
|
|
4007
4317
|
--line-number-start: -1;
|
|
@@ -4015,7 +4325,7 @@ blockquote.t-editor__quote > * {
|
|
|
4015
4325
|
</svg></button>
|
|
4016
4326
|
</div>
|
|
4017
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>
|
|
4018
|
-
<div id="
|
|
4328
|
+
<div id="MZooA3oM7ZMygosfsVnxE" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
4019
4329
|
<pre style="
|
|
4020
4330
|
--line-digits: 2;
|
|
4021
4331
|
--line-number-start: -1;
|
|
@@ -4032,6 +4342,118 @@ blockquote.t-editor__quote > * {
|
|
|
4032
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>
|
|
4033
4343
|
</svg></button>
|
|
4034
4344
|
</div>
|
|
4345
|
+
<h2 id="shell-completion" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4346
|
+
Shell completion
|
|
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">
|
|
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>
|
|
4349
|
+
</svg>
|
|
4350
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
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>
|
|
4352
|
+
</svg></button>
|
|
4353
|
+
</h2>
|
|
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;">
|
|
4365
|
+
<pre style="
|
|
4366
|
+
--line-digits: 2;
|
|
4367
|
+
--line-number-start: -1;
|
|
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
|
|
4372
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
4374
|
+
</svg>
|
|
4375
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
4377
|
+
</svg></button>
|
|
4378
|
+
</div>
|
|
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;">
|
|
4390
|
+
<pre style="
|
|
4391
|
+
--line-digits: 2;
|
|
4392
|
+
--line-number-start: -1;
|
|
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
|
|
4396
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
4398
|
+
</svg>
|
|
4399
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
4401
|
+
</svg></button>
|
|
4402
|
+
</div>
|
|
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>
|
|
4414
|
+
</svg>
|
|
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>
|
|
4417
|
+
</svg></button>
|
|
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
|
|
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">
|
|
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>
|
|
4424
|
+
</svg>
|
|
4425
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
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>
|
|
4427
|
+
</svg></button>
|
|
4428
|
+
</h3>
|
|
4429
|
+
<div id="rXdSncOypqMIQ5OU8G6vC" class="t-editor__code-container" data-lang="fish" style="position: relative;">
|
|
4430
|
+
<pre style="
|
|
4431
|
+
--line-digits: 2;
|
|
4432
|
+
--line-number-start: -1;
|
|
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
|
|
4437
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
4439
|
+
</svg>
|
|
4440
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
4442
|
+
</svg></button>
|
|
4443
|
+
</div>
|
|
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
|
|
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">
|
|
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>
|
|
4449
|
+
</svg>
|
|
4450
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
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>
|
|
4452
|
+
</svg></button>
|
|
4453
|
+
</h3>
|
|
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>
|
|
4035
4457
|
<h2 id="api-reference-configuration" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4036
4458
|
API Reference configuration
|
|
4037
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">
|
|
@@ -4042,7 +4464,7 @@ blockquote.t-editor__quote > * {
|
|
|
4042
4464
|
</svg></button>
|
|
4043
4465
|
</h2>
|
|
4044
4466
|
<p class="t-editor__paragraph">Pass API Reference options as a JSON object:</p>
|
|
4045
|
-
<div id="
|
|
4467
|
+
<div id="Q55Z7LCBpBO4OnevAOjhC" class="t-editor__code-container" data-lang="sh" style="position: relative;">
|
|
4046
4468
|
<pre style="
|
|
4047
4469
|
--line-digits: 2;
|
|
4048
4470
|
--line-number-start: -1;
|
|
@@ -4055,7 +4477,7 @@ blockquote.t-editor__quote > * {
|
|
|
4055
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>
|
|
4056
4478
|
</svg></button>
|
|
4057
4479
|
</div>
|
|
4058
|
-
<div id="
|
|
4480
|
+
<div id="wtiKLQs3ELfxzR0Cc7RpK" class="t-editor__code-container" data-lang="json" style="position: relative;">
|
|
4059
4481
|
<pre style="
|
|
4060
4482
|
--line-digits: 2;
|
|
4061
4483
|
--line-number-start: -1;
|
|
@@ -4095,6 +4517,32 @@ blockquote.t-editor__quote > * {
|
|
|
4095
4517
|
Supply required options in automation instead of relying on interactive prompts.
|
|
4096
4518
|
For example, pass <code inline="true" class="t-editor__inline-code">--output</code> for document transformations.
|
|
4097
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>
|
|
4098
4546
|
<h2 id="commands" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
4099
4547
|
Commands
|
|
4100
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">
|
|
@@ -4104,7 +4552,7 @@ blockquote.t-editor__quote > * {
|
|
|
4104
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>
|
|
4105
4553
|
</svg></button>
|
|
4106
4554
|
</h2>
|
|
4107
|
-
<div id="
|
|
4555
|
+
<div id="GkM4RmJJNQUvZ3SioC7TO" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4108
4556
|
<pre style="
|
|
4109
4557
|
--line-digits: 2;
|
|
4110
4558
|
--line-number-start: -1;
|
|
@@ -4113,24 +4561,23 @@ blockquote.t-editor__quote > * {
|
|
|
4113
4561
|
<span class="t-code__line" data-line-number="2">CLI to work with your OpenAPI files</span>
|
|
4114
4562
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4115
4563
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4116
|
-
<span class="t-code__line" data-line-number="5"> -v, --version
|
|
4117
|
-
<span class="t-code__line" data-line-number="6"> -h, --help
|
|
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>
|
|
4118
4566
|
<span class="t-code__line" data-line-number="7"></span>
|
|
4119
4567
|
<span class="t-code__line" data-line-number="8">Commands:</span>
|
|
4120
|
-
<span class="t-code__line" data-line-number="9"> readme
|
|
4121
|
-
<span class="t-code__line" data-line-number="10"> upgrade
|
|
4122
|
-
<span class="t-code__line" data-line-number="11"> context
|
|
4123
|
-
<span class="t-code__line" data-line-number="12">
|
|
4124
|
-
<span class="t-code__line" data-line-number="13"> auth
|
|
4125
|
-
<span class="t-code__line" data-line-number="14"> access-group
|
|
4126
|
-
<span class="t-code__line" data-line-number="15">
|
|
4127
|
-
<span class="t-code__line" data-line-number="16">
|
|
4128
|
-
<span class="t-code__line" data-line-number="17">
|
|
4129
|
-
<span class="t-code__line" data-line-number="18">
|
|
4130
|
-
<span class="t-code__line" data-line-number="19">
|
|
4131
|
-
<span class="t-code__line" data-line-number="20">
|
|
4132
|
-
<span class="t-code__line" data-line-number="21">
|
|
4133
|
-
<span class="t-code__line" data-line-number="22"> help [command] display help for command</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>
|
|
4134
4581
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4135
4582
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4136
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>
|
|
@@ -4148,7 +4595,7 @@ blockquote.t-editor__quote > * {
|
|
|
4148
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>
|
|
4149
4596
|
</svg></button>
|
|
4150
4597
|
</h3>
|
|
4151
|
-
<div id="
|
|
4598
|
+
<div id="FoBcmDi0EPbCogY32kzTY" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4152
4599
|
<pre style="
|
|
4153
4600
|
--line-digits: 2;
|
|
4154
4601
|
--line-number-start: -1;
|
|
@@ -4178,7 +4625,7 @@ blockquote.t-editor__quote > * {
|
|
|
4178
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>
|
|
4179
4626
|
</svg></button>
|
|
4180
4627
|
</h4>
|
|
4181
|
-
<div id="
|
|
4628
|
+
<div id="46NOb7I7NKg8sAgdxLTmJ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4182
4629
|
<pre style="
|
|
4183
4630
|
--line-digits: 2;
|
|
4184
4631
|
--line-number-start: -1;
|
|
@@ -4206,7 +4653,7 @@ blockquote.t-editor__quote > * {
|
|
|
4206
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>
|
|
4207
4654
|
</svg></button>
|
|
4208
4655
|
</h3>
|
|
4209
|
-
<div id="
|
|
4656
|
+
<div id="MRBy9YcpnsjBHRnSHstBM" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4210
4657
|
<pre style="
|
|
4211
4658
|
--line-digits: 2;
|
|
4212
4659
|
--line-number-start: -1;
|
|
@@ -4233,7 +4680,7 @@ blockquote.t-editor__quote > * {
|
|
|
4233
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>
|
|
4234
4681
|
</svg></button>
|
|
4235
4682
|
</h3>
|
|
4236
|
-
<div id="
|
|
4683
|
+
<div id="OfqXgd6VYZoQjR6xhm6u8" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4237
4684
|
<pre style="
|
|
4238
4685
|
--line-digits: 2;
|
|
4239
4686
|
--line-number-start: -1;
|
|
@@ -4251,6 +4698,36 @@ blockquote.t-editor__quote > * {
|
|
|
4251
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>
|
|
4252
4699
|
</svg></button>
|
|
4253
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>
|
|
4254
4731
|
<h3 id="auth" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="3" data-scalar-type="heading">
|
|
4255
4732
|
auth
|
|
4256
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">
|
|
@@ -4260,7 +4737,7 @@ blockquote.t-editor__quote > * {
|
|
|
4260
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>
|
|
4261
4738
|
</svg></button>
|
|
4262
4739
|
</h3>
|
|
4263
|
-
<div id="
|
|
4740
|
+
<div id="g1lB5G9zvy1xPRyvHNRaB" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4264
4741
|
<pre style="
|
|
4265
4742
|
--line-digits: 2;
|
|
4266
4743
|
--line-number-start: -1;
|
|
@@ -4293,7 +4770,7 @@ blockquote.t-editor__quote > * {
|
|
|
4293
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>
|
|
4294
4771
|
</svg></button>
|
|
4295
4772
|
</h4>
|
|
4296
|
-
<div id="
|
|
4773
|
+
<div id="YMRVeXMZAcrH0MH3OEYwa" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4297
4774
|
<pre style="
|
|
4298
4775
|
--line-digits: 2;
|
|
4299
4776
|
--line-number-start: -1;
|
|
@@ -4302,10 +4779,8 @@ blockquote.t-editor__quote > * {
|
|
|
4302
4779
|
<span class="t-code__line" data-line-number="2">Login to scalar</span>
|
|
4303
4780
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4304
4781
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
4305
|
-
<span class="t-code__line" data-line-number="5"> --
|
|
4306
|
-
<span class="t-code__line" data-line-number="6"> --
|
|
4307
|
-
<span class="t-code__line" data-line-number="7"> --token <token> Personal token</span>
|
|
4308
|
-
<span class="t-code__line" data-line-number="8"> -h, --help display help for command</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>
|
|
4309
4784
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4310
4785
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4311
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>
|
|
@@ -4323,7 +4798,7 @@ blockquote.t-editor__quote > * {
|
|
|
4323
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>
|
|
4324
4799
|
</svg></button>
|
|
4325
4800
|
</h4>
|
|
4326
|
-
<div id="
|
|
4801
|
+
<div id="5iy2Za9PGW0fwtypuEL2v" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4327
4802
|
<pre style="
|
|
4328
4803
|
--line-digits: 2;
|
|
4329
4804
|
--line-number-start: -1;
|
|
@@ -4350,7 +4825,7 @@ blockquote.t-editor__quote > * {
|
|
|
4350
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>
|
|
4351
4826
|
</svg></button>
|
|
4352
4827
|
</h4>
|
|
4353
|
-
<div id="
|
|
4828
|
+
<div id="tidjSb8c5n8H5PI37Be9f" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4354
4829
|
<pre style="
|
|
4355
4830
|
--line-digits: 2;
|
|
4356
4831
|
--line-number-start: -1;
|
|
@@ -4377,7 +4852,7 @@ blockquote.t-editor__quote > * {
|
|
|
4377
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>
|
|
4378
4853
|
</svg></button>
|
|
4379
4854
|
</h3>
|
|
4380
|
-
<div id="
|
|
4855
|
+
<div id="OFnpZdjkubzjCNr4AsAmw" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4381
4856
|
<pre style="
|
|
4382
4857
|
--line-digits: 2;
|
|
4383
4858
|
--line-number-start: -1;
|
|
@@ -4389,13 +4864,42 @@ blockquote.t-editor__quote > * {
|
|
|
4389
4864
|
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
4390
4865
|
<span class="t-code__line" data-line-number="6"></span>
|
|
4391
4866
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
4392
|
-
<span class="t-code__line" data-line-number="8">
|
|
4393
|
-
<span class="t-code__line" data-line-number="9">
|
|
4394
|
-
<span class="t-code__line" data-line-number="10">
|
|
4395
|
-
<span class="t-code__line" data-line-number="11">
|
|
4396
|
-
<span class="t-code__line" data-line-number="12">
|
|
4397
|
-
<span class="t-code__line" data-line-number="13">
|
|
4398
|
-
<span class="t-code__line" data-line-number="14">
|
|
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>
|
|
4399
4903
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4400
4904
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4401
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>
|
|
@@ -4413,7 +4917,7 @@ blockquote.t-editor__quote > * {
|
|
|
4413
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>
|
|
4414
4918
|
</svg></button>
|
|
4415
4919
|
</h4>
|
|
4416
|
-
<div id="
|
|
4920
|
+
<div id="DQzVGyk2S8oCG6Tyaxsmq" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4417
4921
|
<pre style="
|
|
4418
4922
|
--line-digits: 2;
|
|
4419
4923
|
--line-number-start: -1;
|
|
@@ -4446,7 +4950,7 @@ blockquote.t-editor__quote > * {
|
|
|
4446
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>
|
|
4447
4951
|
</svg></button>
|
|
4448
4952
|
</h4>
|
|
4449
|
-
<div id="
|
|
4953
|
+
<div id="WN1AIfHcGySPeGk6nZ4Lf" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4450
4954
|
<pre style="
|
|
4451
4955
|
--line-digits: 2;
|
|
4452
4956
|
--line-number-start: -1;
|
|
@@ -4477,7 +4981,7 @@ blockquote.t-editor__quote > * {
|
|
|
4477
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>
|
|
4478
4982
|
</svg></button>
|
|
4479
4983
|
</h4>
|
|
4480
|
-
<div id="
|
|
4984
|
+
<div id="t8jF7ixMZPbAkqUcq2Wri" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4481
4985
|
<pre style="
|
|
4482
4986
|
--line-digits: 2;
|
|
4483
4987
|
--line-number-start: -1;
|
|
@@ -4510,7 +5014,7 @@ blockquote.t-editor__quote > * {
|
|
|
4510
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>
|
|
4511
5015
|
</svg></button>
|
|
4512
5016
|
</h4>
|
|
4513
|
-
<div id="
|
|
5017
|
+
<div id="HQatpyDPTNw3VVRCjeYCI" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4514
5018
|
<pre style="
|
|
4515
5019
|
--line-digits: 2;
|
|
4516
5020
|
--line-number-start: -1;
|
|
@@ -4542,7 +5046,7 @@ blockquote.t-editor__quote > * {
|
|
|
4542
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>
|
|
4543
5047
|
</svg></button>
|
|
4544
5048
|
</h4>
|
|
4545
|
-
<div id="
|
|
5049
|
+
<div id="RlMa3XioA7HQY70mXvwbq" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4546
5050
|
<pre style="
|
|
4547
5051
|
--line-digits: 2;
|
|
4548
5052
|
--line-number-start: -1;
|
|
@@ -4567,7 +5071,7 @@ blockquote.t-editor__quote > * {
|
|
|
4567
5071
|
</svg></button>
|
|
4568
5072
|
</div>
|
|
4569
5073
|
<h5 id="" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="5" data-scalar-type="heading">add</h5>
|
|
4570
|
-
<div id="
|
|
5074
|
+
<div id="6iD06LiHpAILCP18z27F2" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4571
5075
|
<pre style="
|
|
4572
5076
|
--line-digits: 2;
|
|
4573
5077
|
--line-number-start: -1;
|
|
@@ -4591,7 +5095,7 @@ blockquote.t-editor__quote > * {
|
|
|
4591
5095
|
</svg></button>
|
|
4592
5096
|
</div>
|
|
4593
5097
|
<h5 id="" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="5" data-scalar-type="heading">remove</h5>
|
|
4594
|
-
<div id="
|
|
5098
|
+
<div id="va4KG29xTzimaBU3Dcw1Y" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4595
5099
|
<pre style="
|
|
4596
5100
|
--line-digits: 2;
|
|
4597
5101
|
--line-number-start: -1;
|
|
@@ -4623,7 +5127,7 @@ blockquote.t-editor__quote > * {
|
|
|
4623
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>
|
|
4624
5128
|
</svg></button>
|
|
4625
5129
|
</h3>
|
|
4626
|
-
<div id="
|
|
5130
|
+
<div id="DJ1xMo9COaG4mrs9SkApL" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4627
5131
|
<pre style="
|
|
4628
5132
|
--line-digits: 2;
|
|
4629
5133
|
--line-number-start: -1;
|
|
@@ -4674,7 +5178,7 @@ blockquote.t-editor__quote > * {
|
|
|
4674
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>
|
|
4675
5179
|
</svg></button>
|
|
4676
5180
|
</h4>
|
|
4677
|
-
<div id="
|
|
5181
|
+
<div id="yk6dqyO1j2oJ2n3srsI2Y" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4678
5182
|
<pre style="
|
|
4679
5183
|
--line-digits: 2;
|
|
4680
5184
|
--line-number-start: -1;
|
|
@@ -4709,7 +5213,7 @@ blockquote.t-editor__quote > * {
|
|
|
4709
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>
|
|
4710
5214
|
</svg></button>
|
|
4711
5215
|
</h4>
|
|
4712
|
-
<div id="
|
|
5216
|
+
<div id="7J4fRrNTSPAGPQZxxMmWG" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4713
5217
|
<pre style="
|
|
4714
5218
|
--line-digits: 2;
|
|
4715
5219
|
--line-number-start: -1;
|
|
@@ -4740,7 +5244,7 @@ blockquote.t-editor__quote > * {
|
|
|
4740
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>
|
|
4741
5245
|
</svg></button>
|
|
4742
5246
|
</h4>
|
|
4743
|
-
<div id="
|
|
5247
|
+
<div id="qRnHpLg64ykOmMadVH512" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4744
5248
|
<pre style="
|
|
4745
5249
|
--line-digits: 2;
|
|
4746
5250
|
--line-number-start: -1;
|
|
@@ -4749,12 +5253,12 @@ blockquote.t-editor__quote > * {
|
|
|
4749
5253
|
<span class="t-code__line" data-line-number="2">Merge multiple OpenAPI or AsyncAPI documents into a single unified document</span>
|
|
4750
5254
|
<span class="t-code__line" data-line-number="3"></span>
|
|
4751
5255
|
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
4752
|
-
<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>
|
|
4753
5257
|
<span class="t-code__line" data-line-number="6"></span>
|
|
4754
5258
|
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
4755
|
-
<span class="t-code__line" data-line-number="8"> --output
|
|
4756
|
-
<span class="t-code__line" data-line-number="9"> --prefix-components-with-path-value
|
|
4757
|
-
<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>
|
|
4758
5262
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
4759
5263
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
4760
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>
|
|
@@ -4772,7 +5276,7 @@ blockquote.t-editor__quote > * {
|
|
|
4772
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>
|
|
4773
5277
|
</svg></button>
|
|
4774
5278
|
</h4>
|
|
4775
|
-
<div id="
|
|
5279
|
+
<div id="3WTqsazC4BJt89sXz8LaZ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4776
5280
|
<pre style="
|
|
4777
5281
|
--line-digits: 2;
|
|
4778
5282
|
--line-number-start: -1;
|
|
@@ -4803,7 +5307,7 @@ blockquote.t-editor__quote > * {
|
|
|
4803
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>
|
|
4804
5308
|
</svg></button>
|
|
4805
5309
|
</h4>
|
|
4806
|
-
<div id="
|
|
5310
|
+
<div id="asfS3KQ3RXKmDeHPQuMrI" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4807
5311
|
<pre style="
|
|
4808
5312
|
--line-digits: 2;
|
|
4809
5313
|
--line-number-start: -1;
|
|
@@ -4835,7 +5339,7 @@ blockquote.t-editor__quote > * {
|
|
|
4835
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>
|
|
4836
5340
|
</svg></button>
|
|
4837
5341
|
</h4>
|
|
4838
|
-
<div id="
|
|
5342
|
+
<div id="2ZN4xs0PZJvZ3t9zoqxNQ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4839
5343
|
<pre style="
|
|
4840
5344
|
--line-digits: 2;
|
|
4841
5345
|
--line-number-start: -1;
|
|
@@ -4866,7 +5370,7 @@ blockquote.t-editor__quote > * {
|
|
|
4866
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>
|
|
4867
5371
|
</svg></button>
|
|
4868
5372
|
</h4>
|
|
4869
|
-
<div id="
|
|
5373
|
+
<div id="ewpsXzDCAOYAxSE9DrVAS" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4870
5374
|
<pre style="
|
|
4871
5375
|
--line-digits: 2;
|
|
4872
5376
|
--line-number-start: -1;
|
|
@@ -4899,7 +5403,7 @@ blockquote.t-editor__quote > * {
|
|
|
4899
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>
|
|
4900
5404
|
</svg></button>
|
|
4901
5405
|
</h4>
|
|
4902
|
-
<div id="
|
|
5406
|
+
<div id="CcMRBmW1XZnmSfc3D0moe" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4903
5407
|
<pre style="
|
|
4904
5408
|
--line-digits: 2;
|
|
4905
5409
|
--line-number-start: -1;
|
|
@@ -4933,7 +5437,7 @@ blockquote.t-editor__quote > * {
|
|
|
4933
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>
|
|
4934
5438
|
</svg></button>
|
|
4935
5439
|
</h4>
|
|
4936
|
-
<div id="
|
|
5440
|
+
<div id="8znhgzY74xDDA7UUYArch" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4937
5441
|
<pre style="
|
|
4938
5442
|
--line-digits: 2;
|
|
4939
5443
|
--line-number-start: -1;
|
|
@@ -4964,7 +5468,7 @@ blockquote.t-editor__quote > * {
|
|
|
4964
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>
|
|
4965
5469
|
</svg></button>
|
|
4966
5470
|
</h4>
|
|
4967
|
-
<div id="
|
|
5471
|
+
<div id="oAH4NcHIlBAkfw2Pa0PlS" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4968
5472
|
<pre style="
|
|
4969
5473
|
--line-digits: 2;
|
|
4970
5474
|
--line-number-start: -1;
|
|
@@ -4994,7 +5498,7 @@ blockquote.t-editor__quote > * {
|
|
|
4994
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>
|
|
4995
5499
|
</svg></button>
|
|
4996
5500
|
</h4>
|
|
4997
|
-
<div id="
|
|
5501
|
+
<div id="Z9VyuY28wg3II89spZtxO" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
4998
5502
|
<pre style="
|
|
4999
5503
|
--line-digits: 2;
|
|
5000
5504
|
--line-number-start: -1;
|
|
@@ -5023,7 +5527,7 @@ blockquote.t-editor__quote > * {
|
|
|
5023
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>
|
|
5024
5528
|
</svg></button>
|
|
5025
5529
|
</h4>
|
|
5026
|
-
<div id="
|
|
5530
|
+
<div id="flwpLRoGTGBJmOsOp3Pln" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5027
5531
|
<pre style="
|
|
5028
5532
|
--line-digits: 2;
|
|
5029
5533
|
--line-number-start: -1;
|
|
@@ -5032,11 +5536,20 @@ blockquote.t-editor__quote > * {
|
|
|
5032
5536
|
<span class="t-code__line" data-line-number="2">Lint your OpenAPI or AsyncAPI file using spectral rules</span>
|
|
5033
5537
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5034
5538
|
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
5035
|
-
<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>
|
|
5036
5540
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5037
5541
|
<span class="t-code__line" data-line-number="7">Options:</span>
|
|
5038
|
-
<span class="t-code__line" data-line-number="8"> -r, --rule <file|url>
|
|
5039
|
-
<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>
|
|
5040
5553
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5041
5554
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5042
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>
|
|
@@ -5054,7 +5567,7 @@ blockquote.t-editor__quote > * {
|
|
|
5054
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>
|
|
5055
5568
|
</svg></button>
|
|
5056
5569
|
</h4>
|
|
5057
|
-
<div id="
|
|
5570
|
+
<div id="f8GnURWXzQGd5mAEHVJTM" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5058
5571
|
<pre style="
|
|
5059
5572
|
--line-digits: 2;
|
|
5060
5573
|
--line-number-start: -1;
|
|
@@ -5085,7 +5598,7 @@ blockquote.t-editor__quote > * {
|
|
|
5085
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>
|
|
5086
5599
|
</svg></button>
|
|
5087
5600
|
</h3>
|
|
5088
|
-
<div id="
|
|
5601
|
+
<div id="QwG6sIqq9ROCIOWiAFh0o" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5089
5602
|
<pre style="
|
|
5090
5603
|
--line-digits: 2;
|
|
5091
5604
|
--line-number-start: -1;
|
|
@@ -5097,18 +5610,80 @@ blockquote.t-editor__quote > * {
|
|
|
5097
5610
|
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
5098
5611
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5099
5612
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
5100
|
-
<span class="t-code__line" data-line-number="8">
|
|
5101
|
-
<span class="t-code__line" data-line-number="9">
|
|
5102
|
-
<span class="t-code__line" data-line-number="10">
|
|
5103
|
-
<span class="t-code__line" data-line-number="11">
|
|
5104
|
-
<span class="t-code__line" data-line-number="12">
|
|
5105
|
-
<span class="t-code__line" data-line-number="13">
|
|
5106
|
-
<span class="t-code__line" data-line-number="14">
|
|
5107
|
-
<span class="t-code__line" data-line-number="15">
|
|
5108
|
-
<span class="t-code__line" data-line-number="16">
|
|
5109
|
-
<span class="t-code__line" data-line-number="17">
|
|
5110
|
-
<span class="t-code__line" data-line-number="18">
|
|
5111
|
-
<span class="t-code__line" data-line-number="19">
|
|
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>
|
|
5112
5687
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5113
5688
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5114
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>
|
|
@@ -5126,7 +5701,7 @@ blockquote.t-editor__quote > * {
|
|
|
5126
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>
|
|
5127
5702
|
</svg></button>
|
|
5128
5703
|
</h4>
|
|
5129
|
-
<div id="
|
|
5704
|
+
<div id="7qUDf2WhPUNiwlg1PlM0H" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5130
5705
|
<pre style="
|
|
5131
5706
|
--line-digits: 2;
|
|
5132
5707
|
--line-number-start: -1;
|
|
@@ -5155,7 +5730,7 @@ blockquote.t-editor__quote > * {
|
|
|
5155
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>
|
|
5156
5731
|
</svg></button>
|
|
5157
5732
|
</h4>
|
|
5158
|
-
<div id="
|
|
5733
|
+
<div id="AL8JzAHLpQcztnfGkoAkQ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5159
5734
|
<pre style="
|
|
5160
5735
|
--line-digits: 2;
|
|
5161
5736
|
--line-number-start: -1;
|
|
@@ -5185,7 +5760,7 @@ blockquote.t-editor__quote > * {
|
|
|
5185
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>
|
|
5186
5761
|
</svg></button>
|
|
5187
5762
|
</h4>
|
|
5188
|
-
<div id="
|
|
5763
|
+
<div id="XTkg7kx8myunLp2BHXxH8" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5189
5764
|
<pre style="
|
|
5190
5765
|
--line-digits: 2;
|
|
5191
5766
|
--line-number-start: -1;
|
|
@@ -5214,7 +5789,7 @@ blockquote.t-editor__quote > * {
|
|
|
5214
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>
|
|
5215
5790
|
</svg></button>
|
|
5216
5791
|
</h4>
|
|
5217
|
-
<div id="
|
|
5792
|
+
<div id="hw6zbDKzioJTt9YwyXR9T" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5218
5793
|
<pre style="
|
|
5219
5794
|
--line-digits: 2;
|
|
5220
5795
|
--line-number-start: -1;
|
|
@@ -5223,14 +5798,19 @@ blockquote.t-editor__quote > * {
|
|
|
5223
5798
|
<span class="t-code__line" data-line-number="2">Preview scalar guides</span>
|
|
5224
5799
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5225
5800
|
<span class="t-code__line" data-line-number="4">Arguments:</span>
|
|
5226
|
-
<span class="t-code__line" data-line-number="5"> config Path to the Scalar configuration file (usually
|
|
5227
|
-
<span class="t-code__line" data-line-number="6"
|
|
5228
|
-
<span class="t-code__line" data-line-number="7"
|
|
5229
|
-
<span class="t-code__line" data-line-number="8">
|
|
5230
|
-
<span class="t-code__line" data-line-number="9"> -
|
|
5231
|
-
<span class="t-code__line" data-line-number="10">
|
|
5232
|
-
<span class="t-code__line" data-line-number="11">
|
|
5233
|
-
<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>
|
|
5234
5814
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5235
5815
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5236
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>
|
|
@@ -5248,7 +5828,7 @@ blockquote.t-editor__quote > * {
|
|
|
5248
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>
|
|
5249
5829
|
</svg></button>
|
|
5250
5830
|
</h4>
|
|
5251
|
-
<div id="
|
|
5831
|
+
<div id="6bhYY2xkfQ56alaibtzGN" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5252
5832
|
<pre style="
|
|
5253
5833
|
--line-digits: 2;
|
|
5254
5834
|
--line-number-start: -1;
|
|
@@ -5257,7 +5837,7 @@ blockquote.t-editor__quote > * {
|
|
|
5257
5837
|
<span class="t-code__line" data-line-number="2">Publish new build for a github sync project that is not linked.</span>
|
|
5258
5838
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5259
5839
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5260
|
-
<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>
|
|
5261
5841
|
<span class="t-code__line" data-line-number="6"> -c, --config [config] Your config file of the project</span>
|
|
5262
5842
|
<span class="t-code__line" data-line-number="7"> -p, --preview Publish in preview mode</span>
|
|
5263
5843
|
<span class="t-code__line" data-line-number="8"> -g, --github Publish from your linked remote GitHub repository</span>
|
|
@@ -5279,7 +5859,7 @@ blockquote.t-editor__quote > * {
|
|
|
5279
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>
|
|
5280
5860
|
</svg></button>
|
|
5281
5861
|
</h4>
|
|
5282
|
-
<div id="
|
|
5862
|
+
<div id="DxJll5B0UvyLX6JbvOjRQ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5283
5863
|
<pre style="
|
|
5284
5864
|
--line-digits: 2;
|
|
5285
5865
|
--line-number-start: -1;
|
|
@@ -5288,7 +5868,7 @@ blockquote.t-editor__quote > * {
|
|
|
5288
5868
|
<span class="t-code__line" data-line-number="2">Roll the live deployment back to a previously deployed build.</span>
|
|
5289
5869
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5290
5870
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5291
|
-
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug
|
|
5871
|
+
<span class="t-code__line" data-line-number="5"> -s, --slug [slug] Project slug from scalar project list</span>
|
|
5292
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>
|
|
5293
5873
|
<span class="t-code__line" data-line-number="7"> older deployed build)</span>
|
|
5294
5874
|
<span class="t-code__line" data-line-number="8"> -y, --yes Skip the confirmation prompt</span>
|
|
@@ -5310,7 +5890,7 @@ blockquote.t-editor__quote > * {
|
|
|
5310
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>
|
|
5311
5891
|
</svg></button>
|
|
5312
5892
|
</h4>
|
|
5313
|
-
<div id="
|
|
5893
|
+
<div id="23tJqJaiHjb8SEaUWOZII" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5314
5894
|
<pre style="
|
|
5315
5895
|
--line-digits: 2;
|
|
5316
5896
|
--line-number-start: -1;
|
|
@@ -5333,7 +5913,7 @@ blockquote.t-editor__quote > * {
|
|
|
5333
5913
|
</svg></button>
|
|
5334
5914
|
</div>
|
|
5335
5915
|
<h5 id="" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="5" data-scalar-type="heading">list</h5>
|
|
5336
|
-
<div id="
|
|
5916
|
+
<div id="jysHg9mXCiGL5ONMeZsak" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5337
5917
|
<pre style="
|
|
5338
5918
|
--line-digits: 2;
|
|
5339
5919
|
--line-number-start: -1;
|
|
@@ -5342,7 +5922,7 @@ blockquote.t-editor__quote > * {
|
|
|
5342
5922
|
<span class="t-code__line" data-line-number="2">List the production deployment history for a project.</span>
|
|
5343
5923
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5344
5924
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5345
|
-
<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>
|
|
5346
5926
|
<span class="t-code__line" data-line-number="6"> -h, --help display help for command</span>
|
|
5347
5927
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5348
5928
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
@@ -5361,7 +5941,7 @@ blockquote.t-editor__quote > * {
|
|
|
5361
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>
|
|
5362
5942
|
</svg></button>
|
|
5363
5943
|
</h4>
|
|
5364
|
-
<div id="
|
|
5944
|
+
<div id="Aqb3cF5RxH7gB2h2HrXxr" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5365
5945
|
<pre style="
|
|
5366
5946
|
--line-digits: 2;
|
|
5367
5947
|
--line-number-start: -1;
|
|
@@ -5392,7 +5972,7 @@ blockquote.t-editor__quote > * {
|
|
|
5392
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>
|
|
5393
5973
|
</svg></button>
|
|
5394
5974
|
</h3>
|
|
5395
|
-
<div id="
|
|
5975
|
+
<div id="I9v483HCxLJqDzW3qSydr" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5396
5976
|
<pre style="
|
|
5397
5977
|
--line-digits: 2;
|
|
5398
5978
|
--line-number-start: -1;
|
|
@@ -5431,7 +6011,7 @@ blockquote.t-editor__quote > * {
|
|
|
5431
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>
|
|
5432
6012
|
</svg></button>
|
|
5433
6013
|
</h4>
|
|
5434
|
-
<div id="
|
|
6014
|
+
<div id="q3CumzEA1G5KzY12MjYOe" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5435
6015
|
<pre style="
|
|
5436
6016
|
--line-digits: 2;
|
|
5437
6017
|
--line-number-start: -1;
|
|
@@ -5474,7 +6054,7 @@ blockquote.t-editor__quote > * {
|
|
|
5474
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>
|
|
5475
6055
|
</svg></button>
|
|
5476
6056
|
</h4>
|
|
5477
|
-
<div id="
|
|
6057
|
+
<div id="9ILDopCZjNXsQFysLyJJu" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5478
6058
|
<pre style="
|
|
5479
6059
|
--line-digits: 2;
|
|
5480
6060
|
--line-number-start: -1;
|
|
@@ -5507,7 +6087,7 @@ blockquote.t-editor__quote > * {
|
|
|
5507
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>
|
|
5508
6088
|
</svg></button>
|
|
5509
6089
|
</h4>
|
|
5510
|
-
<div id="
|
|
6090
|
+
<div id="QBnP9Bjgnzh90dcK6l0Zc" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5511
6091
|
<pre style="
|
|
5512
6092
|
--line-digits: 2;
|
|
5513
6093
|
--line-number-start: -1;
|
|
@@ -5529,7 +6109,7 @@ blockquote.t-editor__quote > * {
|
|
|
5529
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>
|
|
5530
6110
|
</svg></button>
|
|
5531
6111
|
</div>
|
|
5532
|
-
<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">
|
|
5533
6113
|
list
|
|
5534
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">
|
|
5535
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>
|
|
@@ -5538,7 +6118,7 @@ blockquote.t-editor__quote > * {
|
|
|
5538
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>
|
|
5539
6119
|
</svg></button>
|
|
5540
6120
|
</h4>
|
|
5541
|
-
<div id="
|
|
6121
|
+
<div id="MQilJ749gZp3D2Wk6UJpJ" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5542
6122
|
<pre style="
|
|
5543
6123
|
--line-digits: 2;
|
|
5544
6124
|
--line-number-start: -1;
|
|
@@ -5548,7 +6128,8 @@ blockquote.t-editor__quote > * {
|
|
|
5548
6128
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5549
6129
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5550
6130
|
<span class="t-code__line" data-line-number="5"> --namespace <namespace> Team namespace</span>
|
|
5551
|
-
<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>
|
|
5552
6133
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5553
6134
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5554
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>
|
|
@@ -5557,7 +6138,7 @@ blockquote.t-editor__quote > * {
|
|
|
5557
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>
|
|
5558
6139
|
</svg></button>
|
|
5559
6140
|
</div>
|
|
5560
|
-
<h4 id="get-
|
|
6141
|
+
<h4 id="get-2" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5561
6142
|
get
|
|
5562
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">
|
|
5563
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>
|
|
@@ -5566,7 +6147,7 @@ blockquote.t-editor__quote > * {
|
|
|
5566
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>
|
|
5567
6148
|
</svg></button>
|
|
5568
6149
|
</h4>
|
|
5569
|
-
<div id="
|
|
6150
|
+
<div id="zZ6suZaXzWH6gmG70kaTY" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5570
6151
|
<pre style="
|
|
5571
6152
|
--line-digits: 2;
|
|
5572
6153
|
--line-number-start: -1;
|
|
@@ -5580,7 +6161,7 @@ blockquote.t-editor__quote > * {
|
|
|
5580
6161
|
<span class="t-code__line" data-line-number="7"></span>
|
|
5581
6162
|
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
5582
6163
|
<span class="t-code__line" data-line-number="9"> --version <version> Document version (defaults to latest)</span>
|
|
5583
|
-
<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>
|
|
5584
6165
|
<span class="t-code__line" data-line-number="11"> -o, --output <file> Output file (defaults to stdout)</span>
|
|
5585
6166
|
<span class="t-code__line" data-line-number="12"> -h, --help display help for command</span>
|
|
5586
6167
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
@@ -5600,7 +6181,7 @@ blockquote.t-editor__quote > * {
|
|
|
5600
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>
|
|
5601
6182
|
</svg></button>
|
|
5602
6183
|
</h3>
|
|
5603
|
-
<div id="
|
|
6184
|
+
<div id="YgeN5IlVU3cNPTxOIYDX2" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5604
6185
|
<pre style="
|
|
5605
6186
|
--line-digits: 2;
|
|
5606
6187
|
--line-number-start: -1;
|
|
@@ -5612,9 +6193,10 @@ blockquote.t-editor__quote > * {
|
|
|
5612
6193
|
<span class="t-code__line" data-line-number="5"> -h, --help display help for command</span>
|
|
5613
6194
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5614
6195
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
5615
|
-
<span class="t-code__line" data-line-number="8"> list
|
|
5616
|
-
<span class="t-code__line" data-line-number="9">
|
|
5617
|
-
<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>
|
|
5618
6200
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5619
6201
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5620
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>
|
|
@@ -5623,7 +6205,7 @@ blockquote.t-editor__quote > * {
|
|
|
5623
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>
|
|
5624
6206
|
</svg></button>
|
|
5625
6207
|
</div>
|
|
5626
|
-
<h4 id="list-
|
|
6208
|
+
<h4 id="list-3" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5627
6209
|
list
|
|
5628
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">
|
|
5629
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>
|
|
@@ -5632,7 +6214,7 @@ blockquote.t-editor__quote > * {
|
|
|
5632
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>
|
|
5633
6215
|
</svg></button>
|
|
5634
6216
|
</h4>
|
|
5635
|
-
<div id="
|
|
6217
|
+
<div id="91W7Dfax9hoqMujKIaXMw" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5636
6218
|
<pre style="
|
|
5637
6219
|
--line-digits: 2;
|
|
5638
6220
|
--line-number-start: -1;
|
|
@@ -5641,7 +6223,36 @@ blockquote.t-editor__quote > * {
|
|
|
5641
6223
|
<span class="t-code__line" data-line-number="2">List all teams current user is part of</span>
|
|
5642
6224
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5643
6225
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5644
|
-
<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>
|
|
5645
6256
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5646
6257
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5647
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>
|
|
@@ -5659,7 +6270,7 @@ blockquote.t-editor__quote > * {
|
|
|
5659
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>
|
|
5660
6271
|
</svg></button>
|
|
5661
6272
|
</h4>
|
|
5662
|
-
<div id="
|
|
6273
|
+
<div id="bwoNpNRDxPo0DNtR02zfI" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5663
6274
|
<pre style="
|
|
5664
6275
|
--line-digits: 2;
|
|
5665
6276
|
--line-number-start: -1;
|
|
@@ -5687,7 +6298,7 @@ blockquote.t-editor__quote > * {
|
|
|
5687
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>
|
|
5688
6299
|
</svg></button>
|
|
5689
6300
|
</h3>
|
|
5690
|
-
<div id="
|
|
6301
|
+
<div id="yDQKlce1C1OPuakcuYLeu" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5691
6302
|
<pre style="
|
|
5692
6303
|
--line-digits: 2;
|
|
5693
6304
|
--line-number-start: -1;
|
|
@@ -5700,12 +6311,13 @@ blockquote.t-editor__quote > * {
|
|
|
5700
6311
|
<span class="t-code__line" data-line-number="6"></span>
|
|
5701
6312
|
<span class="t-code__line" data-line-number="7">Commands:</span>
|
|
5702
6313
|
<span class="t-code__line" data-line-number="8"> list [options] List all SDKs for a team namespace</span>
|
|
5703
|
-
<span class="t-code__line" data-line-number="9">
|
|
5704
|
-
<span class="t-code__line" data-line-number="10">
|
|
5705
|
-
<span class="t-code__line" data-line-number="11">
|
|
5706
|
-
<span class="t-code__line" data-line-number="12">
|
|
5707
|
-
<span class="t-code__line" data-line-number="13">
|
|
5708
|
-
<span class="t-code__line" data-line-number="14">
|
|
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>
|
|
5709
6321
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5710
6322
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5711
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>
|
|
@@ -5714,7 +6326,7 @@ blockquote.t-editor__quote > * {
|
|
|
5714
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>
|
|
5715
6327
|
</svg></button>
|
|
5716
6328
|
</div>
|
|
5717
|
-
<h4 id="list-
|
|
6329
|
+
<h4 id="list-4" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5718
6330
|
list
|
|
5719
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">
|
|
5720
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>
|
|
@@ -5723,7 +6335,7 @@ blockquote.t-editor__quote > * {
|
|
|
5723
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>
|
|
5724
6336
|
</svg></button>
|
|
5725
6337
|
</h4>
|
|
5726
|
-
<div id="
|
|
6338
|
+
<div id="njmil0U05gwXN9xfvZPul" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5727
6339
|
<pre style="
|
|
5728
6340
|
--line-digits: 2;
|
|
5729
6341
|
--line-number-start: -1;
|
|
@@ -5732,8 +6344,39 @@ blockquote.t-editor__quote > * {
|
|
|
5732
6344
|
<span class="t-code__line" data-line-number="2">List all SDKs for a team namespace</span>
|
|
5733
6345
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5734
6346
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5735
|
-
<span class="t-code__line" data-line-number="5"> --
|
|
5736
|
-
<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>
|
|
6350
|
+
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
6351
|
+
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
6353
|
+
</svg>
|
|
6354
|
+
<svg class="lang-success" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
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>
|
|
6356
|
+
</svg></button>
|
|
6357
|
+
</div>
|
|
6358
|
+
<h4 id="get-4" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
6359
|
+
get
|
|
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">
|
|
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>
|
|
6362
|
+
</svg>
|
|
6363
|
+
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
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>
|
|
6365
|
+
</svg></button>
|
|
6366
|
+
</h4>
|
|
6367
|
+
<div id="6gaoWouUrFhQl8426bXXU" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
6368
|
+
<pre style="
|
|
6369
|
+
--line-digits: 2;
|
|
6370
|
+
--line-number-start: -1;
|
|
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>
|
|
6372
|
+
<span class="t-code__line" data-line-number="1"></span>
|
|
6373
|
+
<span class="t-code__line" data-line-number="2">Inspect SDK metadata, API source, versions, and build status</span>
|
|
6374
|
+
<span class="t-code__line" data-line-number="3"></span>
|
|
6375
|
+
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
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>
|
|
6379
|
+
<span class="t-code__line" data-line-number="8"> -h, --help display help for command</span>
|
|
5737
6380
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5738
6381
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5739
6382
|
<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>
|
|
@@ -5751,7 +6394,7 @@ blockquote.t-editor__quote > * {
|
|
|
5751
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>
|
|
5752
6395
|
</svg></button>
|
|
5753
6396
|
</h4>
|
|
5754
|
-
<div id="
|
|
6397
|
+
<div id="cV607F0jk87TBENioYin8" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5755
6398
|
<pre style="
|
|
5756
6399
|
--line-digits: 2;
|
|
5757
6400
|
--line-number-start: -1;
|
|
@@ -5784,7 +6427,7 @@ blockquote.t-editor__quote > * {
|
|
|
5784
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>
|
|
5785
6428
|
</svg></button>
|
|
5786
6429
|
</h4>
|
|
5787
|
-
<div id="
|
|
6430
|
+
<div id="rTPQByHjXmUZSyIrCz4qo" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5788
6431
|
<pre style="
|
|
5789
6432
|
--line-digits: 2;
|
|
5790
6433
|
--line-number-start: -1;
|
|
@@ -5796,7 +6439,7 @@ blockquote.t-editor__quote > * {
|
|
|
5796
6439
|
<span class="t-code__line" data-line-number="5"> -s, --slug <slug> SDK slug</span>
|
|
5797
6440
|
<span class="t-code__line" data-line-number="6"> -n, --namespace <namespace> Team namespace</span>
|
|
5798
6441
|
<span class="t-code__line" data-line-number="7"> --title <title> Title</span>
|
|
5799
|
-
<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>
|
|
5800
6443
|
<span class="t-code__line" data-line-number="9"> -h, --help display help for command</span>
|
|
5801
6444
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5802
6445
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
@@ -5815,7 +6458,7 @@ blockquote.t-editor__quote > * {
|
|
|
5815
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>
|
|
5816
6459
|
</svg></button>
|
|
5817
6460
|
</h4>
|
|
5818
|
-
<div id="
|
|
6461
|
+
<div id="S8BGJdLDDnMysLZmF6W18" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5819
6462
|
<pre style="
|
|
5820
6463
|
--line-digits: 2;
|
|
5821
6464
|
--line-number-start: -1;
|
|
@@ -5844,7 +6487,7 @@ blockquote.t-editor__quote > * {
|
|
|
5844
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>
|
|
5845
6488
|
</svg></button>
|
|
5846
6489
|
</h4>
|
|
5847
|
-
<div id="
|
|
6490
|
+
<div id="TmYNbc4lw9NulEjOvdVVO" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5848
6491
|
<pre style="
|
|
5849
6492
|
--line-digits: 2;
|
|
5850
6493
|
--line-number-start: -1;
|
|
@@ -5873,7 +6516,7 @@ blockquote.t-editor__quote > * {
|
|
|
5873
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>
|
|
5874
6517
|
</svg></button>
|
|
5875
6518
|
</h3>
|
|
5876
|
-
<div id="
|
|
6519
|
+
<div id="WqKKAggZTDZLtpLyrXR6k" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5877
6520
|
<pre style="
|
|
5878
6521
|
--line-digits: 2;
|
|
5879
6522
|
--line-number-start: -1;
|
|
@@ -5910,7 +6553,7 @@ blockquote.t-editor__quote > * {
|
|
|
5910
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>
|
|
5911
6554
|
</svg></button>
|
|
5912
6555
|
</h4>
|
|
5913
|
-
<div id="
|
|
6556
|
+
<div id="BivMshI2Ax9rA9qwk7p5L" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5914
6557
|
<pre style="
|
|
5915
6558
|
--line-digits: 2;
|
|
5916
6559
|
--line-number-start: -1;
|
|
@@ -5939,7 +6582,7 @@ blockquote.t-editor__quote > * {
|
|
|
5939
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>
|
|
5940
6583
|
</svg></button>
|
|
5941
6584
|
</h4>
|
|
5942
|
-
<div id="
|
|
6585
|
+
<div id="F1WgsxEudRVTpHeoiCIGV" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5943
6586
|
<pre style="
|
|
5944
6587
|
--line-digits: 2;
|
|
5945
6588
|
--line-number-start: -1;
|
|
@@ -5952,7 +6595,7 @@ blockquote.t-editor__quote > * {
|
|
|
5952
6595
|
<span class="t-code__line" data-line-number="6"> -n, --namespace <namespace> Team namespace</span>
|
|
5953
6596
|
<span class="t-code__line" data-line-number="7"> --title <title> Title</span>
|
|
5954
6597
|
<span class="t-code__line" data-line-number="8"> --description <description> Description</span>
|
|
5955
|
-
<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>
|
|
5956
6599
|
<span class="t-code__line" data-line-number="10"> -h, --help display help for command</span>
|
|
5957
6600
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5958
6601
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
@@ -5962,7 +6605,7 @@ blockquote.t-editor__quote > * {
|
|
|
5962
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>
|
|
5963
6606
|
</svg></button>
|
|
5964
6607
|
</div>
|
|
5965
|
-
<h4 id="list-
|
|
6608
|
+
<h4 id="list-5" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5966
6609
|
list
|
|
5967
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">
|
|
5968
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>
|
|
@@ -5971,7 +6614,7 @@ blockquote.t-editor__quote > * {
|
|
|
5971
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>
|
|
5972
6615
|
</svg></button>
|
|
5973
6616
|
</h4>
|
|
5974
|
-
<div id="
|
|
6617
|
+
<div id="w2bTuHxcVYIgiCOuNUqXr" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
5975
6618
|
<pre style="
|
|
5976
6619
|
--line-digits: 2;
|
|
5977
6620
|
--line-number-start: -1;
|
|
@@ -5981,7 +6624,8 @@ blockquote.t-editor__quote > * {
|
|
|
5981
6624
|
<span class="t-code__line" data-line-number="3"></span>
|
|
5982
6625
|
<span class="t-code__line" data-line-number="4">Options:</span>
|
|
5983
6626
|
<span class="t-code__line" data-line-number="5"> --namespace <namespace> Team namespace</span>
|
|
5984
|
-
<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>
|
|
5985
6629
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
5986
6630
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
5987
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>
|
|
@@ -5990,7 +6634,7 @@ blockquote.t-editor__quote > * {
|
|
|
5990
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>
|
|
5991
6635
|
</svg></button>
|
|
5992
6636
|
</div>
|
|
5993
|
-
<h4 id="get-
|
|
6637
|
+
<h4 id="get-5" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="4" data-scalar-type="heading">
|
|
5994
6638
|
get
|
|
5995
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">
|
|
5996
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>
|
|
@@ -5999,7 +6643,7 @@ blockquote.t-editor__quote > * {
|
|
|
5999
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>
|
|
6000
6644
|
</svg></button>
|
|
6001
6645
|
</h4>
|
|
6002
|
-
<div id="
|
|
6646
|
+
<div id="gCGYrw94P2BsTRRthKvCF" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
6003
6647
|
<pre style="
|
|
6004
6648
|
--line-digits: 2;
|
|
6005
6649
|
--line-number-start: -1;
|
|
@@ -6013,7 +6657,7 @@ blockquote.t-editor__quote > * {
|
|
|
6013
6657
|
<span class="t-code__line" data-line-number="7"></span>
|
|
6014
6658
|
<span class="t-code__line" data-line-number="8">Options:</span>
|
|
6015
6659
|
<span class="t-code__line" data-line-number="9"> --version <version> Schema version (defaults to latest)</span>
|
|
6016
|
-
<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>
|
|
6017
6661
|
<span class="t-code__line" data-line-number="11"> -o, --output <file> Output file (defaults to stdout)</span>
|
|
6018
6662
|
<span class="t-code__line" data-line-number="12"> -h, --help display help for command</span>
|
|
6019
6663
|
</code></pre><button class="language-button t-editor__language-picker" data-scalar-type="code-block-copy" type="button">plaintext
|
|
@@ -6033,7 +6677,7 @@ blockquote.t-editor__quote > * {
|
|
|
6033
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>
|
|
6034
6678
|
</svg></button>
|
|
6035
6679
|
</h4>
|
|
6036
|
-
<div id="
|
|
6680
|
+
<div id="ZkPnWlecb3PnHlWVWthFW" class="t-editor__code-container" data-lang="plaintext" style="position: relative;">
|
|
6037
6681
|
<pre style="
|
|
6038
6682
|
--line-digits: 2;
|
|
6039
6683
|
--line-number-start: -1;
|
|
@@ -6077,7 +6721,7 @@ blockquote.t-editor__quote > * {
|
|
|
6077
6721
|
</svg></button>
|
|
6078
6722
|
</h2>
|
|
6079
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>
|
|
6080
|
-
<div id="
|
|
6724
|
+
<div id="EApDO86JGGcmW3MUsE6kj" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
6081
6725
|
<pre style="
|
|
6082
6726
|
--line-digits: 2;
|
|
6083
6727
|
--line-number-start: -1;
|
|
@@ -6091,7 +6735,7 @@ blockquote.t-editor__quote > * {
|
|
|
6091
6735
|
</svg></button>
|
|
6092
6736
|
</div>
|
|
6093
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>
|
|
6094
|
-
<div id="
|
|
6738
|
+
<div id="M50JAC4y51BNIjWKVTGlY" class="t-editor__code-container" data-lang="bash" style="position: relative;">
|
|
6095
6739
|
<pre style="
|
|
6096
6740
|
--line-digits: 2;
|
|
6097
6741
|
--line-number-start: -1;
|
|
@@ -6111,6 +6755,68 @@ blockquote.t-editor__quote > * {
|
|
|
6111
6755
|
</svg></button>
|
|
6112
6756
|
</div>
|
|
6113
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>
|
|
6114
6820
|
<h2 id="github-actions" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
6115
6821
|
GitHub Actions
|
|
6116
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">
|
|
@@ -6121,7 +6827,7 @@ blockquote.t-editor__quote > * {
|
|
|
6121
6827
|
</svg></button>
|
|
6122
6828
|
</h2>
|
|
6123
6829
|
<p class="t-editor__paragraph">To validate your OpenAPI file in GitHub Actions, add this workflow:</p>
|
|
6124
|
-
<div id="
|
|
6830
|
+
<div id="nXxsncjamCjwl06aJAWUL" class="t-editor__code-container" data-lang="yml" style="position: relative;">
|
|
6125
6831
|
<pre style="
|
|
6126
6832
|
--line-digits: 2;
|
|
6127
6833
|
--line-number-start: -1;
|
|
@@ -6157,8 +6863,8 @@ blockquote.t-editor__quote > * {
|
|
|
6157
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>
|
|
6158
6864
|
</svg></button>
|
|
6159
6865
|
</div>
|
|
6160
|
-
<h2 id="
|
|
6161
|
-
|
|
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
|
|
6162
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">
|
|
6163
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>
|
|
6164
6870
|
</svg>
|
|
@@ -6166,14 +6872,18 @@ blockquote.t-editor__quote > * {
|
|
|
6166
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>
|
|
6167
6873
|
</svg></button>
|
|
6168
6874
|
</h2>
|
|
6169
|
-
<p class="t-editor__paragraph">
|
|
6170
|
-
<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;">
|
|
6171
6877
|
<pre style="
|
|
6172
6878
|
--line-digits: 2;
|
|
6173
6879
|
--line-number-start: -1;
|
|
6174
|
-
" 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-
|
|
6175
|
-
<span class="t-code__line" data-line-number="1">
|
|
6176
|
-
|
|
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
|
|
6177
6887
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6178
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>
|
|
6179
6889
|
</svg>
|
|
@@ -6181,14 +6891,16 @@ blockquote.t-editor__quote > * {
|
|
|
6181
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>
|
|
6182
6892
|
</svg></button>
|
|
6183
6893
|
</div>
|
|
6184
|
-
<p class="t-editor__paragraph">
|
|
6185
|
-
<
|
|
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;">
|
|
6186
6898
|
<pre style="
|
|
6187
6899
|
--line-digits: 2;
|
|
6188
6900
|
--line-number-start: -1;
|
|
6189
|
-
" 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-
|
|
6190
|
-
<span class="t-code__line" data-line-number="1">scalar --
|
|
6191
|
-
</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
|
|
6192
6904
|
<svg class="lang-copy" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256">
|
|
6193
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>
|
|
6194
6906
|
</svg>
|
|
@@ -6196,36 +6908,56 @@ blockquote.t-editor__quote > * {
|
|
|
6196
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>
|
|
6197
6909
|
</svg></button>
|
|
6198
6910
|
</div>
|
|
6199
|
-
<
|
|
6200
|
-
|
|
6201
|
-
|
|
6202
|
-
|
|
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>
|
|
6203
6925
|
</svg>
|
|
6204
|
-
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256"
|
|
6205
|
-
<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>
|
|
6206
|
-
</svg></button>
|
|
6207
|
-
</h3>
|
|
6208
|
-
<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>
|
|
6209
|
-
<h2 id="community" class="scroll-pad interaction-observer-heading t-editor__heading" data-level="2" data-scalar-type="heading">
|
|
6210
|
-
Community
|
|
6211
|
-
<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">
|
|
6212
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>
|
|
6213
6943
|
</svg>
|
|
6214
|
-
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256"
|
|
6215
|
-
<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>
|
|
6216
6946
|
</svg></button>
|
|
6217
|
-
</
|
|
6218
|
-
<p class="t-editor__paragraph">
|
|
6219
|
-
<
|
|
6220
|
-
|
|
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
|
|
6221
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">
|
|
6222
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>
|
|
6223
6955
|
</svg>
|
|
6224
6956
|
<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 256 256" aria-hidden="true" class="icon">
|
|
6225
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>
|
|
6226
6958
|
</svg></button>
|
|
6227
|
-
</
|
|
6228
|
-
<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>
|
|
6229
6961
|
|
|
6230
6962
|
</div>
|
|
6231
6963
|
</body>
|