@scalar/cli 2.7.1 → 2.8.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 +209 -30
- package/chunks/{action-T5XMJXPO.js → action-354TUG4H.js} +3 -3
- package/chunks/{action-OX2566BE.js → action-43YBNBDR.js} +7 -7
- package/chunks/{action-4NGK5XMD.js → action-6BYGBXRC.js} +9 -9
- package/chunks/{action-HJYZCPUN.js → action-FCAYFPVR.js} +1 -1
- package/chunks/{action-LPVITMWA.js → action-GWXLHL2Z.js} +3 -3
- package/chunks/{action-ATGZOWSH.js → action-HT2DJ34Z.js} +3 -3
- package/chunks/{action-N7BA5I3E.js → action-KTYOCA2V.js} +2 -2
- package/chunks/{action-SCOXTCPR.js → action-LEUD5P2U.js} +8 -8
- package/chunks/{action-E4YSRFGT.js → action-LLH4QPXM.js} +4 -4
- package/chunks/{action-SNPOOW6S.js → action-LXGXKXZZ.js} +4 -4
- package/chunks/{action-CPLH2CQ5.js → action-QQZLPI42.js} +7 -7
- package/chunks/{action-BAQYJ6UE.js → action-UIKH4SZX.js} +7 -7
- package/chunks/{action-BRSSC2SR.js → action-W3C53GPH.js} +3 -3
- package/chunks/{action-LVDU6YOI.js → action-WFDNRA7D.js} +4 -4
- package/chunks/{action-SRBN7N3R.js → action-XIUO64C7.js} +4 -4
- package/chunks/{action-BOZNBCNZ.js → action-Y6NXJQ4H.js} +2 -2
- package/chunks/{action-RBOLLIGX.js → action-Y7OUGD56.js} +4 -4
- package/chunks/{action-QYGOPSTY.js → action-YLF2G4G5.js} +4 -4
- package/chunks/actions-OGIVBQC7.js +158 -0
- package/chunks/{asyncapi-H4FU6GPC.js → asyncapi-QNFKXHEI.js} +2 -2
- package/chunks/{build.action-6V6GXI3X.js → build.action-NM6CAE5F.js} +8 -8
- package/chunks/{chunk-2DSVF5AD.js → chunk-22HYZ7LE.js} +2 -2
- package/chunks/{chunk-LG7IFACX.js → chunk-2OCWX42S.js} +1 -1
- package/chunks/{chunk-4X47MN6Q.js → chunk-5DEU2DVL.js} +2 -2
- package/chunks/{chunk-2PPRO2QB.js → chunk-BPGFSSUH.js} +1 -1
- package/chunks/{chunk-ISXH6Q7I.js → chunk-EXY3ZTV4.js} +12 -3
- package/chunks/{chunk-ZJVYOZFB.js → chunk-GTV2BVXV.js} +1 -1
- package/chunks/{chunk-BIKOD3SG.js → chunk-KKRGBXCE.js} +3 -0
- package/chunks/{chunk-QXQZVEDC.js → chunk-L3UXDCBI.js} +2 -2
- package/chunks/{chunk-BDEPNGTO.js → chunk-PH3WFNXJ.js} +1 -1
- package/chunks/{chunk-CWCETP6H.js → chunk-QVQ4PNVL.js} +1 -1
- package/chunks/{chunk-GPNB7ISG.js → chunk-UXJ753NV.js} +1 -1
- package/chunks/{create.action-P6DLCK4W.js → create.action-FUQ2BVJA.js} +8 -8
- package/chunks/{delete.action-Z3GAA4ZN.js → delete.action-47E66R3I.js} +8 -8
- package/chunks/{delete.action-HJKRRHE2.js → delete.action-BTDFH7WY.js} +8 -8
- package/chunks/{get.action-IT4EHAV4.js → get.action-XC7KC2JO.js} +4 -4
- package/chunks/{list.action-WLIAO5UW.js → list.action-LXKEUYKO.js} +5 -5
- package/chunks/{list.action-2FU5UZNH.js → list.action-OFGLMRE7.js} +8 -8
- package/chunks/{publish.action-T4J4DRXR.js → publish.action-OS27XOX4.js} +9 -9
- package/chunks/{update.action-MY7QPSSU.js → update.action-AEIBLCWD.js} +8 -8
- package/chunks/{update.action-3OVS3HWC.js → update.action-ZMS4CQ3T.js} +8 -8
- package/docs.html +470 -159
- package/index.js +164 -113
- package/package.json +1 -1
- package/skills/scalar-cli/SKILL.md +7 -1
- package/template.md +20 -0
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ description: "Operate the Scalar CLI (`scalar`, or `npx @scalar/cli`) to validat
|
|
|
5
5
|
|
|
6
6
|
# Scalar CLI
|
|
7
7
|
|
|
8
|
-
CLI to work with your OpenAPI files (`@scalar/cli` 2.
|
|
8
|
+
CLI to work with your OpenAPI files (`@scalar/cli` 2.8.0).
|
|
9
9
|
|
|
10
10
|
## Operating notes
|
|
11
11
|
|
|
@@ -31,6 +31,12 @@ Run `scalar context` for the arguments, options, defaults, and choices of each c
|
|
|
31
31
|
- `scalar auth login [options]`: Login to scalar
|
|
32
32
|
- `scalar auth whoami [options]`: Display the current user
|
|
33
33
|
- `scalar auth logout [options]`: Logout from scalar
|
|
34
|
+
- `scalar access-group create [options] <slug>`: Create an access group (Pro or above)
|
|
35
|
+
- `scalar access-group get [options] <slug>`: Get an access group and its allowlists
|
|
36
|
+
- `scalar access-group update [options] <slug>`: Update access group metadata
|
|
37
|
+
- `scalar access-group delete [options] <slug>`: Delete an access group and remove its project assignments
|
|
38
|
+
- `scalar access-group domain add [options] <slug> <domain>`: Add an exact email domain to an access group
|
|
39
|
+
- `scalar access-group domain remove [options] <slug> <domain>`: Remove an exact email domain from an access group
|
|
34
40
|
- `scalar document bundle [options] [file|url]`: Bundle an OpenAPI document by resolving all references and external dependencies
|
|
35
41
|
- `scalar document split [options] [file|url]`: Split OpenAPI or AsyncAPI documents into small chunks
|
|
36
42
|
- `scalar document join [options] <files...>`: Merge multiple OpenAPI or AsyncAPI documents into a single unified document
|
package/template.md
CHANGED
|
@@ -15,6 +15,26 @@ Command-line interface to work with OpenAPI files
|
|
|
15
15
|
- Preview your API reference
|
|
16
16
|
- Bundle multiple OpenAPI files
|
|
17
17
|
|
|
18
|
+
## Access groups
|
|
19
|
+
|
|
20
|
+
Manage access groups and allowed email domains for your current team:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
scalar auth login
|
|
24
|
+
scalar access-group create partners --name Partners --domain example.com
|
|
25
|
+
scalar access-group get partners --json
|
|
26
|
+
scalar access-group update partners --name "Partner access"
|
|
27
|
+
scalar access-group domain add partners partner.com
|
|
28
|
+
scalar access-group domain remove partners partner.com
|
|
29
|
+
scalar access-group delete partners --yes
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Creation requires Pro or above, and mutations require docs edit permission. Commands use your existing login and selected team; CI can authenticate with `scalar auth login --token <personal-token>`. Group arguments are slugs, not UIDs. Rename with `update <slug> --new-slug <new-slug>`, then use the new slug in later commands.
|
|
33
|
+
|
|
34
|
+
Use `--json` for machine-readable output: create/get print the group object, while successful updates, deletions and domain mutations print `null`. Errors go to stderr and exit nonzero. Deletion prompts in a terminal; pass `--yes` for unattended deletion or when using `--json`.
|
|
35
|
+
|
|
36
|
+
Domains are exact email domains, with no wildcards or implicit subdomain matching. Matching preserves existing case-sensitive behavior. Groups support up to 1,000 domains; domain add/remove leaves other domains and individual email entries intact. Creating a group does not assign it to resources or change their privacy settings. Deleting a group removes its project assignments.
|
|
37
|
+
|
|
18
38
|
## Documentation
|
|
19
39
|
|
|
20
40
|
This is an overview + API Reference of the CLI, if you want guides on how to use the CLI in more detail go to our [Docs](https://guides.scalar.com/scalar/scalar-cli)
|