@dbx-tools/cli 0.6.86 → 0.6.88
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 +26 -8
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
# @dbx-tools/cli
|
|
2
2
|
|
|
3
|
-
The single `dbx` CLI: workspace lifecycle, Model Serving proxy,
|
|
3
|
+
The single `dbx` CLI: workspace lifecycle, Model Serving proxy, AppKit env, and
|
|
4
|
+
a gated public tunnel.
|
|
4
5
|
|
|
5
|
-
This package installs one command, `dbx` (aliased `dbx-tools`), with
|
|
6
|
+
This package installs one command, `dbx` (aliased `dbx-tools`), with four
|
|
6
7
|
groups:
|
|
7
8
|
|
|
8
9
|
| Command | What it does |
|
|
@@ -10,6 +11,7 @@ groups:
|
|
|
10
11
|
| `dbx dev` | Bootstrap or repair a dbx-tools workspace, then forward to projen. |
|
|
11
12
|
| `dbx model-proxy` | Local OpenAI-compatible proxy in front of Databricks Model Serving. |
|
|
12
13
|
| `dbx appkit env` | Print the environment an AppKit app resolves, as eval-able shell output. |
|
|
14
|
+
| `dbx tunnel` | Front any command with a public portr tunnel and an email-OTP gate. |
|
|
13
15
|
|
|
14
16
|
Key features:
|
|
15
17
|
|
|
@@ -24,12 +26,13 @@ Key features:
|
|
|
24
26
|
when the effective registry is not npmjs.
|
|
25
27
|
- Importable CLI/root/bun helpers for tests and thin wrapper commands.
|
|
26
28
|
|
|
27
|
-
|
|
28
|
-
[`@dbx-tools/cli-model-proxy`](../model-proxy)
|
|
29
|
-
[`@dbx-tools/cli-appkit-env`](../appkit-env) and
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
29
|
+
Every feature group lives in its own package -
|
|
30
|
+
[`@dbx-tools/cli-model-proxy`](../model-proxy),
|
|
31
|
+
[`@dbx-tools/cli-appkit-env`](../appkit-env), and
|
|
32
|
+
[`@dbx-tools/cli-tunnel`](../tunnel) - and is imported LAZILY, only once its name
|
|
33
|
+
is matched, so `dbx dev` never pays to load the Databricks SDK, AppKit, or the
|
|
34
|
+
SMTP stack. Run `dbx <group> --help` for a group's own flags; each forwards
|
|
35
|
+
`--help` to the child program rather than answering it at the root.
|
|
33
36
|
|
|
34
37
|
## Bootstrap A Workspace
|
|
35
38
|
|
|
@@ -82,6 +85,21 @@ See [`@dbx-tools/cli-model-proxy`](../model-proxy) and
|
|
|
82
85
|
[`@dbx-tools/cli-appkit-env`](../appkit-env) for the full flag surface, auth
|
|
83
86
|
resolution, and output formats.
|
|
84
87
|
|
|
88
|
+
## Put A Gated Public URL In Front Of A Command
|
|
89
|
+
|
|
90
|
+
```sh
|
|
91
|
+
dbx tunnel status --allow databricks.com # what would happen, nothing started
|
|
92
|
+
dbx tunnel --allow databricks.com -- bun src/server.ts
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
`dbx tunnel` claims the public port, moves the wrapped command to a private
|
|
96
|
+
loopback port, and reverse-proxies between them so an email one-time-code gate
|
|
97
|
+
sits in front of traffic the command never has to know about. The command does
|
|
98
|
+
not have to be a Node server - anything that honors `PORT` /
|
|
99
|
+
`DATABRICKS_APP_PORT` works. An AppKit app should prefer the in-process plugin
|
|
100
|
+
path instead; see [`@dbx-tools/cli-tunnel`](../tunnel) for that comparison, the
|
|
101
|
+
full flag table, and the request flow.
|
|
102
|
+
|
|
85
103
|
## Use The CLI Internals
|
|
86
104
|
|
|
87
105
|
```ts
|
package/package.json
CHANGED
|
@@ -28,11 +28,11 @@
|
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"@clack/prompts": "^1.7.0",
|
|
31
|
-
"@dbx-tools/cli-appkit-env": "0.6.
|
|
32
|
-
"@dbx-tools/cli-model-proxy": "0.6.
|
|
33
|
-
"@dbx-tools/cli-tunnel": "0.6.
|
|
34
|
-
"@dbx-tools/core": "0.6.
|
|
35
|
-
"@dbx-tools/shared-core": "0.6.
|
|
31
|
+
"@dbx-tools/cli-appkit-env": "0.6.88",
|
|
32
|
+
"@dbx-tools/cli-model-proxy": "0.6.88",
|
|
33
|
+
"@dbx-tools/cli-tunnel": "0.6.88",
|
|
34
|
+
"@dbx-tools/core": "0.6.88",
|
|
35
|
+
"@dbx-tools/shared-core": "0.6.88",
|
|
36
36
|
"commander": "^15.0.0"
|
|
37
37
|
},
|
|
38
38
|
"main": "./lib/index.js",
|
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
"./package.json": "./package.json"
|
|
70
70
|
}
|
|
71
71
|
},
|
|
72
|
-
"version": "0.6.
|
|
72
|
+
"version": "0.6.88",
|
|
73
73
|
"types": "./lib/index.d.ts",
|
|
74
74
|
"type": "module",
|
|
75
75
|
"exports": {
|