@lukoweb/apitogo 0.1.100 → 0.1.101

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 (16) hide show
  1. package/dist/cli/cli.js +15711 -15717
  2. package/docs/cli/commands.md +13 -12
  3. package/docs/cli/go-live.md +14 -14
  4. package/docs/cli/overview.md +6 -6
  5. package/docs/cli/setup.md +7 -7
  6. package/docs/cli/shape.md +7 -7
  7. package/docs/configuration/authentication.md +1 -1
  8. package/docs/configuration/make-config.mdx +1 -1
  9. package/docs/configuration/manifest.md +1 -1
  10. package/docs/configuration/plans.md +5 -5
  11. package/docs/deploy/apitogo.md +2 -2
  12. package/docs/deployment.md +2 -2
  13. package/docs/guides/environment-variables.md +1 -1
  14. package/docs/markdown/frontmatter.md +1 -1
  15. package/docs/mcp/go-live.md +1 -1
  16. package/package.json +1 -1
package/docs/cli/commands.md CHANGED
@@ -5,7 +5,7 @@ sidebar_icon: wrench
5
5
  ---
6
6
 
7
7
  Commands are exposed by the **`apitogo`** binary (`@lukoweb/apitogo`). The CLI is the **source of
8
- truth** for init, config, apply, status, teardown, project create, and check. MCP tools spawn these
8
+ truth** for init, config, deploy, status, teardown, project create, and check. MCP tools spawn these
9
9
  same commands so agents and humans get identical behavior.
10
10
 
11
11
  ## Lifecycle (prefer these)
@@ -14,11 +14,11 @@ same commands so agents and humans get identical behavior.
14
14
  | ------------------------ | -------------------------------------------------------------- |
15
15
  | `init` | Scaffold portal (create-apitogo + OpenAPI discovery + secrets) |
16
16
  | `config` / `make-config` | Write or update `apitogo.config.json` (interactive or flags) |
17
- | `dev` | Local preview server |
17
+ | `run` / `dev` | Local preview server |
18
18
  | `build` | Production build (`--preview` to serve locally) |
19
19
  | `check` | Publish readiness (secrets, manifest, site validation) |
20
20
  | `project create` | Create a platform project (plan unselected) |
21
- | `apply` | Publish config to platform (apihub + portal) |
21
+ | `deploy` / `apply` | Publish config to platform (apihub + portal) |
22
22
  | `status` | Account, project, and live readiness |
23
23
  | `teardown --yes` | Delete the linked platform project |
24
24
 
@@ -39,7 +39,8 @@ See [Make config (CLI)](../configuration/make-config.mdx) for all `config` flags
39
39
 
40
40
  | Command | Role |
41
41
  | ----------------- | ------------------------------------------------- |
42
- | `dev` | Run Vite dev server (`--port`, `--open`, `--ssr`) |
42
+ | `run` | Run the local portal server (`--port`, `--open`, `--ssr`) |
43
+ | `dev` | Alias for `run` |
43
44
  | `build` | Production static build |
44
45
  | `build --preview` | Build then serve locally |
45
46
 
@@ -49,11 +50,12 @@ See [Make config (CLI)](../configuration/make-config.mdx) for all `config` flags
49
50
  | ------------------------- | -------------------------------------------------------------- |
50
51
  | `project create --name` | Create platform project only |
51
52
  | `check` | Dry-run publish readiness |
52
- | `apply` | Full publish — project, plans, apihub, portal backend/frontend |
53
- | `apply --only <resource>` | Limit to `apihub`, `portal-backend`, or `portal-frontend` |
54
- | `apply --force` | Redeploy selected resources even when healthy |
55
- | `apply --platform-plan` | Select Free / Starter / Professional hosting |
56
- | `apply --resume-from` | Resume interrupted publish |
53
+ | `deploy` | Full publish — project, plans, apihub, portal backend/frontend |
54
+ | `deploy --only <resource>` | Limit to `apihub`, `portal-backend`, or `portal-frontend` |
55
+ | `deploy --force` | Redeploy selected resources even when healthy |
56
+ | `deploy --platform-plan` | Select Free / Starter / Professional hosting |
57
+ | `deploy --resume-from` | Resume interrupted publish |
58
+ | `apply` | Alias for `deploy` |
57
59
  | `status` | Whoami + project + live verification |
