@polardbx/pxbaas 0.1.0-beta.7 → 0.1.0-beta.8
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
CHANGED
|
@@ -39,6 +39,18 @@ pxbaas doctor # connectivity / configuration diagnostics
|
|
|
39
39
|
pxbaas status # instance reachability summary
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
+
## For coding agents (start here)
|
|
43
|
+
|
|
44
|
+
Run `pxbaas guide` first: it prints the recommended end-to-end workflow for
|
|
45
|
+
developing, deploying, verifying and sharing an app — instance binding,
|
|
46
|
+
capability checks, scoped approvals, stage-by-stage failure recovery, and
|
|
47
|
+
network/whitelist handling — without needing credentials or network access.
|
|
48
|
+
Then install the bundled skills (`pxbaas skill install --host
|
|
49
|
+
<qoder|claude|cursor|qwen|hermes>`, or `--dir <path>` for other agent hosts)
|
|
50
|
+
and follow `pxbaas-cli` / `pxbaas-app-spec`. `pxbaas login` needs a human TTY;
|
|
51
|
+
agents should bind instances with `pxbaas profile import <env-file>` or, with
|
|
52
|
+
user approval, `pxbaas provision`.
|
|
53
|
+
|
|
42
54
|
Every command accepts `--json` for machine-readable output, and `--profile <name>` to select a profile per invocation (`pxbaas profile ls / use / rm / import` manage them).
|
|
43
55
|
|
|
44
56
|
### Non-interactive credential setup
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@polardbx/pxbaas",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.8",
|
|
4
4
|
"description": "PolarDB-X BaaS CLI application",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"polardbx",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"inquirer": "^9.2.0",
|
|
36
36
|
"jsonwebtoken": "^9.0.0",
|
|
37
37
|
"keytar": "^7.9.0",
|
|
38
|
-
"@polardbx/pxbaas-client": "0.1.0-beta.
|
|
38
|
+
"@polardbx/pxbaas-client": "0.1.0-beta.8"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@types/inquirer": "^9.0.0",
|
|
@@ -62,6 +62,7 @@ All requests go through a single Kong gateway (port **8000**). Key path prefixes
|
|
|
62
62
|
Run these (all read-only) to establish state before doing anything else:
|
|
63
63
|
|
|
64
64
|
```bash
|
|
65
|
+
pxbaas guide # 0. printable end-to-end develop/deploy/verify/share workflow (no auth needed)
|
|
65
66
|
pxbaas status --json # 1. capability URLs; confirm endpoint and availability
|
|
66
67
|
pxbaas doctor --json # 2. health: connectivity, JWT validity, expiry, tenant status
|
|
67
68
|
pxbaas whoami --json # 3. current profile / tenant / role / key fingerprints
|
|
@@ -109,6 +110,7 @@ Legend — **R** = read/safe · **W** = write · **D** = destructive (consent re
|
|
|
109
110
|
| `auth users delete <userId>` | service_role | **D** | auth-and-credentials.md |
|
|
110
111
|
| `auth users invite <email>` | service_role | W | auth-and-credentials.md |
|
|
111
112
|
| `completion <shell>` | — | R (local) | (this file) |
|
|
113
|
+
| `guide` | — | R (local, no auth) | (this file) |
|
|
112
114
|
| `tenant login` / `tenant logout` | dashboard Basic | W (local) | tenant-admin.md |
|
|
113
115
|
| `tenant probe` / `tenant ls` / `tenant handoffs` | dashboard Basic | R | tenant-admin.md |
|
|
114
116
|
| `tenant create [id]` | dashboard Basic | **D/W** (provisions db, account, GRANT, bucket, quota) | tenant-admin.md |
|
|
@@ -132,6 +134,7 @@ For provisioning / multi-instance selection see **provision.md**; for the `pxbaa
|
|
|
132
134
|
## Natural language → command
|
|
133
135
|
|
|
134
136
|
```
|
|
137
|
+
"how do I develop and deploy an app" → pxbaas guide (follow it; the bundled skills carry the details)
|
|
135
138
|
"show the schema of todos" → pxbaas db schema todos --json
|
|
136
139
|
"what tables are there" → pxbaas db tables --json
|
|
137
140
|
"count the users" → pxbaas db query "SELECT count(*) FROM users" --json
|
|
@@ -6,6 +6,8 @@ Covers: `app new` · `app capabilities` · `app deploy` · `app publish` · `app
|
|
|
6
6
|
|
|
7
7
|
> **How to WRITE the webapp code** (runtime contract, frontend/backend guardrails, templates, and deploy paths) lives in the dedicated **`pxbaas-app-spec` skill**. This page is only the `pxbaas app` command surface.
|
|
8
8
|
|
|
9
|
+
> **End-to-end workflow** (instance binding, scoped approvals, stage-by-stage recovery, network/whitelist handling) lives in **`pxbaas guide`**; run it first and follow it. This page covers only the `pxbaas app` command surface.
|
|
10
|
+
|
|
9
11
|
## URL models
|
|
10
12
|
|
|
11
13
|
Legacy modes keep the Edge Function URL:
|