@scalar/cli 2.10.0 → 2.12.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.
Files changed (99) hide show
  1. package/README.md +84 -1289
  2. package/chunks/action-2OPUQFUY.js +164 -0
  3. package/chunks/{action-4GZI2M5B.js → action-36LZ6XXE.js} +19 -17
  4. package/chunks/{action-KDUFU7TZ.js → action-3XMTJJRT.js} +19 -16
  5. package/chunks/{action-R4PGILN4.js → action-6CLEENBI.js} +47 -36
  6. package/chunks/{action-ZFI77WA5.js → action-7HXYZPOT.js} +10 -10
  7. package/chunks/{action-X7BA7PQQ.js → action-AC5ENU6Z.js} +20 -18
  8. package/chunks/{action-PPTFYZWD.js → action-ADGLTNFC.js} +28 -22
  9. package/chunks/{action-7XOHYWYM.js → action-AOKHLTZ6.js} +25 -21
  10. package/chunks/{action-XOADBXSX.js → action-AVSJ3AJY.js} +17 -16
  11. package/chunks/{action-GFLRD7LO.js → action-D3IVCY24.js} +8 -8
  12. package/chunks/action-EBZJS367.js +130 -0
  13. package/chunks/{action-ZKA3RR3S.js → action-EZXHSAJ2.js} +18 -17
  14. package/chunks/{action-5LF4XYHX.js → action-FDTVHVHF.js} +12 -12
  15. package/chunks/{action-JEYDBB3P.js → action-FUO5F7NV.js} +15 -15
  16. package/chunks/{action-DKDRAIKV.js → action-HA3CMV3P.js} +13 -15
  17. package/chunks/{action-YSVTZVKV.js → action-IG3BK2LF.js} +37 -26
  18. package/chunks/{action-H3RTILLM.js → action-IIQMZVRJ.js} +1 -1
  19. package/chunks/{action-DTEO4YNX.js → action-JT6C472I.js} +13 -11
  20. package/chunks/{action-UUL6SWV4.js → action-KDT6H6ML.js} +12 -14
  21. package/chunks/{action-PAM2EZ22.js → action-KJDIJQ3A.js} +8 -7
  22. package/chunks/{action-HT42NUUX.js → action-NF5E7JKA.js} +40 -38
  23. package/chunks/{action-EAUTQ77U.js → action-NIZBME45.js} +26 -24
  24. package/chunks/{action-CB55NWAU.js → action-O757TFA2.js} +9 -9
  25. package/chunks/{action-XLE37MZL.js → action-ONR7QSN7.js} +23 -22
  26. package/chunks/{action-5RL4NWUZ.js → action-QM2BMMHG.js} +33 -30
  27. package/chunks/{action-GWYYTUTM.js → action-QVTAZCKY.js} +5 -5
  28. package/chunks/action-SLB52XRG.js +65 -0
  29. package/chunks/{action-CABLS46Q.js → action-UTFRCKGE.js} +11 -11
  30. package/chunks/{action-4W5GUGEG.js → action-VESBFIP3.js} +20 -19
  31. package/chunks/{action-657A4K2D.js → action-VGFAIFYE.js} +26 -23
  32. package/chunks/action-WCU5O2VT.js +100 -0
  33. package/chunks/{action-TOBU74JH.js → action-XS5EESHW.js} +51 -27
  34. package/chunks/action-XVNRZ5VX.js +38 -0
  35. package/chunks/action-Y7EBKCUU.js +16 -0
  36. package/chunks/{action-5N3P43MD.js → action-YWQ2OKS3.js} +16 -15
  37. package/chunks/{actions-3SAMH7A5.js → actions-6QG7LH7P.js} +23 -20
  38. package/chunks/{agent-2ESZI7NO.js → agent-ONXROEAE.js} +44 -9
  39. package/chunks/{asyncapi-4HGVM3PR.js → asyncapi-7IFXAIE3.js} +13 -12
  40. package/chunks/{build.action-VBGFGACM.js → build.action-FI4OWY3T.js} +28 -26
  41. package/chunks/{chunk-ZGNDXPLU.js → chunk-26VIHQGL.js} +3 -3
  42. package/chunks/{chunk-JXGF5EHC.js → chunk-3HCEUGOE.js} +42 -13
  43. package/chunks/{chunk-G4HRW2FZ.js → chunk-5TNKTLQP.js} +370 -254
  44. package/chunks/{chunk-XAGJJNQW.js → chunk-BB6WWG25.js} +10 -10
  45. package/chunks/{chunk-K2HIB5BA.js → chunk-BCFUMXMC.js} +3 -3
  46. package/chunks/{action-F2ZJNURT.js → chunk-EBNFCIKS.js} +7 -10
  47. package/chunks/{chunk-MC4EMNOR.js → chunk-EJSGWV2K.js} +7 -6
  48. package/chunks/{chunk-GYRQPDTK.js → chunk-FJCOYEKT.js} +139 -3
  49. package/chunks/{chunk-ZKJPLWRJ.js → chunk-HU47OMI4.js} +4 -4
  50. package/chunks/{chunk-VVRUSQCY.js → chunk-I57ID5K7.js} +13 -0
  51. package/chunks/{chunk-43WALAW3.js → chunk-JLNHOA5Z.js} +64 -115
  52. package/chunks/{chunk-5SMP756H.js → chunk-LCSU43NJ.js} +2 -2
  53. package/chunks/{chunk-KHF2QXBG.js → chunk-N645RGAB.js} +1853 -683
  54. package/chunks/{chunk-3ZJYGGAA.js → chunk-ORCUZITN.js} +1 -1
  55. package/chunks/{chunk-H467HDVV.js → chunk-PERC34BV.js} +1 -1
  56. package/chunks/chunk-Q26DFKTY.js +37 -0
  57. package/chunks/{chunk-MMWSCTDB.js → chunk-QJQTSRU4.js} +19 -19
  58. package/chunks/{chunk-WDIWLXLV.js → chunk-RLBS4HJT.js} +3 -3
  59. package/chunks/{chunk-ATNTXKMS.js → chunk-RNZVZMYC.js} +198 -42
  60. package/chunks/{chunk-IPZP3VRA.js → chunk-RYWXF3LO.js} +12 -21
  61. package/chunks/{chunk-CWVYOXXM.js → chunk-SNOAL2C5.js} +11 -7
  62. package/chunks/{chunk-UDBSV3CK.js → chunk-T3R66THO.js} +6085 -4167
  63. package/chunks/{chunk-VYFGRLVQ.js → chunk-U73OW57G.js} +1 -1
  64. package/chunks/chunk-U764PQUA.js +1034 -0
  65. package/chunks/{chunk-KZNRQVMY.js → chunk-UAFCSWQ6.js} +1 -1
  66. package/chunks/{chunk-WB6PWTMU.js → chunk-UBLFIMUA.js} +1 -1
  67. package/chunks/{chunk-WIEXQUTD.js → chunk-UODTHS76.js} +1 -1
  68. package/chunks/chunk-V3MYP5SQ.js +247 -0
  69. package/chunks/{chunk-36LXIJIZ.js → chunk-V6LUKXBV.js} +1 -16
  70. package/chunks/{chunk-6M7TL2G2.js → chunk-VRZSDUZK.js} +45 -5
  71. package/chunks/{chunk-GLWTVLKM.js → chunk-VUNOOPEG.js} +9 -2
  72. package/chunks/chunk-VUXPDHTQ.js +22 -0
  73. package/chunks/{chunk-DHZW7Q7U.js → chunk-VVQOFG76.js} +2 -4
  74. package/chunks/chunk-XP5UM7SF.js +21 -0
  75. package/chunks/{chunk-ZYBLQ5CT.js → chunk-Y6C3H27E.js} +9 -4
  76. package/chunks/{chunk-35Z7VTJT.js → chunk-YTFFBGNQ.js} +52 -38
  77. package/chunks/{chunk-BIMLCGKS.js → chunk-ZNLMQKDU.js} +1 -1
  78. package/chunks/{create.action-DBNIS665.js → create.action-PPMZEMZL.js} +34 -32
  79. package/chunks/{delete.action-GBOZC45K.js → delete.action-GDOHATRZ.js} +30 -28
  80. package/chunks/{delete.action-K7BLK7DK.js → delete.action-VAHKEHEU.js} +29 -27
  81. package/chunks/{get.action-QHKMYZBK.js → get.action-UXFTGO7W.js} +24 -20
  82. package/chunks/{get.action-N3JOY3OU.js → get.action-XON3EZDT.js} +16 -15
  83. package/chunks/{list.action-TJCS6UEY.js → list.action-24F5WDGR.js} +37 -26
  84. package/chunks/{list.action-6SSO3JVN.js → list.action-OQEAEJ5U.js} +39 -29
  85. package/chunks/{publish.action-T24VHRMR.js → publish.action-G7FPDRBZ.js} +45 -43
  86. package/chunks/{scripts-VIBLGKYG.js → scripts-6CI6U32J.js} +1 -1
  87. package/chunks/{update.action-VOE6PH5F.js → update.action-IFIFXZWA.js} +29 -27
  88. package/chunks/{update.action-OGYNBXRU.js → update.action-MJDHVVR3.js} +30 -28
  89. package/index.js +290 -284
  90. package/package.json +2 -2
  91. package/skills/scalar-cli/SKILL.md +49 -49
  92. package/template.md +68 -252
  93. package/chunks/action-FBRY5JKU.js +0 -37
  94. package/chunks/action-LYCNT3KA.js +0 -73
  95. package/chunks/action-OJ2NK25F.js +0 -121
  96. package/chunks/action-U2L5DCFG.js +0 -91
  97. package/chunks/chunk-MNNGUUKJ.js +0 -405
  98. package/chunks/chunk-ZGVZU6L2.js +0 -422
  99. package/docs.html +0 -6977