58
60
  | `teardown --yes` | Delete platform project (confirmation required) |
59
61
 
@@ -74,10 +76,9 @@ These print a redirect message — use the replacement:
74
76
 
75
77
  | Removed | Use instead |
76
78
  | --------------------------- | ----------------------------------------------------- |
77
- | `deploy` | `apitogo apply` (optionally `--only portal-frontend`) |
78
- | `preview` | `apitogo build --preview` or `apitogo dev` |
79
+ | `preview` | `apitogo build --preview` or `apitogo run` |
79
80
  | `remove` | `apitogo teardown --yes` |
80
- | `configure-github-workflow` | `apitogo apply` |
81
+ | `configure-github-workflow` | `apitogo deploy` |
81
82
 
82
83
  ## Related
83
84
 
package/docs/cli/go-live.md CHANGED
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: Go live with CLI
3
3
  description:
4
- Publish an APIToGo developer portal with apitogo apply — platform plans, secrets, and status.
4
+ Publish an APIToGo developer portal with apitogo deploy — platform plans, secrets, and status.
5
5
  sidebar_icon: rocket
6
6
  ---
7
7
 
8
8
  **Go live** publishes your shaped portal to APItoGo hosting, optionally deploys the backend, upserts
9
- gateway plans, and verifies the live site. `apitogo apply` is the source of truth; MCP
9
+ gateway plans, and verifies the live site. `apitogo deploy` is the source of truth; MCP
10
10
  `publish_dev_portal` spawns the same CLI.
11
11
 
12
12
  ## Before you publish
@@ -40,33 +40,33 @@ gateway plans, and verifies the live site. `apitogo apply` is the source of trut
40
40
 
41
41
  ```bash
42
42
  cd ./dev-portal
43
- apitogo apply --platform-plan free
43
+ apitogo deploy --platform-plan free
44
44
  apitogo status
45
45
  ```
46
46
 
47
- `apitogo apply`:
47
+ `apitogo deploy`:
48
48
 
49
49
  - Creates or links the platform project
50
50
  - Provisions modules and syncs gateway plans
51
51
  - Deploys the API hub (when configured)
52
52
  - Updates the portal backend (including auth API URL in `.env`) and builds + deploys the portal frontend
53
53
 
54
- If apply is blocked, fix the reported checklist (missing secrets, plan, OpenAPI). Do not invent
54
+ If deploy is blocked, fix the reported checklist (missing secrets, plan, OpenAPI). Do not invent
55
55
  credentials.
56
56
 
57
57
  After success, register **`manualSteps.oidcRedirectUri`** in your IdP. When Stripe is required for
58
58
  paid gateway plans, create a webhook at `manualSteps.stripeWebhookUrl` for the listed events.
59
59
 
60
- Do not treat warm-pool URLs as live until apply and status succeed.
60
+ Do not treat warm-pool URLs as live until deploy and status succeed.
61
61
 
62
62
  ## Target specific resources
63
63
 
64
64
  ```bash
65
- apitogo apply --only apihub
66
- apitogo apply --only portal-backend
67
- apitogo apply --only portal-frontend
68
- apitogo apply --only apihub,portal-frontend
69
- apitogo apply --only portal-frontend --force
65
+ apitogo deploy --only apihub
66
+ apitogo deploy --only portal-backend
67
+ apitogo deploy --only portal-frontend
68
+ apitogo deploy --only apihub,portal-frontend
69
+ apitogo deploy --only portal-frontend --force
70
70
  ```
71
71
 
72
72
  | Resource | What it updates |
@@ -77,7 +77,7 @@ apitogo apply --only portal-frontend --force
77
77
 
78
78
  Omit `--only` to apply all three. Use `--force` to redeploy even when hashes match.
79
79
 
80
- ## Other apply flags
80
+ ## Other deploy flags
81
81
 
82
82
  | Flag | Purpose |
83
83
  | ---- | ------- |
