@lukoweb/apitogo 0.1.108 → 0.1.110
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/dist/cli/cli.js +4 -46
- package/docs/cli/commands.md +11 -23
- package/docs/cli/overview.md +1 -1
- package/docs/cli/shape.md +1 -1
- package/docs/configuration/make-config.mdx +2 -2
- package/docs/configuration/navigation.mdx +2 -2
- package/docs/configuration/plans.md +1 -1
- package/docs/guides/environment-variables.md +1 -1
- package/package.json +1 -1
- package/src/app/main.css +1 -1
package/dist/cli/cli.js
CHANGED
|
@@ -5801,7 +5801,7 @@ import {
|
|
|
5801
5801
|
// package.json
|
|
5802
5802
|
var package_default = {
|
|
5803
5803
|
name: "@lukoweb/apitogo",
|
|
5804
|
-
version: "0.1.
|
|
5804
|
+
version: "0.1.110",
|
|
5805
5805
|
type: "module",
|
|
5806
5806
|
sideEffects: [
|
|
5807
5807
|
"**/*.css",
|
|
@@ -14848,8 +14848,8 @@ import path48 from "node:path";
|
|
|
14848
14848
|
import path47 from "node:path";
|
|
14849
14849
|
|
|
14850
14850
|
// src/cli/make-config/branding-assets.ts
|
|
14851
|
-
var LOGO_LIGHT = '<svg xmlns="http://www.w3.org/2000/svg" width="201.57" height="
|
|
14852
|
-
var LOGO_DARK = '<svg xmlns="http://www.w3.org/2000/svg" width="201.57" height="
|
|
14851
|
+
var LOGO_LIGHT = '<svg xmlns="http://www.w3.org/2000/svg" width="201.57" height="72.66" viewBox="-0.09 -46.99 201.57 72.66">\n <path d="M13.5 0.39Q8.03 0.39 4.76 -2.09Q1.48 -4.57 1.41 -9.61H8.03Q8.14 -7.48 9.6 -6.41Q11.05 -5.33 13.42 -5.33Q15.57 -5.33 16.8 -6.2Q18.03 -7.07 18.03 -8.46Q18.03 -9.71 16.87 -10.44Q15.7 -11.17 13.32 -11.72L10.23 -12.44Q6.46 -13.3 4.32 -15.25Q2.17 -17.21 2.17 -20.49Q2.17 -23.18 3.62 -25.21Q5.08 -27.23 7.64 -28.36Q10.2 -29.49 13.5 -29.49Q16.88 -29.49 19.36 -28.35Q21.84 -27.21 23.2 -25.17Q24.57 -23.12 24.61 -20.43H17.99Q17.85 -22.01 16.7 -22.89Q15.55 -23.77 13.48 -23.77Q11.41 -23.77 10.35 -22.97Q9.3 -22.17 9.3 -20.96Q9.3 -19.61 10.47 -18.88Q11.64 -18.14 13.59 -17.71L16.11 -17.13Q20.33 -16.19 22.67 -14.06Q25 -11.93 25 -8.44Q25 -4.3 21.95 -1.95Q18.91 0.39 13.5 0.39Z M32.97 0.39Q29.82 0.39 27.8 -1.21Q25.78 -2.81 25.78 -6.05Q25.78 -8.48 26.89 -9.9Q28 -11.33 29.85 -12.01Q31.7 -12.7 33.9 -12.89Q36.68 -13.12 37.88 -13.47Q39.08 -13.81 39.08 -14.82V-14.9Q39.08 -16.04 38.29 -16.65Q37.5 -17.27 36.11 -17.27Q34.68 -17.27 33.77 -16.66Q32.85 -16.05 32.58 -15.02L26.4 -15.82Q27.05 -18.61 29.56 -20.36Q32.07 -22.11 36.17 -22.11Q38.88 -22.11 41.08 -21.27Q43.28 -20.43 44.58 -18.8Q45.88 -17.17 45.88 -14.82V0H39.47V-3.07H39.29Q37.48 0.39 32.97 0.39ZM35.04 -4.12Q36.75 -4.12 37.95 -5.14Q39.14 -6.15 39.14 -7.77V-9.86Q38.55 -9.55 37.44 -9.34Q36.33 -9.12 35.37 -8.96Q32.22 -8.5 32.22 -6.37Q32.22 -5.27 33.01 -4.7Q33.81 -4.12 35.04 -4.12Z M48.59 0V-21.84H54.86L55.17 -17.5Q56.07 -19.96 57.78 -21.04Q59.49 -22.13 61.46 -22.13Q63.53 -22.13 64.91 -20.94Q66.28 -19.75 67.08 -17.07Q68.08 -19.77 70.02 -20.95Q71.97 -22.13 74.17 -22.13Q77.24 -22.13 79.2 -20.16Q81.17 -18.18 81.17 -14.73V0H74.37V-13.18Q74.37 -14.84 73.5 -15.7Q72.63 -16.56 71.28 -16.56Q69.84 -16.56 69 -15.62Q68.16 -14.67 68.16 -13.11V0H61.61V-13.28Q61.61 -14.79 60.77 -15.67Q59.92 -16.56 58.57 -16.56Q57.18 -16.56 56.29 -15.62Q55.4 -14.69 55.4 -12.97V0Z M83.88 8.16V-21.84H90.62V-18.09H90.85Q91.26 -19.06 92.04 -19.99Q92.82 -20.92 94.05 -21.51Q95.28 -22.11 97.02 -22.11Q99.33 -22.11 101.31 -20.9Q103.29 -19.69 104.51 -17.21Q105.73 -14.73 105.73 -10.9Q105.73 -7.19 104.55 -4.7Q103.37 -2.21 101.39 -0.95Q99.4 0.31 96.98 0.31Q94.48 0.31 92.99 -0.87Q91.49 -2.05 90.85 -3.54H90.69V8.16ZM94.66 -5Q96.63 -5 97.68 -6.62Q98.72 -8.24 98.72 -10.9Q98.72 -13.55 97.68 -15.17Q96.63 -16.78 94.66 -16.78Q92.71 -16.78 91.62 -15.2Q90.54 -13.61 90.54 -10.9Q90.54 -8.22 91.62 -6.61Q92.71 -5 94.66 -5Z M114.4 -29.1V0H107.59V-29.1Z M127.29 0.41Q122.15 0.41 119.21 -2.59Q116.27 -5.59 116.27 -10.84Q116.27 -14.2 117.59 -16.74Q118.91 -19.28 121.33 -20.69Q123.75 -22.11 127.04 -22.11Q130.1 -22.11 132.47 -20.83Q134.85 -19.55 136.21 -17.06Q137.56 -14.57 137.56 -10.98V-9.26H122.97Q123.07 -6.89 124.27 -5.71Q125.47 -4.53 127.41 -4.53Q128.77 -4.53 129.77 -5.11Q130.77 -5.68 131.18 -6.78L137.25 -5.78Q136.43 -2.95 133.84 -1.27Q131.25 0.41 127.29 0.41ZM123.01 -13.22H131.1Q130.9 -15.08 129.89 -16.12Q128.87 -17.17 127.09 -17.17Q125.3 -17.17 124.25 -16.1Q123.21 -15.04 123.01 -13.22Z" fill="#202633"/>\n <path d="M138.48 0 148.19 -29.1H157.43L167.43 0H159.69L157.72 -6.19H148.03L146.14 0ZM149.65 -11.46H156.04L155.65 -12.71Q154.89 -15.21 154.16 -17.95Q153.44 -20.68 152.74 -23.61Q152.07 -20.66 151.42 -17.93Q150.77 -15.2 150.04 -12.71Z M168.81 0V-29.1H180.72Q184 -29.1 186.39 -27.83Q188.77 -26.56 190.05 -24.3Q191.33 -22.03 191.33 -19.04Q191.33 -16.04 190.02 -13.8Q188.71 -11.56 186.29 -10.32Q183.87 -9.08 180.53 -9.08H175.7V0ZM175.7 -14.53H179.28Q181.7 -14.53 182.94 -15.77Q184.18 -17.01 184.18 -19.04Q184.18 -21.09 182.93 -22.3Q181.68 -23.52 179.26 -23.52H175.7Z M199.98 -29.1V0H193.08V-29.1Z" fill="#008A7D"/>\n</svg>\n';
|
|
14852
|
+
var LOGO_DARK = '<svg xmlns="http://www.w3.org/2000/svg" width="201.57" height="72.66" viewBox="-0.09 -46.99 201.57 72.66">\n <path d="M13.5 0.39Q8.03 0.39 4.76 -2.09Q1.48 -4.57 1.41 -9.61H8.03Q8.14 -7.48 9.6 -6.41Q11.05 -5.33 13.42 -5.33Q15.57 -5.33 16.8 -6.2Q18.03 -7.07 18.03 -8.46Q18.03 -9.71 16.87 -10.44Q15.7 -11.17 13.32 -11.72L10.23 -12.44Q6.46 -13.3 4.32 -15.25Q2.17 -17.21 2.17 -20.49Q2.17 -23.18 3.62 -25.21Q5.08 -27.23 7.64 -28.36Q10.2 -29.49 13.5 -29.49Q16.88 -29.49 19.36 -28.35Q21.84 -27.21 23.2 -25.17Q24.57 -23.12 24.61 -20.43H17.99Q17.85 -22.01 16.7 -22.89Q15.55 -23.77 13.48 -23.77Q11.41 -23.77 10.35 -22.97Q9.3 -22.17 9.3 -20.96Q9.3 -19.61 10.47 -18.88Q11.64 -18.14 13.59 -17.71L16.11 -17.13Q20.33 -16.19 22.67 -14.06Q25 -11.93 25 -8.44Q25 -4.3 21.95 -1.95Q18.91 0.39 13.5 0.39Z M32.97 0.39Q29.82 0.39 27.8 -1.21Q25.78 -2.81 25.78 -6.05Q25.78 -8.48 26.89 -9.9Q28 -11.33 29.85 -12.01Q31.7 -12.7 33.9 -12.89Q36.68 -13.12 37.88 -13.47Q39.08 -13.81 39.08 -14.82V-14.9Q39.08 -16.04 38.29 -16.65Q37.5 -17.27 36.11 -17.27Q34.68 -17.27 33.77 -16.66Q32.85 -16.05 32.58 -15.02L26.4 -15.82Q27.05 -18.61 29.56 -20.36Q32.07 -22.11 36.17 -22.11Q38.88 -22.11 41.08 -21.27Q43.28 -20.43 44.58 -18.8Q45.88 -17.17 45.88 -14.82V0H39.47V-3.07H39.29Q37.48 0.39 32.97 0.39ZM35.04 -4.12Q36.75 -4.12 37.95 -5.14Q39.14 -6.15 39.14 -7.77V-9.86Q38.55 -9.55 37.44 -9.34Q36.33 -9.12 35.37 -8.96Q32.22 -8.5 32.22 -6.37Q32.22 -5.27 33.01 -4.7Q33.81 -4.12 35.04 -4.12Z M48.59 0V-21.84H54.86L55.17 -17.5Q56.07 -19.96 57.78 -21.04Q59.49 -22.13 61.46 -22.13Q63.53 -22.13 64.91 -20.94Q66.28 -19.75 67.08 -17.07Q68.08 -19.77 70.02 -20.95Q71.97 -22.13 74.17 -22.13Q77.24 -22.13 79.2 -20.16Q81.17 -18.18 81.17 -14.73V0H74.37V-13.18Q74.37 -14.84 73.5 -15.7Q72.63 -16.56 71.28 -16.56Q69.84 -16.56 69 -15.62Q68.16 -14.67 68.16 -13.11V0H61.61V-13.28Q61.61 -14.79 60.77 -15.67Q59.92 -16.56 58.57 -16.56Q57.18 -16.56 56.29 -15.62Q55.4 -14.69 55.4 -12.97V0Z M83.88 8.16V-21.84H90.62V-18.09H90.85Q91.26 -19.06 92.04 -19.99Q92.82 -20.92 94.05 -21.51Q95.28 -22.11 97.02 -22.11Q99.33 -22.11 101.31 -20.9Q103.29 -19.69 104.51 -17.21Q105.73 -14.73 105.73 -10.9Q105.73 -7.19 104.55 -4.7Q103.37 -2.21 101.39 -0.95Q99.4 0.31 96.98 0.31Q94.48 0.31 92.99 -0.87Q91.49 -2.05 90.85 -3.54H90.69V8.16ZM94.66 -5Q96.63 -5 97.68 -6.62Q98.72 -8.24 98.72 -10.9Q98.72 -13.55 97.68 -15.17Q96.63 -16.78 94.66 -16.78Q92.71 -16.78 91.62 -15.2Q90.54 -13.61 90.54 -10.9Q90.54 -8.22 91.62 -6.61Q92.71 -5 94.66 -5Z M114.4 -29.1V0H107.59V-29.1Z M127.29 0.41Q122.15 0.41 119.21 -2.59Q116.27 -5.59 116.27 -10.84Q116.27 -14.2 117.59 -16.74Q118.91 -19.28 121.33 -20.69Q123.75 -22.11 127.04 -22.11Q130.1 -22.11 132.47 -20.83Q134.85 -19.55 136.21 -17.06Q137.56 -14.57 137.56 -10.98V-9.26H122.97Q123.07 -6.89 124.27 -5.71Q125.47 -4.53 127.41 -4.53Q128.77 -4.53 129.77 -5.11Q130.77 -5.68 131.18 -6.78L137.25 -5.78Q136.43 -2.95 133.84 -1.27Q131.25 0.41 127.29 0.41ZM123.01 -13.22H131.1Q130.9 -15.08 129.89 -16.12Q128.87 -17.17 127.09 -17.17Q125.3 -17.17 124.25 -16.1Q123.21 -15.04 123.01 -13.22Z" fill="#FFFFFF"/>\n <path d="M138.48 0 148.19 -29.1H157.43L167.43 0H159.69L157.72 -6.19H148.03L146.14 0ZM149.65 -11.46H156.04L155.65 -12.71Q154.89 -15.21 154.16 -17.95Q153.44 -20.68 152.74 -23.61Q152.07 -20.66 151.42 -17.93Q150.77 -15.2 150.04 -12.71Z M168.81 0V-29.1H180.72Q184 -29.1 186.39 -27.83Q188.77 -26.56 190.05 -24.3Q191.33 -22.03 191.33 -19.04Q191.33 -16.04 190.02 -13.8Q188.71 -11.56 186.29 -10.32Q183.87 -9.08 180.53 -9.08H175.7V0ZM175.7 -14.53H179.28Q181.7 -14.53 182.94 -15.77Q184.18 -17.01 184.18 -19.04Q184.18 -21.09 182.93 -22.3Q181.68 -23.52 179.26 -23.52H175.7Z M199.98 -29.1V0H193.08V-29.1Z" fill="#008A7D"/>\n</svg>\n';
|
|
14853
14853
|
var DEFAULT_SITE_LOGO = {
|
|
14854
14854
|
src: { light: "/logo-light.svg", dark: "/logo-dark.svg" }
|
|
14855
14855
|
};
|
|
@@ -16444,7 +16444,6 @@ function addConfigOptions(yargs2) {
|
|
|
16444
16444
|
var config_default = {
|
|
16445
16445
|
desc: "Create or update apitogo.config.json (interactive on TTY: backend, OpenAPI, pages, plans)",
|
|
16446
16446
|
command: "config",
|
|
16447
|
-
aliases: ["make-config"],
|
|
16448
16447
|
builder: (yargs2) => addConfigOptions(yargs2),
|
|
16449
16448
|
handler: async (argv) => {
|
|
16450
16449
|
await captureEvent({ argv, event: "apitogo config" });
|
|
@@ -16452,21 +16451,6 @@ var config_default = {
|
|
|
16452
16451
|
}
|
|
16453
16452
|
};
|
|
16454
16453
|
|
|
16455
|
-
// src/cli/cmds/configure-github-workflow.ts
|
|
16456
|
-
var REMOVED = "apitogo configure-github-workflow was removed. Multi-env SWA deploy is deprecated; use `apitogo deploy`.";
|
|
16457
|
-
var configure_github_workflow_default = {
|
|
16458
|
-
describe: false,
|
|
16459
|
-
command: "configure-github-workflow",
|
|
16460
|
-
builder: (yargs2) => yargs2,
|
|
16461
|
-
handler: async (argv) => {
|
|
16462
|
-
await captureEvent({
|
|
16463
|
-
argv,
|
|
16464
|
-
event: "apitogo configure-github-workflow removed"
|
|
16465
|
-
});
|
|
16466
|
-
await printCriticalFailureToConsoleAndExit(REMOVED);
|
|
16467
|
-
}
|
|
16468
|
-
};
|
|
16469
|
-
|
|
16470
16454
|
// src/cli/apply/handler.ts
|
|
16471
16455
|
import path62 from "node:path";
|
|
16472
16456
|
|
|
@@ -21098,7 +21082,6 @@ async function apply(argv) {
|
|
|
21098
21082
|
var deploy_default = {
|
|
21099
21083
|
desc: "Deploy apitogo.config.json to the API ToGo platform (apihub, portal backend, portal frontend)",
|
|
21100
21084
|
command: "deploy",
|
|
21101
|
-
aliases: ["apply"],
|
|
21102
21085
|
builder: (yargs2) => yargs2.option("dir", {
|
|
21103
21086
|
type: "string",
|
|
21104
21087
|
describe: "Site directory containing apitogo.config.json",
|
|
@@ -21801,18 +21784,6 @@ var init_default = {
|
|
|
21801
21784
|
}
|
|
21802
21785
|
};
|
|
21803
21786
|
|
|
21804
|
-
// src/cli/cmds/preview.ts
|
|
21805
|
-
var REMOVED2 = "apitogo preview was removed. Use `apitogo build --preview` or `apitogo run`.";
|
|
21806
|
-
var preview_default = {
|
|
21807
|
-
describe: false,
|
|
21808
|
-
command: "preview",
|
|
21809
|
-
builder: (yargs2) => yargs2,
|
|
21810
|
-
handler: async (argv) => {
|
|
21811
|
-
await captureEvent({ argv, event: "apitogo preview removed" });
|
|
21812
|
-
await printCriticalFailureToConsoleAndExit(REMOVED2);
|
|
21813
|
-
}
|
|
21814
|
-
};
|
|
21815
|
-
|
|
21816
21787
|
// src/cli/project/create-handler.ts
|
|
21817
21788
|
function resultLooksFailed2(payload) {
|
|
21818
21789
|
try {
|
|
@@ -21885,18 +21856,6 @@ var project_create_default = {
|
|
|
21885
21856
|
}
|
|
21886
21857
|
};
|
|
21887
21858
|
|
|
21888
|
-
// src/cli/cmds/remove.ts
|
|
21889
|
-
var REMOVED3 = "apitogo remove was removed. Use `apitogo teardown --yes` to delete the platform project.";
|
|
21890
|
-
var remove_default = {
|
|
21891
|
-
describe: false,
|
|
21892
|
-
command: "remove",
|
|
21893
|
-
builder: (yargs2) => yargs2,
|
|
21894
|
-
handler: async (argv) => {
|
|
21895
|
-
await captureEvent({ argv, event: "apitogo remove removed" });
|
|
21896
|
-
await printCriticalFailureToConsoleAndExit(REMOVED3);
|
|
21897
|
-
}
|
|
21898
|
-
};
|
|
21899
|
-
|
|
21900
21859
|
// src/cli/dev/handler.ts
|
|
21901
21860
|
init_joinUrl();
|
|
21902
21861
|
import path68 from "node:path";
|
|
@@ -22265,7 +22224,6 @@ async function dev(argv) {
|
|
|
22265
22224
|
var run_default = {
|
|
22266
22225
|
desc: "Run the local portal server",
|
|
22267
22226
|
command: "run",
|
|
22268
|
-
aliases: ["dev"],
|
|
22269
22227
|
builder: (yargs2) => {
|
|
22270
22228
|
return yargs2.option("dir", {
|
|
22271
22229
|
type: "string",
|
|
@@ -22532,7 +22490,7 @@ function createApitogoCli(argv) {
|
|
|
22532
22490
|
process.env.ZUPLO = "1";
|
|
22533
22491
|
printDiagnosticsToConsole("Running in Zuplo mode");
|
|
22534
22492
|
}
|
|
22535
|
-
}).middleware(warnPackageVersionMismatch).command(command(init_default)).command(command(config_default)).command(command(run_default)).command(command(build_default)).command(command(check_default)).command(command(project_create_default)).command(command(deploy_default)).command(command(status_default)).command(command(teardown_default)).
|
|
22493
|
+
}).middleware(warnPackageVersionMismatch).command(command(init_default)).command(command(config_default)).command(command(run_default)).command(command(build_default)).command(command(check_default)).command(command(project_create_default)).command(command(deploy_default)).command(command(status_default)).command(command(teardown_default)).demandCommand().strictCommands().version(packageJson?.version).fail(false).help();
|
|
22536
22494
|
}
|
|
22537
22495
|
|
|
22538
22496
|
// src/cli/cli.ts
|
package/docs/cli/commands.md
CHANGED
|
@@ -10,17 +10,17 @@ same commands so agents and humans get identical behavior.
|
|
|
10
10
|
|
|
11
11
|
## Lifecycle (prefer these)
|
|
12
12
|
|
|
13
|
-
| Command
|
|
14
|
-
|
|
|
15
|
-
| `init`
|
|
16
|
-
| `config`
|
|
17
|
-
| `run`
|
|
18
|
-
| `build`
|
|
19
|
-
| `check`
|
|
20
|
-
| `project create`
|
|
21
|
-
| `deploy`
|
|
22
|
-
| `status`
|
|
23
|
-
| `teardown --yes`
|
|
13
|
+
| Command | Role |
|
|
14
|
+
| ---------------- | --------------------------------------------------------------------- |
|
|
15
|
+
| `init` | Scaffold portal (default `./dev-portal`; OpenAPI discovery + secrets) |
|
|
16
|
+
| `config` | Write or update `apitogo.config.json` (interactive or flags) |
|
|
17
|
+
| `run` | Local preview server |
|
|
18
|
+
| `build` | Production build (`--preview` to serve locally) |
|
|
19
|
+
| `check` | Publish readiness (secrets, manifest, site validation) |
|
|
20
|
+
| `project create` | Create a platform project (plan unselected) |
|
|
21
|
+
| `deploy` | Publish config to platform (apihub + portal) |
|
|
22
|
+
| `status` | Account, project, and live readiness |
|
|
23
|
+
| `teardown --yes` | Delete the linked platform project |
|
|
24
24
|
|
|
25
25
|
## Scaffold and config
|
|
26
26
|
|
|
@@ -39,7 +39,6 @@ See [Make config (CLI)](../configuration/make-config.mdx) for all `config` flags
|
|
|
39
39
|
| Command | Role |
|
|
40
40
|
| ----------------- | --------------------------------------------------------- |
|
|
41
41
|
| `run` | Run the local portal server (`--port`, `--open`, `--ssr`) |
|
|
42
|
-
| `dev` | Alias for `run` |
|
|
43
42
|
| `build` | Production static build |
|
|
44
43
|
| `build --preview` | Build then serve locally |
|
|
45
44
|
|
|
@@ -54,7 +53,6 @@ See [Make config (CLI)](../configuration/make-config.mdx) for all `config` flags
|
|
|
54
53
|
| `deploy --force` | Redeploy selected resources even when healthy |
|
|
55
54
|
| `deploy --platform-plan` | Select Free / Starter / Professional hosting |
|
|
56
55
|
| `deploy --resume-from` | Resume interrupted publish |
|
|
57
|
-
| `apply` | Alias for `deploy` |
|
|
58
56
|
| `status` | Whoami + project + live verification |
|
|
59
57
|
| `teardown --yes` | Delete platform project (confirmation required) |
|
|
60
58
|
|
|
@@ -69,16 +67,6 @@ Env: `APITOGO_API_KEY_ID`, `APITOGO_API_SECRET`. Optional: `APITOGO_API_URL`.
|
|
|
69
67
|
|
|
70
68
|
There is no CLI command for arbitrary home page content.
|
|
71
69
|
|
|
72
|
-
## Removed commands
|
|
73
|
-
|
|
74
|
-
These print a redirect message — use the replacement:
|
|
75
|
-
|
|
76
|
-
| Removed | Use instead |
|
|
77
|
-
| --------------------------- | -------------------------------------------------- |
|
|
78
|
-
| `preview` | `npx apitogo build --preview` or `npx apitogo run` |
|
|
79
|
-
| `remove` | `npx apitogo teardown --yes` |
|
|
80
|
-
| `configure-github-workflow` | `npx apitogo deploy` |
|
|
81
|
-
|
|
82
70
|
## Related
|
|
83
71
|
|
|
84
72
|
- [Overview](./overview.md)
|
package/docs/cli/overview.md
CHANGED
|
@@ -23,7 +23,7 @@ local files, preview with `npx apitogo run`, and publish to APItoGo hosting with
|
|
|
23
23
|
|
|
24
24
|
## Prerequisites
|
|
25
25
|
|
|
26
|
-
### Shell environment (for
|
|
26
|
+
### Shell environment (for deploy / status / teardown)
|
|
27
27
|
|
|
28
28
|
| Variable | Required | Purpose |
|
|
29
29
|
| -------------------- | -------- | ----------------- |
|
package/docs/cli/shape.md
CHANGED
|
@@ -56,7 +56,7 @@ Fonts and colors are **not** prompted — edit `apitogo.config.json` or see
|
|
|
56
56
|
[Colors & theme](../customization/colors-theme.mdx).
|
|
57
57
|
|
|
58
58
|
**Paid plans:** if any plan has `priceAmount > 0`, you need **Starter** or **Professional** platform
|
|
59
|
-
hosting on
|
|
59
|
+
hosting on deploy. **Free** cannot publish paid gateway plans or custom domains.
|
|
60
60
|
|
|
61
61
|
Full reference: [Make config (CLI)](../configuration/make-config.mdx) ·
|
|
62
62
|
[Gateway plans](../configuration/plans.md)
|
|
@@ -7,7 +7,7 @@ description:
|
|
|
7
7
|
site settings.
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
The **`npx apitogo config`**
|
|
10
|
+
The **`npx apitogo config`** command writes **`apitogo.config.json`**. It can
|
|
11
11
|
scaffold a portal project (package.json, tsconfig, landing and user-panel stubs, thin
|
|
12
12
|
`apitogo.config.tsx`) when those files are missing, merge **site / theme / authentication** from
|
|
13
13
|
flags, run an **interactive wizard** on a TTY (apply each change immediately), scan `pages/` for
|
|
@@ -71,7 +71,7 @@ Authentication stays **enabled**; `npx apitogo deploy` writes
|
|
|
71
71
|
`VITE_APITOGO_AUTHENTICATION_API_BASE_URL` to `.env` after the portal backend is provisioned.
|
|
72
72
|
|
|
73
73
|
If you add a **paid** plan (`priceAmount > 0`), the CLI warns that **Free platform hosting cannot
|
|
74
|
-
publish paid gateway plans or custom domains** — use Starter or Professional on
|
|
74
|
+
publish paid gateway plans or custom domains** — use Starter or Professional on deploy.
|
|
75
75
|
|
|
76
76
|
See [Gateway plans](./plans.md) and [Shape with CLI](../cli/shape.md).
|
|
77
77
|
|
|
@@ -58,13 +58,13 @@ one of several types. At the simplest level you may only have links and categori
|
|
|
58
58
|
|
|
59
59
|
## Generate navigation automatically
|
|
60
60
|
|
|
61
|
-
Use the CLI command **`npx apitogo
|
|
61
|
+
Use the CLI command **`npx apitogo config`** to merge **`navigation`** from your pages folder into
|
|
62
62
|
`apitogo.config.json`. See **[Make config (CLI)](./make-config.md)** for usage. The command does **not**
|
|
63
63
|
change **`redirects`**.
|
|
64
64
|
|
|
65
65
|
::::caution
|
|
66
66
|
|
|
67
|
-
Without `--force`, `
|
|
67
|
+
Without `--force`, `npx apitogo config` only **adds missing** Documentation items. `--force` rebuilds
|
|
68
68
|
Documentation items from disk but still keeps other nav entries such as API Reference.
|
|
69
69
|
|
|
70
70
|
::::
|
|
@@ -113,7 +113,7 @@ The **Free** platform plan cannot:
|
|
|
113
113
|
- Attach a **custom domain** to the dev portal
|
|
114
114
|
|
|
115
115
|
Use **Starter** or **Professional** for paid API tiers, Stripe checkout, and custom domains. If your
|
|
116
|
-
manifest has paid plans and you try `npx apitogo deploy --platform-plan free`,
|
|
116
|
+
manifest has paid plans and you try `npx apitogo deploy --platform-plan free`, deploy is blocked until you
|
|
117
117
|
upgrade or zero/remove those paid plans.
|
|
118
118
|
|
|
119
119
|
## Related
|
|
@@ -85,7 +85,7 @@ interface ImportMeta {
|
|
|
85
85
|
|
|
86
86
|
| Variable | Purpose |
|
|
87
87
|
| -------- | ------- |
|
|
88
|
-
| `APITOGO_API_KEY_ID` / `APITOGO_API_SECRET` | Required for MCP and CLI
|
|
88
|
+
| `APITOGO_API_KEY_ID` / `APITOGO_API_SECRET` | Required for MCP and CLI deploy/status/teardown |
|
|
89
89
|
| `APITOGO_DOC_TOOL_PATH` | Optional local doc-tool for scaffold |
|
|
90
90
|
| `APITOGO_CLI_PATH` | Optional local `@lukoweb/apitogo` / doc-tool checkout for MCP spawn |
|
|
91
91
|
|
package/package.json
CHANGED