@@ -1,50 +1,52 @@
1
1
  import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
2
  import {
3
3
  getPublishDeploymentUrl
4
- } from "./chunk-KZNRQVMY.js";
4
+ } from "./chunk-UAFCSWQ6.js";
5
5
  import {
6
6
  getProjectDeployments
7
- } from "./chunk-ZGNDXPLU.js";
7
+ } from "./chunk-26VIHQGL.js";
8
8
  import {
9
9
  resolveProject
10
10
  } from "./chunk-TSURUX4A.js";
11
11
  import {
12
12
  formatAbsoluteTime
13
13
  } from "./chunk-AEFPCC4U.js";
14
- import "./chunk-MMWSCTDB.js";
15
- import "./chunk-JXGF5EHC.js";
16
- import "./chunk-WDIWLXLV.js";
14
+ import "./chunk-QJQTSRU4.js";
15
+ import "./chunk-3HCEUGOE.js";
16
+ import "./chunk-RLBS4HJT.js";
17
17
  import {
18
18
  apiService
19
- } from "./chunk-ATNTXKMS.js";
20
- import "./chunk-43WALAW3.js";
21
- import "./chunk-ZYBLQ5CT.js";
22
- import "./chunk-KHF2QXBG.js";
23
- import "./chunk-IPZP3VRA.js";
19
+ } from "./chunk-RNZVZMYC.js";
20
+ import "./chunk-N645RGAB.js";
21
+ import "./chunk-JLNHOA5Z.js";
22
+ import "./chunk-Y6C3H27E.js";
24
23
  import "./chunk-5ENKYZA4.js";