@@ -105,11 +105,11 @@ apitogo teardown --yes # delete the platform project
105
105
  | Platform hosting | Free / Starter / Professional on APItoGo | `--platform-plan` |
106
106
  | Gateway / API | End-user SKUs and rate limits on `/pricing` | `apitogo.config.json` — [Gateway plans](../configuration/plans.md) |
107
107
 
108
- ## CLI apply vs MCP publish
108
+ ## CLI deploy vs MCP publish
109
109
 
110
110
  | Path | Use when |
111
111
  | ----------------------- | -------------------------------------------------- |
112
- | `apitogo apply` | Terminal, CI, scripts — full product go-live |
112
+ | `apitogo deploy` | Terminal, CI, scripts — full product go-live |
113
113
  | MCP `publish_dev_portal` | Agent-driven go-live with the same engine |
114
114
 
115
115
  ## Related
package/docs/cli/overview.md CHANGED
@@ -6,7 +6,7 @@ sidebar_icon: terminal
6
6
  ---
7
7
 
8
8
  The **`apitogo`** CLI lets you manage developer portals from the terminal. You scaffold and shape
9
- local files, preview with `apitogo dev`, and publish to APItoGo hosting with `apitogo apply`.
9
+ local files, preview with `apitogo run`, and publish to APItoGo hosting with `apitogo deploy`.
10
10
 
11
11
  **First time?** Install and wire credentials → **[Install the CLI](./setup.md)**. Then follow
12
12
  [Shape](./shape.md) and [Go live](./go-live.md).
@@ -15,8 +15,8 @@ local files, preview with `apitogo dev`, and publish to APItoGo hosting with `ap
15
15
 
16
16
  - Scaffold a local portal site (`npx @lukoweb/create-apitogo@latest` or `apitogo init`)
17
17
  - Shape backend, OpenAPI, plans, and docs pages via `apitogo config` and file edits
18
- - Preview locally (`apitogo dev`)
19
- - Publish to APItoGo hosting (`apitogo apply`) with platform plans **Free**, **Starter**, or
18
+ - Preview locally (`apitogo run`)
19
+ - Publish to APItoGo hosting (`apitogo deploy`) with platform plans **Free**, **Starter**, or
20
20
  **Professional**
21
21
  - Check live status (`apitogo status`) and tear down (`apitogo teardown --yes`)
22
22
 
@@ -68,15 +68,15 @@ Details: [Manifest](../configuration/manifest.md).
68
68
 
69
69
  ## CLI vs MCP
70
70
 
71
- Both paths use the same config-first model. `apitogo apply` runs the same engine as MCP
71
+ Both paths use the same config-first model. `apitogo deploy` runs the same engine as MCP
72
72
  `publish_dev_portal`.
73
73
 
74
74
  | Task | CLI | MCP (agent) |
75
75
  | ----------------- | -------------------------------- | ------------------------------ |
76
76
  | Scaffold | `npm create` / `apitogo init` | `create_dev_portal` |
77
77
  | Shape config | `apitogo config` + file edits | `apply_product_intent` (shape) |
78
- | Preview | `apitogo dev` | `npm run dev` / preview tool |
79
- | Publish | `apitogo apply` | `publish_dev_portal` |
78
+ | Preview | `apitogo run` | `npm run dev` / preview tool |
79
+ | Publish | `apitogo deploy` | `publish_dev_portal` |
80
80
  | Status / teardown | `apitogo status` / `teardown` | `verify_dev_portal_live` / `teardown_project` |
81
81
 
82
82
  Prefer MCP when an agent should drive changes. Prefer CLI for CI, scripts, or terminal-only
package/docs/cli/setup.md CHANGED
@@ -6,13 +6,13 @@ sidebar_icon: terminal
6
6
  ---
7
7
 
8
8
  Use the **`apitogo`** CLI (`@lukoweb/apitogo`) to scaffold a local portal, shape
9
- `apitogo.config.json`, preview with `apitogo dev`, and publish with `apitogo apply`. Platform
10
- commands (`apply`, `status`, `teardown`) use the same engine as MCP `publish_dev_portal`.
9
+ `apitogo.config.json`, preview with `apitogo run`, and publish with `apitogo deploy`. Platform
10
+ commands (`deploy`, `status`, `teardown`) use the same engine as MCP `publish_dev_portal`.
11
11
 
12
12
  ## Prerequisites
13
13
 
14
14
  - **Node.js 20+**
15
- - Platform API credentials from [apitogo.com](https://apitogo.com) when you run `apitogo apply` (API
15
+ - Platform API credentials from [apitogo.com](https://apitogo.com) when you run `apitogo deploy` (API
16
16
  key id + secret)
17
17
 
18
18
  ## Install
@@ -88,7 +88,7 @@ npm run dev
88
88
  ```