25
- import "./chunk-G4HRW2FZ.js";
26
- import "./chunk-36LXIJIZ.js";
24
+ import "./chunk-RYWXF3LO.js";
25
+ import "./chunk-5TNKTLQP.js";
26
+ import "./chunk-V3MYP5SQ.js";
27
+ import "./chunk-V6LUKXBV.js";
28
+ import "./chunk-VUXPDHTQ.js";
27
29
  import {
28
30
  getAuthData
29
- } from "./chunk-35Z7VTJT.js";
30
- import "./chunk-WB6PWTMU.js";
31
- import "./chunk-DHZW7Q7U.js";
32
- import "./chunk-GYRQPDTK.js";
33
- import "./chunk-6M7TL2G2.js";
31
+ } from "./chunk-YTFFBGNQ.js";
32
+ import "./chunk-UBLFIMUA.js";
33
+ import "./chunk-VVQOFG76.js";
34
+ import "./chunk-FJCOYEKT.js";
35
+ import "./chunk-VRZSDUZK.js";
34
36
  import {
35
37
  requireInteractive
36
38
  } from "./chunk-EGOXR5FB.js";
37
- import "./chunk-GLWTVLKM.js";
38
39
  import "./chunk-4ORL4MST.js";
39
- import "./chunk-MNNGUUKJ.js";
40
+ import "./chunk-VUNOOPEG.js";
40
41
  import {
41
42
  output
42
43
  } from "./chunk-T5HJUAWB.js";
43
- import "./chunk-ZGVZU6L2.js";
44
+ import "./chunk-U764PQUA.js";
45
+ import "./chunk-Q26DFKTY.js";
44
46
  import {
45
47
  external_exports,
46
48
  slugSchema
47
- } from "./chunk-VVRUSQCY.js";
49
+ } from "./chunk-I57ID5K7.js";
48
50
  import "./chunk-3MZYUBJ6.js";
49
51
 
50
52
  // src/domains/project/rollback/action.ts
@@ -104,7 +106,7 @@ var rollbackArgsSchema = external_exports.object({
104
106
  async function rollbackAction(args) {
105
107
  const argsParseResult = rollbackArgsSchema.safeParse(args);
106
108
  if (argsParseResult.error) {
107
- return output.error().title("Invalid Arguments").message(argsParseResult.error.issues[0].message).exit("error");
109
+ return output.error().title("Invalid arguments").message(argsParseResult.error.issues[0].message).exit("error");
108
110
  }
109
111
  const { slug, to, yes } = argsParseResult.data;
110
112
  if (!slug) {
@@ -153,7 +155,7 @@ async function rollbackAction(args) {
153
155
  initialValue: false
154
156
  });
155
157
  if (shouldContinue !== true) {
156
- output.info().title("Rollback cancelled.").print();
158
+ output.info().title("Operation cancelled.").print();
157
159
  return;
158
160
  }
159
161
  }
@@ -191,7 +193,7 @@ function renderRollbackError(error, slug) {
191
193
  ).exit("error");
192
194
  case "target-not-found":
193
195
  return output.error().title("Build not found").message(
194
- `No deployed build with id "${error.uid}" was found. Run "scalar project deployments list --slug ${slug}" to see available builds.`
196
+ `No deployed build with ID "${error.uid}" was found. Run "scalar project deployments list --slug ${slug}" to see available builds.`
195
197
  ).exit("error");
196
198
  case "target-not-deployable":
197
199
  return output.error().title("Build cannot be made live").message(
@@ -1,18 +1,18 @@
1
1
  import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
2
  import {
3
3
  getFileOrUrl
4
- } from "./chunk-CWVYOXXM.js";
5
- import "./chunk-H467HDVV.js";
6
- import "./chunk-GLWTVLKM.js";
4
+ } from "./chunk-SNOAL2C5.js";
5
+ import "./chunk-PERC34BV.js";
7
6
  import {
8
7
  isYamlFileName
9
8
  } from "./chunk-4ORL4MST.js";
10
- import "./chunk-MNNGUUKJ.js";
9
+ import "./chunk-VUNOOPEG.js";
11
10
  import {
12
11
  output
13
12
  } from "./chunk-T5HJUAWB.js";
14
- import "./chunk-ZGVZU6L2.js";
15
- import "./chunk-VVRUSQCY.js";
13
+ import "./chunk-U764PQUA.js";
14
+ import "./chunk-Q26DFKTY.js";
15
+ import "./chunk-I57ID5K7.js";
16
16
  import "./chunk-3MZYUBJ6.js";
17
17
 
18
18
  // src/domains/document/postman/action.ts
@@ -26,7 +26,7 @@ async function convertAction(inputArgument, {
26
26
  }) {
27
27
  const startTime = performance.now();
28
28
  if (!inputArgument) {
29
- return output.error().title("Invalid argument").message("Please provide a Postman collection file path or URL").exit("error");
29
+ return output.error().title("Invalid argument").message("Provide a Postman collection file path or URL.").exit("error");
30
30
  }
31
31
  const collection = await getFileOrUrl(inputArgument);
32
32
  let specification;
@@ -42,8 +42,8 @@ async function convertAction(inputArgument, {
42
42
  fs.writeFileSync(outputPath, openApiDocument, "utf8");
43
43
  const endTime = performance.now();
44
44
  output.info().line(
45
- `${as.green("OpenAPI document generated")} ${as.grey(
46
- `in ${as.white(`${as.bold(`${Math.round(endTime - startTime)}`)} ms`)}`
45
+ `${as.green("OpenAPI description generated")} ${as.grey(
46
+ `(${as.white(`${as.bold(`${Math.round(endTime - startTime)}`)} ms`)})`
47
47
  )}`
48
48
  ).line(`Written to ${as.cyan(outputPath)}`).print();
49
49
  return;
@@ -1,28 +1,29 @@
1
1
  import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
2
  import {
3
3
  apiService
4
- } from "./chunk-ATNTXKMS.js";
5
- import "./chunk-43WALAW3.js";
6
- import "./chunk-ZYBLQ5CT.js";
7
- import "./chunk-KHF2QXBG.js";
8
- import "./chunk-IPZP3VRA.js";
4
+ } from "./chunk-RNZVZMYC.js";
5
+ import "./chunk-N645RGAB.js";
6
+ import "./chunk-JLNHOA5Z.js";
7
+ import "./chunk-Y6C3H27E.js";
9
8
  import "./chunk-5ENKYZA4.js";
10
- import "./chunk-G4HRW2FZ.js";
11
- import "./chunk-35Z7VTJT.js";
12
- import "./chunk-WB6PWTMU.js";
13
- import "./chunk-DHZW7Q7U.js";
14
- import "./chunk-GYRQPDTK.js";
15
- import "./chunk-6M7TL2G2.js";
9
+ import "./chunk-RYWXF3LO.js";
10
+ import "./chunk-5TNKTLQP.js";
11
+ import "./chunk-V3MYP5SQ.js";
12
+ import "./chunk-YTFFBGNQ.js";
13
+ import "./chunk-UBLFIMUA.js";
14
+ import "./chunk-VVQOFG76.js";
15
+ import "./chunk-FJCOYEKT.js";
16
+ import "./chunk-VRZSDUZK.js";
16
17
  import {
17
18
  requireInteractive
18
19
  } from "./chunk-EGOXR5FB.js";
19
- import "./chunk-GLWTVLKM.js";
20
- import "./chunk-MNNGUUKJ.js";
20
+ import "./chunk-VUNOOPEG.js";
21
21
  import {
22
22
  output
23
23
  } from "./chunk-T5HJUAWB.js";
24
- import "./chunk-ZGVZU6L2.js";
25
- import "./chunk-VVRUSQCY.js";
24
+ import "./chunk-U764PQUA.js";
25
+ import "./chunk-Q26DFKTY.js";
26
+ import "./chunk-I57ID5K7.js";
26
27
  import "./chunk-3MZYUBJ6.js";
27
28
 
28
29
  // src/domains/project/create/action.ts
@@ -40,9 +41,9 @@ async function createAction({
40
41
  "Pass --name <name> to create a project non-interactively."
41
42
  );
42
43
  const response2 = await text({
43
- message: "What is the name of your project?",
44
+ message: "Enter the project name",
44
45
  validate(value) {
45
- if (!value.trim()) return "Please provide a project name.";
46
+ if (!value.trim()) return "Provide a project name.";
46
47
  }
47
48
  });
48
49
  if (isCancel(response2)) return;
@@ -50,13 +51,13 @@ async function createAction({
50
51
  }
51
52
  if (!slugValue && process.stdin.isTTY) {
52
53
  const response2 = await text({
53
- message: "What is the slug of your project? (Optional)",
54
+ message: "Enter the project slug (optional)",
54
55
  defaultValue: ""
55
56
  });
56
57
  if (isCancel(response2)) return;
57
58
  slugValue = response2 || void 0;
58
59
  }
59
- const logger = output.info().loader("Creating the project");
60
+ const logger = output.info().loader("Creating project\u2026");
60
61
  const response = await apiClient.docsProject.createProject({
61
62
  provider: "forgejo",
62
63
  blank: true,
@@ -64,11 +65,11 @@ async function createAction({
64
65
  slug: slugValue
65
66
  });
66
67
  if (response.error) {
67
- return output.error().title("Something went wrong").message(response.message).exit("error");
68
+ return output.error().title("Could not create the project").message(response.message).exit("error");
68
69
  }
69
- logger.update("loader", 0, { content: "Project created successfully!" });
70
+ logger.update("loader", 0, { content: "Project created." });
70
71
  logger.message(
71
- `Project uid: ${as.cyan(response.data.uid)}
72
+ `Project ID: ${as.cyan(response.data.uid)}
72
73
  Project slug: ${as.cyan(response.data.slug)}`
73
74
  ).exit("success");
74
75
  }
@@ -6,37 +6,38 @@ import {
6
6
  findConfig,
7
7
  getCurrentFolderName,
8
8
  scalarConfigSchema
9
- } from "./chunk-UDBSV3CK.js";
9
+ } from "./chunk-T3R66THO.js";
10
10
  import {
11
11
  apiService
12
- } from "./chunk-ATNTXKMS.js";
13
- import "./chunk-43WALAW3.js";
14
- import "./chunk-ZYBLQ5CT.js";
15
- import "./chunk-KHF2QXBG.js";
16
- import "./chunk-IPZP3VRA.js";
12
+ } from "./chunk-RNZVZMYC.js";
13
+ import "./chunk-N645RGAB.js";
14
+ import "./chunk-JLNHOA5Z.js";
15
+ import "./chunk-Y6C3H27E.js";
17
16
  import "./chunk-5ENKYZA4.js";
18
- import "./chunk-G4HRW2FZ.js";
17
+ import "./chunk-RYWXF3LO.js";
18
+ import "./chunk-5TNKTLQP.js";
19
+ import "./chunk-V3MYP5SQ.js";
19
20
  import {
20
21
  getMetadata
21
- } from "./chunk-35Z7VTJT.js";
22
+ } from "./chunk-YTFFBGNQ.js";
22
23
  import {
23
24
  config
24
- } from "./chunk-WB6PWTMU.js";
25
- import "./chunk-DHZW7Q7U.js";
26
- import "./chunk-GYRQPDTK.js";
27
- import "./chunk-6M7TL2G2.js";
25
+ } from "./chunk-UBLFIMUA.js";
26
+ import "./chunk-VVQOFG76.js";
27
+ import "./chunk-FJCOYEKT.js";
28
+ import "./chunk-VRZSDUZK.js";
28
29
  import {
29
30
  requireInteractive
30
31
  } from "./chunk-EGOXR5FB.js";