89
89
 
90
90
  `apitogo init` is local only — it does not call the platform. After `config`, run `npm run dev` to
91
- preview, then `apitogo apply` when ready to go live.
91
+ preview, then `apitogo deploy` when ready to go live.
92
92
 
93
93
  ### How to run `apitogo`
94
94
 
@@ -104,7 +104,7 @@ install required.
104
104
 
105
105
  ## Platform credentials
106
106
 
107
- Export these before `apitogo apply`, `apitogo status`, or `apitogo teardown`:
107
+ Export these before `apitogo deploy`, `apitogo status`, or `apitogo teardown`:
108
108
 
109
109
  | Variable | Required | Purpose |
110
110
  | -------------------- | -------- | ----------------- |
@@ -127,7 +127,7 @@ Never commit secrets. Site auth secrets (OIDC, Stripe) belong in the portal **`.
127
127
  npx apitogo --help
128
128
  ```
129
129
 
130
- You should see `init`, `config`, `dev`, `build`, `apply`, `status`, and `teardown`.
130
+ You should see `init`, `config`, `run`, `build`, `deploy`, `status`, and `teardown`.
131
131
 
132
132
  With credentials set:
133
133
 
@@ -139,5 +139,5 @@ apitogo status
139
139
 
140
140
  - [CLI overview](./overview.md)
141
141
  - [Shape](./shape.md) — scaffold and local preview
142
- - [Go live](./go-live.md) — `apitogo apply`
142
+ - [Go live](./go-live.md) — `apitogo deploy`
143
143
  - [Commands](./commands.md) — full catalog
package/docs/cli/shape.md CHANGED
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: Shape with CLI
3
3
  description:
4
- Scaffold and customize a developer portal locally with apitogo init, apitogo config, and apitogo dev.
4
+ Scaffold and customize a developer portal locally with apitogo init, apitogo config, and apitogo run.
5
5
  sidebar_icon: pencil-ruler
6
6
  ---
7
7
 
8
8
  **Shape** means: create or update a local portal site (OpenAPI, plans, docs pages, auth)
9
- without publishing. You preview with `apitogo dev` or `npm run dev`.
9
+ without publishing. You preview with `apitogo run` or `npm run dev`.
10
10
 
11
11
  Requires the **`apitogo`** CLI (`@lukoweb/apitogo`). If you have not installed it yet, see
12
12
  [Install the CLI](./setup.md).
@@ -32,7 +32,7 @@ npx apitogo config
32
32
  npm run dev
33
33
  ```
34
34
 
35
- `apitogo init` does **not** call the platform. Run `apitogo apply` when you are ready to go live.
35
+ `apitogo init` does **not** call the platform. Run `apitogo deploy` when you are ready to go live.
36
36
 
37
37
  ## Interactive config (`apitogo config`)
38
38
 
@@ -46,7 +46,7 @@ continues until you type `done`:
46
46
  | `page` | Create `pages/<slug>.tsx` and wire it in navigation |
47
47
  | `plan` | Add a gateway plan (title, price, rate limit, monthly quota) |
48
48
 
49
- Authentication is **on by default** — the wizard does not ask for an auth API URL. `apitogo apply`
49
+ Authentication is **on by default** — the wizard does not ask for an auth API URL. `apitogo deploy`
50
50
  fills `VITE_APITOGO_AUTHENTICATION_API_BASE_URL` after the portal backend exists.
51
51
 
52
52
  Fonts and colors are **not** prompted — edit `apitogo.config.json` or see
@@ -94,8 +94,8 @@ Never put OIDC or Stripe secrets in `apitogo.config.json`. Use `.env` with
94
94
  ## Preview locally
95
95
 
96
96
  ```bash