31
- import "./chunk-GLWTVLKM.js";
32
- import "./chunk-MNNGUUKJ.js";
32
+ import "./chunk-VUNOOPEG.js";
33
33
  import {
34
34
  output
35
35
  } from "./chunk-T5HJUAWB.js";
36
- import "./chunk-ZGVZU6L2.js";
36
+ import "./chunk-U764PQUA.js";
37
+ import "./chunk-Q26DFKTY.js";
37
38
  import {
38
39
  slugify
39
- } from "./chunk-VVRUSQCY.js";
40
+ } from "./chunk-I57ID5K7.js";
40
41
  import "./chunk-3MZYUBJ6.js";
41
42
 
42
43
  // src/domains/project/init/action.ts
@@ -2003,21 +2004,21 @@ var __default = {
2003
2004
  // src/domains/project/init/quickstart.ts
2004
2005
  var quickstartMarkdown = `# Quickstart
2005
2006
 
2006
- ## 1. Preview Your Docs
2007
+ ## 1. Preview your documentation
2007
2008
 
2008
- Run a local development server to see your changes in real-time:
2009
+ Run a local development server to see your changes as you edit:
2009
2010
 
2010
2011
  \`\`\`bash
2011
2012
  npx @scalar/cli project preview
2012
2013
  \`\`\`
2013
2014
 
2014
- This starts a live preview at \`http://localhost:7970\` where every edit you make is instantly visible.
2015
+ The preview uses port 7970 by default and selects another port if it is unavailable. Open the URL printed by the command to see your changes.
2015
2016
 
2016
- ## 2. Customize Everything
2017
+ ## 2. Customize your documentation
2017
2018
 
2018
- Make it yours with themes, custom CSS, and MDX. Configure your documentation structure, navigation, and styling through \`scalar.config.json\`.
2019
+ Make it yours with themes, custom CSS, and Markdown. Configure your documentation structure, navigation, and styling through \`scalar.config.json\`.
2019
2020
 
2020
- ## 3. Publish Your Docs
2021
+ ## 3. Publish your documentation
2021
2022
 
2022
2023
  First, authenticate with your Scalar account:
2023
2024
 
@@ -2028,12 +2029,12 @@ npx @scalar/cli auth login
2028
2029
  Then publish your documentation:
2029
2030
 
2030
2031
  \`\`\`bash
2031
- npx @scalar/cli project publish --slug [dashboard-project-slug]
2032
+ npx @scalar/cli project publish --slug <project-slug>
2032
2033
  \`\`\`
2033
2034
 
2034
- Your site will be available at \`<your-slug>.apidocumentation.com\`.
2035
+ The command prints the deployment URL when publishing completes.
2035
2036
 
2036
- ## Stuck?
2037
+ ## Get help
2037
2038
 
2038
2039
  Check whether your \`scalar.config.json\` is valid:
2039
2040
 
@@ -2063,12 +2064,12 @@ async function initAction({
2063
2064
  }) {
2064
2065
  const configFile = findConfig() || CONFIG_FILE_DEFAULT;
2065
2066
  const nextSteps = () => {
2066
- output.info().line("What to do next:").line(
2067
+ output.info().line("Next steps:").line(
2067
2068
  ` ${as.cyan("scalar project preview")} to preview your project locally`
2068
2069
  ).line(
2069
2070
  ` ${as.cyan("scalar project check-config")} to validate your scalar.config.json file`
2070
2071
  ).line(
2071
- ` ${as.cyan("scalar project publish --slug")} ${as.gray("[dashboard-project-slug]")} to publish your project`
2072
+ ` ${as.cyan("scalar project publish --slug")} ${as.gray("<project-slug>")} to publish your project`
2072
2073
  ).line(
2073
2074
  as.white(
2074
2075
  `Run ${as.magenta("scalar --help")} to see all available commands.`
@@ -2093,7 +2094,7 @@ async function initAction({
2093
2094
  );
2094
2095
  }
2095
2096
  const shouldOverwriteExisting = force ?? await confirm({
2096
- message: "Do you want to override the file?",
2097
+ message: "Overwrite the existing configuration file?",
2097
2098
  initialValue: false
2098
2099
  });
2099
2100
  if (isCancel(shouldOverwriteExisting)) {
@@ -2147,7 +2148,7 @@ async function initAction({
2147
2148
  }
2148
2149
  while (true) {
2149
2150
  const response = suppliedSubdomain ?? await text({
2150
- message: "What is the name of your project?",
2151
+ message: "Enter the project name",
2151
2152
  defaultValue: folderName,
2152
2153
  placeholder: folderName
2153
2154
  });
@@ -2168,7 +2169,9 @@ async function initAction({
2168
2169
  if (apiClient) {
2169
2170
  const result = await apiClient.publish.getDomainAvailability(`${slug}.${config.publishTld}`).catch(() => null);
2170
2171
  if (!result || result.error) {
2171
- return output.error().message("Could not check subdomain availability. Please try again.").exit("error");
2172
+ return output.error().message(
2173
+ "Could not check subdomain availability. Check your connection and authentication before running the command again."
2174
+ ).exit("error");
2172
2175
  }
2173
2176
  if (!result.data.available) {
2174
2177
  const message = `Subdomain "${slug}" is already taken. Choose another name.`;
@@ -4,11 +4,11 @@ import {
4
4
  downloadIsolate,
5
5
  isDiskWriteError,
6
6
  updateIsolate
7
- } from "./chunk-ZKJPLWRJ.js";
8
- import "./chunk-3ZJYGGAA.js";
9
- import "./chunk-VYFGRLVQ.js";
10
- import "./chunk-WB6PWTMU.js";
11
- import "./chunk-DHZW7Q7U.js";
7
+ } from "./chunk-HU47OMI4.js";
8
+ import "./chunk-ORCUZITN.js";
9
+ import "./chunk-U73OW57G.js";
10
+ import "./chunk-UBLFIMUA.js";
11
+ import "./chunk-VVQOFG76.js";
12
12
  import "./chunk-T5HJUAWB.js";
13
13
  import "./chunk-3MZYUBJ6.js";
14
14
  export {
@@ -0,0 +1,65 @@
1
+ import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
+ import {
3
+ BaseCollections
4
+ } from "./chunk-3HCEUGOE.js";
5
+ import {
6
+ getDatabaseClient
7
+ } from "./chunk-RLBS4HJT.js";
8
+ import "./chunk-JLNHOA5Z.js";
9
+ import "./chunk-Y6C3H27E.js";
10
+ import "./chunk-5ENKYZA4.js";
11
+ import "./chunk-RYWXF3LO.js";
12
+ import "./chunk-V3MYP5SQ.js";
13
+ import "./chunk-V6LUKXBV.js";
14
+ import "./chunk-VUXPDHTQ.js";
15
+ import {
16
+ getAuthData
17
+ } from "./chunk-YTFFBGNQ.js";
18
+ import "./chunk-UBLFIMUA.js";
19
+ import "./chunk-VVQOFG76.js";
20
+ import {
21
+ teamSchema
22
+ } from "./chunk-FJCOYEKT.js";
23
+ import "./chunk-VRZSDUZK.js";
24
+ import "./chunk-4ORL4MST.js";
25
+ import "./chunk-VUNOOPEG.js";
26
+ import {
27
+ output
28
+ } from "./chunk-T5HJUAWB.js";
29
+ import "./chunk-U764PQUA.js";
30
+ import "./chunk-Q26DFKTY.js";
31
+ import "./chunk-I57ID5K7.js";
32
+ import "./chunk-3MZYUBJ6.js";
33
+
34
+ // src/domains/auth/whoami/action.ts
35
+ import as from "ansis";
36
+ async function whoamiAction(options = {}) {
37
+ const auth = await getAuthData();
38
+ const team = await getDatabaseClient().then(
39
+ (client) => client.getOne({
40
+ collectionPath: BaseCollections.Teams,
41
+ query: { uid: auth.teamUid },
42
+ schema: teamSchema
43
+ })
44
+ ).catch(() => null);
45
+ const details = {
46
+ email: auth.email,
47
+ team: {
48
+ uid: auth.teamUid,
49
+ name: team && !team.error ? team.data.name : null
50
+ },
51
+ role: auth.role ?? null,
52
+ authentication: "refreshToken" in auth ? "browser_session" : "personal_token"
53
+ };
54
+ if (options.json) {
55
+ process.stdout.write(`${JSON.stringify(details, null, 2)}
56
+ `);
57
+ return;
58
+ }
59
+ output.info().line(`User: ${as.cyan(details.email ?? "Unknown")}`).line(`Team: ${details.team.name ?? "Unavailable"}`).line(`Team ID: ${details.team.uid}`).line(`Role: ${as.cyan(details.role ?? "Unknown")}`).line(
60
+ `Authentication: ${details.authentication === "browser_session" ? "Browser session" : "Personal token"}`
61
+ ).print();
62
+ }
63
+ export {
64
+ whoamiAction
65
+ };
@@ -1,24 +1,24 @@
1
1
  import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
2
  import {
3
3
  isDocument
4
- } from "./chunk-CWVYOXXM.js";
4
+ } from "./chunk-SNOAL2C5.js";
5
5
  import {
6
6
  isAsyncApiDocument
7
- } from "./chunk-H467HDVV.js";
7
+ } from "./chunk-PERC34BV.js";
8
8
  import {
9
9
  err,
10
10
  ok
11
11
  } from "./chunk-5ENKYZA4.js";
12
- import "./chunk-GLWTVLKM.js";
13
12
  import {
14
13
  isUrl
15
14
  } from "./chunk-4ORL4MST.js";
16
- import "./chunk-MNNGUUKJ.js";
15
+ import "./chunk-VUNOOPEG.js";
17
16
  import {
18
17
  output
19
18
  } from "./chunk-T5HJUAWB.js";
20
- import "./chunk-ZGVZU6L2.js";
21
- import "./chunk-VVRUSQCY.js";
19
+ import "./chunk-U764PQUA.js";
20
+ import "./chunk-Q26DFKTY.js";
21
+ import "./chunk-I57ID5K7.js";
22
22
  import "./chunk-3MZYUBJ6.js";
23
23
 
24
24
  // src/domains/document/validate/action.ts
@@ -179,7 +179,7 @@ var resolveForValidation = (document) => {
179
179
  async function validateAction(inputArgument) {
180
180
  const startTime = performance.now();
181
181
  if (!inputArgument) {
182
- return output.error().title("Invalid argument").message("Please provide a file path").exit("error");
182
+ return output.error().title("Invalid argument").message("Provide a file path or URL.").exit("error");
183
183
  }
184
184
  const document = await bundle(
185
185
  isUrl(inputArgument) ? inputArgument : path.resolve(inputArgument),
@@ -191,7 +191,7 @@ async function validateAction(inputArgument) {
191
191
  return output.error().title("Invalid input").message(error instanceof Error ? error.message : String(error)).exit("error");
192
192
  });
193
193
  if (!isDocument(document)) {
194
- return output.error().title("Invalid input").message("Please provide a valid JSON or YAML document.").exit("error");
194
+ return output.error().title("Invalid input").message("Provide a valid JSON or YAML document.").exit("error");
195
195
  }
196
196
  const resolved = resolveForValidation(document);
197
197
  if (!resolved.ok) {
@@ -209,8 +209,8 @@ async function validateAction(inputArgument) {
209
209
  `
210
210
  )
211
211
  ).line(
212
- `${as.green("File validated")} ${as.grey(
213
- `in ${as.white(`${as.bold(`${Math.round(endTime - startTime)}`)} ms`)}
212
+ `${as.green("API description validated")} ${as.grey(
213
+ `(${as.white(`${as.bold(`${Math.round(endTime - startTime)}`)} ms`)})
214
214
  `
215
215
  )}`
216
216
  ).print();
@@ -222,7 +222,7 @@ async function validateAction(inputArgument) {
222
222
  ).message(
223
223
  as.red(
224
224
  `${as.bold(
225
- `${result.errors?.length} error${result.errors && result.errors.length > 1 ? "s" : ""}`
225
+ `${result.errors?.length ?? 0} error${result.errors?.length === 1 ? "" : "s"}`
226
226
  )} found.`
227
227
  )
228
228
  ).exit("error");
@@ -1,36 +1,37 @@
1
1
  import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
- import {
3
- resolveProject
4
- } from "./chunk-TSURUX4A.js";
5
2
  import {
6
3
  projectDetails
7
4
  } from "./chunk-6PSYZO3U.js";
5
+ import {
6
+ resolveProject
7
+ } from "./chunk-TSURUX4A.js";
8
8
  import {
9
9
  formatAbsoluteTime
10
10
  } from "./chunk-AEFPCC4U.js";