97
- apitogo dev
98
- apitogo dev --port 4000 --open
97
+ apitogo run
98
+ apitogo run --port 4000 --open
99
99
  ```
100
100
 
101
101
  Production build check:
@@ -120,4 +120,4 @@ npm run dev
120
120
 
121
121
  ## Next
122
122
 
123
- When the site looks right, [go live](./go-live.md) with `apitogo apply`.
123
+ When the site looks right, [go live](./go-live.md) with `apitogo deploy`.
package/docs/configuration/authentication.md CHANGED
@@ -24,7 +24,7 @@ Set authentication in `apitogo.config.json` (enabled by default on new scaffolds
24
24
  }
25
25
  ```
26
26
 
27
- Backend API URL (`apitogo apply` writes this to `.env` after the portal backend is provisioned):
27
+ Backend API URL (`apitogo deploy` writes this to `.env` after the portal backend is provisioned):
28
28
 
29
29
  ```bash
30
30
  VITE_APITOGO_AUTHENTICATION_API_BASE_URL=https://your-dev-portal-api.example.com
package/docs/configuration/make-config.mdx CHANGED
@@ -68,7 +68,7 @@ npx apitogo config
68
68
  2. **Wrap-up** — links to [docs.apitogo.com](https://docs.apitogo.com) for further configuration
69
69
 
70
70
  The wizard does **not** ask for fonts, colors, logo alt text, or the auth API base URL. Authentication
71
- stays **enabled**; `apitogo apply` writes `VITE_APITOGO_AUTHENTICATION_API_BASE_URL` to `.env` after
71
+ stays **enabled**; `apitogo deploy` writes `VITE_APITOGO_AUTHENTICATION_API_BASE_URL` to `.env` after
72
72
  the portal backend is provisioned.
73
73
 
74
74
  If you add a **paid** plan (`priceAmount > 0`), the CLI warns that **Free platform hosting cannot
package/docs/configuration/manifest.md CHANGED
@@ -96,7 +96,7 @@ when tenant apps or local frontends call the gateway:
96
96
  | Wildcard | `"*"` is allowed (replaces the list; credentials stay off). |
97
97
  | Empty / omitted | Portal playground still works; only extras are missing. |
98
98
 
99
- Apply with `apitogo apply` / `publish_dev_portal` so APIM policies pick up the change.
99
+ Apply with `apitogo deploy` / `publish_dev_portal` so APIM policies pick up the change.
100
100
 
101
101
  ## Environment variables
102
102
 
package/docs/configuration/plans.md CHANGED
@@ -12,7 +12,7 @@ description:
12
12
  - **`/account/plans`** — authenticated billing. Sign-in required. Manage and change subscriptions.
13
13
 
14
14
  They are separate from **platform hosting** (Free / Starter / Professional on APItoGo), which you
15
- select with `apitogo apply --platform-plan`.
15
+ select with `apitogo deploy --platform-plan`.
16
16
 
17
17
  Store the catalog under `modules.userPanel.plans.items` in `apitogo.config.json`.
18
18
 
@@ -92,17 +92,17 @@ After OpenAPI is deployed, you can scope a plan to specific operations with
92
92
  Gateway plans are applied when you run:
93
93
 
94
94
  ```bash