11
11
  import {
12
12
  apiService
13
- } from "./chunk-ATNTXKMS.js";
14
- import "./chunk-43WALAW3.js";
15
- import "./chunk-ZYBLQ5CT.js";
16
- import "./chunk-KHF2QXBG.js";
17
- import "./chunk-IPZP3VRA.js";
13
+ } from "./chunk-RNZVZMYC.js";
14
+ import "./chunk-N645RGAB.js";
15
+ import "./chunk-JLNHOA5Z.js";
16
+ import "./chunk-Y6C3H27E.js";
18
17
  import "./chunk-5ENKYZA4.js";
19
- import "./chunk-G4HRW2FZ.js";
20
- import "./chunk-35Z7VTJT.js";
21
- import "./chunk-WB6PWTMU.js";
22
- import "./chunk-DHZW7Q7U.js";
23
- import "./chunk-GYRQPDTK.js";
24
- import "./chunk-6M7TL2G2.js";
25
- import "./chunk-GLWTVLKM.js";
26
- import "./chunk-MNNGUUKJ.js";
18
+ import "./chunk-RYWXF3LO.js";
19
+ import "./chunk-5TNKTLQP.js";
20
+ import "./chunk-V3MYP5SQ.js";
21
+ import "./chunk-YTFFBGNQ.js";
22
+ import "./chunk-UBLFIMUA.js";
23
+ import "./chunk-VVQOFG76.js";
24
+ import "./chunk-FJCOYEKT.js";
25
+ import "./chunk-VRZSDUZK.js";
26
+ import "./chunk-VUNOOPEG.js";
27
27
  import {
28
28
  output
29
29
  } from "./chunk-T5HJUAWB.js";
30
- import "./chunk-ZGVZU6L2.js";
30
+ import "./chunk-U764PQUA.js";
31
+ import "./chunk-Q26DFKTY.js";
31
32
  import {
32
33
  slugSchema
33
- } from "./chunk-VVRUSQCY.js";
34
+ } from "./chunk-I57ID5K7.js";
34
35
  import "./chunk-3MZYUBJ6.js";
35
36
 
36
37
  // src/domains/project/get/action.ts
@@ -52,7 +53,7 @@ async function getAction(slug, options) {
52
53
  return;
53
54
  }
54
55
  const deployment = project.activeDeployment;
55
- output.info().title(project.name).line(`Slug: ${project.slug}`).line(`UID: ${project.uid}`).line(
56
+ output.info().title(project.name).line(`Slug: ${project.slug}`).line(`ID: ${project.uid}`).line(
56
57
  `Source: ${project.provider === "forgejo" ? "Scalar" : project.provider}`
57
58
  ).line(`Access: ${project.isPrivate ? "Private" : "Public"}`).line(`Repository: ${project.repository?.name ?? "(unlinked)"}`).line(`Branch: ${project.repository?.branch || "\u2014"}`).line(`Config path: ${project.repository?.configPath || "\u2014"}`).line(`Live deployment: ${deployment?.uid ?? "(none)"}`).line(`Domain: ${deployment?.domain ?? "\u2014"}`).line(
58
59
  `Deployed: ${deployment ? formatAbsoluteTime(deployment.publishedAt * 1e3) : "\u2014"}`