95
- apitogo apply
95
+ apitogo deploy
96
96
  ```
97
97
 
98
- `apitogo apply` syncs plans from the manifest to the platform gateway. Paid plans require Stripe
98
+ `apitogo deploy` syncs plans from the manifest to the platform gateway. Paid plans require Stripe
99
99
  secrets in `.env` before publish — see [Go live with CLI](../cli/go-live.md).
100
100
 
101
101
  ## Platform hosting vs gateway plans
102
102
 
103
103
  | Kind | What it is | How |
104
104
  | ---- | ---------- | --- |
105
- | **Platform hosting** | APItoGo bill for hosting your portal + API hub | `apitogo apply --platform-plan` |
105
+ | **Platform hosting** | APItoGo bill for hosting your portal + API hub | `apitogo deploy --platform-plan` |
106
106
  | **Gateway / API plans** | What your customers pay for API access | `modules.userPanel.plans.items` |
107
107
 
108
108
  ### Free platform limitations
@@ -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 `apitogo apply --platform-plan free`, apply is blocked until you
116
+ manifest has paid plans and you try `apitogo deploy --platform-plan free`, apply is blocked until you
117
117
  upgrade or zero/remove those paid plans.
118
118
 
119
119
  ## Related
package/docs/deploy/apitogo.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Deploy with APIToGo CLI
2
2
 
3
- Platform publish is **`apitogo apply`** — the same engine as MCP `publish_dev_portal`.
3
+ Platform publish is **`apitogo deploy`** — the same engine as MCP `publish_dev_portal`.
4
4
 
5
5
  Full walkthrough (prerequisites, secrets, `--only`, status, teardown):
6
6
 
@@ -12,6 +12,6 @@ Quick reference:
12
12
  export APITOGO_API_KEY_ID=apk_...
13
13
  export APITOGO_API_SECRET=...
14
14
  cd ./dev-portal
15
- apitogo apply --platform-plan free
15
+ apitogo deploy --platform-plan free
16
16
  apitogo status
17
17
  ```
package/docs/deployment.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  | Path | Docs |
4
4
  | --- | --- |
5
- | **CLI** (`apitogo apply`) | [Go live with CLI](./cli/go-live.md) |
5
+ | **CLI** (`apitogo deploy`) | [Go live with CLI](./cli/go-live.md) |
6
6
  | **MCP / agents** | [Go live](./mcp/go-live.md) |
7
7
 
8
- Local-only builds: `apitogo build` (optional `--preview`). Platform publish is always `apitogo apply`.
8
+ Local-only builds: `apitogo build` (optional `--preview`). Platform publish is always `apitogo deploy`.
package/docs/guides/environment-variables.md CHANGED
@@ -21,7 +21,7 @@ APIToGo uses Vite’s [env and mode](https://vite.dev/guide/env-and-mode) model,
21
21
  Nested overrides use `__` path segments (SCREAMING_SNAKE). See [Manifest](../configuration/manifest.md).
22
22
 
23
23
  **Never commit** OIDC client secrets or Stripe keys. MCP never puts secrets in chat — you write them
24
- to `.env` before [go-live](../mcp/go-live.md) or `apitogo apply` ([CLI go-live](../cli/go-live.md)).
24
+ to `.env` before [go-live](../mcp/go-live.md) or `apitogo deploy` ([CLI go-live](../cli/go-live.md)).
25
25
 
26
26
  Example:
27
27
 
package/docs/markdown/frontmatter.md CHANGED
@@ -122,7 +122,7 @@ draft: true
122
122
 
123
123
  When `draft: true` is set:
124
124
 
125
- - The document will be visible when running `apitogo dev`
125
+ - The document will be visible when running `apitogo run`
126
126
  - The document will be excluded from builds created with `apitogo build`
127
127
  - The document won't appear in the navigation or be accessible via URL in production
128
128
 
package/docs/mcp/go-live.md CHANGED
@@ -88,7 +88,7 @@ shape → deploy_backend → publish_dev_portal(skipBackendRedeploy: true)
88
88
  | Path | Use when |
89
89
  | ---------------------------- | ----------------------------------------------------- |
90
90
  | MCP `publish_dev_portal` | Full product go-live (plans, auth, hosting, verify) |
91
- | CLI `apitogo apply` | Publish config to platform (apihub + portal) |
91
+ | CLI `apitogo deploy` | Publish config to platform (apihub + portal) |
92
92
 
93
93
  See [Go live with CLI](../cli/go-live.md).
94
94
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lukoweb/apitogo",
3
- "version": "0.1.100",
3
+ "version": "0.1.101",
4
4
  "type": "module",
5
5
  "sideEffects": [
6
6
  "**/*.css",