@dbx-tools/cli 0.9.58 → 0.9.61
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 +594 -57
- package/bin/dbx-genie.ts +13 -0
- package/bin/dbx-graphiti.ts +5 -0
- package/bin/dbx-lakebase-proxy.ts +4 -0
- package/bin/dbx-model-gateway.ts +5 -0
- package/index.ts +47 -1
- package/lib/bin/dbx-genie.d.ts +2 -0
- package/lib/bin/dbx-genie.js +10 -0
- package/lib/bin/dbx-graphiti.d.ts +2 -0
- package/lib/bin/dbx-graphiti.js +4 -0
- package/lib/bin/dbx-lakebase-proxy.d.ts +2 -0
- package/lib/bin/dbx-lakebase-proxy.js +4 -0
- package/lib/bin/dbx-model-gateway.d.ts +2 -0
- package/lib/bin/dbx-model-gateway.js +4 -0
- package/lib/index.d.ts +47 -1
- package/lib/index.js +34 -2
- package/lib/src/appkit/cli.d.ts +24 -0
- package/lib/src/appkit/cli.js +54 -0
- package/lib/src/appkit/env-export.d.ts +40 -0
- package/lib/src/appkit/env-export.js +99 -0
- package/lib/src/auth/cli.d.ts +20 -0
- package/lib/src/auth/cli.js +129 -0
- package/lib/src/auth/options.d.ts +45 -0
- package/lib/src/auth/options.js +68 -0
- package/lib/src/cli.d.ts +2 -0
- package/lib/src/cli.js +19 -9
- package/lib/src/genie-code/cli.d.ts +19 -0
- package/lib/src/genie-code/cli.js +36 -0
- package/lib/src/genie-code/config.d.ts +38 -0
- package/lib/src/genie-code/config.js +111 -0
- package/lib/src/genie-code/install.d.ts +21 -0
- package/lib/src/genie-code/install.js +69 -0
- package/lib/src/genie-code/options.d.ts +7 -0
- package/lib/src/genie-code/options.js +7 -0
- package/lib/src/genie-code/runner.d.ts +21 -0
- package/lib/src/genie-code/runner.js +90 -0
- package/lib/src/genie-code/runtime.d.ts +48 -0
- package/lib/src/genie-code/runtime.js +162 -0
- package/lib/src/graphiti/cli.d.ts +18 -0
- package/lib/src/graphiti/cli.js +43 -0
- package/lib/src/graphiti/options.d.ts +10 -0
- package/lib/src/graphiti/options.js +10 -0
- package/lib/src/lakebase-proxy/cancellation.d.ts +22 -0
- package/lib/src/lakebase-proxy/cancellation.js +100 -0
- package/lib/src/lakebase-proxy/cli.d.ts +13 -0
- package/lib/src/lakebase-proxy/cli.js +54 -0
- package/lib/src/lakebase-proxy/options.d.ts +23 -0
- package/lib/src/lakebase-proxy/options.js +41 -0
- package/lib/src/lakebase-proxy/protocol.d.ts +37 -0
- package/lib/src/lakebase-proxy/protocol.js +124 -0
- package/lib/src/lakebase-proxy/proxy.d.ts +22 -0
- package/lib/src/lakebase-proxy/proxy.js +200 -0
- package/lib/src/model-gateway/cli.d.ts +19 -0
- package/lib/src/model-gateway/cli.js +63 -0
- package/lib/src/model-gateway/server.d.ts +16 -0
- package/lib/src/model-gateway/server.js +83 -0
- package/lib/src/tunnel/app.d.ts +20 -0
- package/lib/src/tunnel/app.js +52 -0
- package/lib/src/tunnel/cli.d.ts +27 -0
- package/lib/src/tunnel/cli.js +190 -0
- package/lib/src/tunnel/options.d.ts +72 -0
- package/lib/src/tunnel/options.js +138 -0
- package/lib/src/tunnel/proxy.d.ts +51 -0
- package/lib/src/tunnel/proxy.js +143 -0
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +146 -9
- package/src/appkit/cli.ts +72 -0
- package/src/appkit/env-export.ts +124 -0
- package/src/auth/cli.ts +175 -0
- package/src/auth/options.ts +83 -0
- package/src/cli.ts +35 -8
- package/src/genie-code/cli.ts +58 -0
- package/src/genie-code/config.ts +161 -0
- package/src/genie-code/install.ts +103 -0
- package/src/genie-code/options.ts +14 -0
- package/src/genie-code/runner.ts +106 -0
- package/src/genie-code/runtime.ts +212 -0
- package/src/graphiti/cli.ts +75 -0
- package/src/graphiti/options.ts +20 -0
- package/src/lakebase-proxy/cancellation.ts +116 -0
- package/src/lakebase-proxy/cli.ts +80 -0
- package/src/lakebase-proxy/options.ts +56 -0
- package/src/lakebase-proxy/protocol.ts +170 -0
- package/src/lakebase-proxy/proxy.ts +256 -0
- package/src/model-gateway/cli.ts +93 -0
- package/src/model-gateway/server.ts +94 -0
- package/src/tunnel/app.ts +58 -0
- package/src/tunnel/cli.ts +218 -0
- package/src/tunnel/options.ts +169 -0
- package/src/tunnel/proxy.ts +194 -0
package/README.md
CHANGED
|
@@ -21,9 +21,22 @@ workspace commands; the examples use `MY-PROFILE` as a placeholder.
|
|
|
21
21
|
dbx model-gateway --profile MY-PROFILE --port 4000
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Point an OpenAI-compatible client at `http://127.0.0.1:4000/v1`.
|
|
25
|
-
|
|
26
|
-
|
|
24
|
+
Point an OpenAI-compatible client at `http://127.0.0.1:4000/v1`. The generated
|
|
25
|
+
command reference includes all gateway and desktop-service options.
|
|
26
|
+
|
|
27
|
+
## Run Genie Code
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
dbx genie --profile MY-PROFILE --model gpt
|
|
31
|
+
# Equivalent installed binary:
|
|
32
|
+
dbx-genie --profile MY-PROFILE --model gpt
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The command installs the pinned Genie Code package under `~/.dbx-tools`, writes
|
|
36
|
+
one persistent home per exact profile-model pairing, and supervises an
|
|
37
|
+
authenticated loopback model gateway. Unknown flags and extra arguments are
|
|
38
|
+
forwarded to Genie Code. Use `--` only when a wrapper option such as `--model`
|
|
39
|
+
must be sent to Genie instead.
|
|
27
40
|
|
|
28
41
|
## Connect To Lakebase
|
|
29
42
|
|
|
@@ -31,9 +44,8 @@ service commands.
|
|
|
31
44
|
dbx lakebase-proxy --profile MY-PROFILE --port 5432
|
|
32
45
|
```
|
|
33
46
|
|
|
34
|
-
Connect your PostgreSQL client to the loopback listener.
|
|
35
|
-
|
|
36
|
-
connection URLs, and service commands.
|
|
47
|
+
Connect your PostgreSQL client to the loopback listener. The command reference
|
|
48
|
+
includes target selection, connection URLs, and service commands.
|
|
37
49
|
|
|
38
50
|
## Add Memory Or Share An App
|
|
39
51
|
|
|
@@ -42,10 +54,8 @@ dbx graphiti --profile MY-PROFILE
|
|
|
42
54
|
dbx tunnel --allow example.com -- bun src/server.ts
|
|
43
55
|
```
|
|
44
56
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
to an existing process. Each guide includes setup requirements and a generated
|
|
48
|
-
command reference.
|
|
57
|
+
`graphiti` provides graph memory for agents. `tunnel` adds a public URL with
|
|
58
|
+
passwordless access to an existing process.
|
|
49
59
|
|
|
50
60
|
## Export AppKit Configuration
|
|
51
61
|
|
|
@@ -53,9 +63,8 @@ command reference.
|
|
|
53
63
|
eval "$(dbx appkit env --quiet)"
|
|
54
64
|
```
|
|
55
65
|
|
|
56
|
-
Use the resolved AppKit environment before starting another process.
|
|
57
|
-
|
|
58
|
-
output, and [authentication](../auth#command-reference) for token commands.
|
|
66
|
+
Use the resolved AppKit environment before starting another process. The AppKit
|
|
67
|
+
and authentication command groups below include JSON, Windows, and token options.
|
|
59
68
|
|
|
60
69
|
## Bootstrap A Workspace
|
|
61
70
|
|
|
@@ -76,8 +85,9 @@ bun run barrels
|
|
|
76
85
|
```
|
|
77
86
|
|
|
78
87
|
See [`@dbx-tools/projen`](../../../../projen) for workspace configuration and
|
|
79
|
-
generation.
|
|
80
|
-
|
|
88
|
+
generation. Command implementations are available from `@dbx-tools/cli/appkit`,
|
|
89
|
+
`/auth`, `/genie`, `/graphiti`, `/lakebase-proxy`, `/model-gateway`, and
|
|
90
|
+
`/tunnel` when a Node caller needs to embed one parser.
|
|
81
91
|
|
|
82
92
|
<!-- cli-reference:start -->
|
|
83
93
|
|
|
@@ -93,15 +103,16 @@ dbx [command]
|
|
|
93
103
|
|
|
94
104
|
#### Commands
|
|
95
105
|
|
|
96
|
-
| Command
|
|
97
|
-
|
|
|
98
|
-
| `dev [projenArgs...]`
|
|
99
|
-
| `appkit
|
|
100
|
-
| `auth [
|
|
101
|
-
| `tunnel [
|
|
102
|
-
| `lakebase-proxy [
|
|
103
|
-
| `model-gateway [
|
|
104
|
-
| `
|
|
106
|
+
| Command | Description |
|
|
107
|
+
| -------------------------------- | ----------------------------------------------------------------------- |
|
|
108
|
+
| `dev [projenArgs...]` | Bootstrap or repair a dbx-tools workspace, then forward to projen |
|
|
109
|
+
| `appkit` | AppKit helpers: resolve the environment an AppKit app would start with. |
|
|
110
|
+
| `auth [options]` | Authenticate to Databricks with user or machine OAuth |
|
|
111
|
+
| `tunnel [options] [command...]` | Front a command with a public tunnel and passwordless auth |
|
|
112
|
+
| `lakebase-proxy [options]` | Run a loopback PostgreSQL proxy for Databricks Lakebase |
|
|
113
|
+
| `model-gateway [options]` | Run or manage the AppKit Databricks model gateway |
|
|
114
|
+
| `genie [options] [genieArgs...]` | Run Genie Code through an authenticated local Databricks model gateway |
|
|
115
|
+
| `graphiti [options]` | Run Graphiti or manage its current-user desktop service |
|
|
105
116
|
|
|
106
117
|
### `dbx dev`
|
|
107
118
|
|
|
@@ -119,86 +130,612 @@ dbx dev [projenArgs...]
|
|
|
119
130
|
|
|
120
131
|
### `dbx appkit`
|
|
121
132
|
|
|
122
|
-
AppKit helpers
|
|
133
|
+
AppKit helpers: resolve the environment an AppKit app would start with.
|
|
123
134
|
|
|
124
135
|
```sh
|
|
125
|
-
|
|
136
|
+
appkit [command]
|
|
126
137
|
```
|
|
127
138
|
|
|
128
|
-
####
|
|
139
|
+
#### Commands
|
|
140
|
+
|
|
141
|
+
| Command | Description |
|
|
142
|
+
| --------------- | ------------------------------------------------------ |
|
|
143
|
+
| `env [options]` | Run AppKit auto-config and print new/changed env vars. |
|
|
144
|
+
|
|
145
|
+
### `dbx appkit env`
|
|
146
|
+
|
|
147
|
+
Run AppKit auto-config and print new/changed env vars.
|
|
148
|
+
|
|
149
|
+
```sh
|
|
150
|
+
appkit env [options]
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
#### Options
|
|
129
154
|
|
|
130
|
-
|
|
|
131
|
-
|
|
|
132
|
-
|
|
|
155
|
+
| Option | Description |
|
|
156
|
+
| ------------------ | --------------------------------------------------------------------------------------------------------------- |
|
|
157
|
+
| `--format <value>` | Output format: export, windows, or json. (choices: "export", "windows", "json", default: "export", env: FORMAT) |
|
|
158
|
+
| `--quiet` | Suppress auto-config log output. (default: false, env: QUIET) |
|
|
159
|
+
| `--no-quiet` | Disable suppress auto-config log output. |
|
|
133
160
|
|
|
134
161
|
### `dbx auth`
|
|
135
162
|
|
|
136
|
-
Authenticate to Databricks
|
|
163
|
+
Authenticate to Databricks with user or machine OAuth
|
|
137
164
|
|
|
138
165
|
```sh
|
|
139
|
-
|
|
166
|
+
auth [options] [command]
|
|
140
167
|
```
|
|
141
168
|
|
|
142
|
-
####
|
|
169
|
+
#### Options
|
|
170
|
+
|
|
171
|
+
| Option | Description |
|
|
172
|
+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
173
|
+
| `--profile <value>` | Databricks CLI profile. (env: DATABRICKS_CONFIG_PROFILE) |
|
|
174
|
+
| `--scopes <value>` | OAuth scopes. (default: [], env: SCOPES) |
|
|
175
|
+
| `--target <value>` | OAuth target. (choices: "workspace", "account", "unified", env: TARGET) |
|
|
176
|
+
| `--lock-timeout-ms <value>` | Credential lock timeout in milliseconds. (default: 0, env: LOCK_TIMEOUT_MS) |
|
|
177
|
+
| `--login-timeout-ms <value>` | Browser login timeout in milliseconds. (default: 900000, env: LOGIN_TIMEOUT_MS) |
|
|
178
|
+
| `--refresh-buffer-ms <value>` | Token refresh buffer in milliseconds. (default: 300000, env: REFRESH_BUFFER_MS) |
|
|
179
|
+
| `--prefer-user-to-machine` | Prefer a matching user profile over selected machine credentials. (default: true, env: PREFER_USER_TO_MACHINE) |
|
|
180
|
+
| `--no-prefer-user-to-machine` | Disable prefer a matching user profile over selected machine credentials. |
|
|
181
|
+
|
|
182
|
+
#### Commands
|
|
183
|
+
|
|
184
|
+
| Command | Description |
|
|
185
|
+
| ----------------- | ------------------------------------------------------ |
|
|
186
|
+
| `login` | Force browser login and return an access token |
|
|
187
|
+
| `token [options]` | Return a valid access token, logging in when needed |
|
|
188
|
+
| `headers` | Return current Databricks authentication headers |
|
|
189
|
+
| `profile` | Print the configured or automatically detected profile |
|
|
190
|
+
| `logout` | Delete the stored credential for the selected profile |
|
|
191
|
+
| `status` | Show the resolved authentication client configuration |
|
|
192
|
+
|
|
193
|
+
### `dbx auth login`
|
|
194
|
+
|
|
195
|
+
Force browser login and return an access token
|
|
143
196
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
197
|
+
```sh
|
|
198
|
+
auth login
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### `dbx auth token`
|
|
202
|
+
|
|
203
|
+
Return a valid access token, logging in when needed
|
|
204
|
+
|
|
205
|
+
```sh
|
|
206
|
+
auth token [options]
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
#### Options
|
|
210
|
+
|
|
211
|
+
| Option | Description |
|
|
212
|
+
| -------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
213
|
+
| `--force-refresh` | Refresh the token before returning it. (default: false, env: FORCE_REFRESH) |
|
|
214
|
+
| `--no-force-refresh` | Disable refresh the token before returning it. |
|
|
215
|
+
| `--login` | Log in when credentials are missing or invalid. (default: true, env: LOGIN) |
|
|
216
|
+
| `--no-login` | Disable log in when credentials are missing or invalid. |
|
|
217
|
+
| `--format <value>` | Output structured token metadata or only the access token. (choices: "json", "text", default: "json", env: FORMAT) |
|
|
218
|
+
|
|
219
|
+
### `dbx auth headers`
|
|
220
|
+
|
|
221
|
+
Return current Databricks authentication headers
|
|
222
|
+
|
|
223
|
+
```sh
|
|
224
|
+
auth headers
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### `dbx auth profile`
|
|
228
|
+
|
|
229
|
+
Print the configured or automatically detected profile
|
|
230
|
+
|
|
231
|
+
```sh
|
|
232
|
+
auth profile
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### `dbx auth logout`
|
|
236
|
+
|
|
237
|
+
Delete the stored credential for the selected profile
|
|
238
|
+
|
|
239
|
+
```sh
|
|
240
|
+
auth logout
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### `dbx auth status`
|
|
244
|
+
|
|
245
|
+
Show the resolved authentication client configuration
|
|
246
|
+
|
|
247
|
+
```sh
|
|
248
|
+
auth status
|
|
249
|
+
```
|
|
147
250
|
|
|
148
251
|
### `dbx tunnel`
|
|
149
252
|
|
|
150
|
-
|
|
253
|
+
Front a command with a public tunnel and passwordless auth
|
|
151
254
|
|
|
152
255
|
```sh
|
|
153
|
-
|
|
256
|
+
tunnel [options] [command] [command...]
|
|
154
257
|
```
|
|
155
258
|
|
|
156
259
|
#### Arguments
|
|
157
260
|
|
|
158
|
-
| Argument
|
|
159
|
-
|
|
|
160
|
-
| `
|
|
261
|
+
| Argument | Description |
|
|
262
|
+
| --------- | ------------------------------- |
|
|
263
|
+
| `command` | the command to wrap, after `--` |
|
|
264
|
+
|
|
265
|
+
#### Options
|
|
266
|
+
|
|
267
|
+
| Option | Description |
|
|
268
|
+
| ------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
269
|
+
| `--transport <value>` | Public tunnel transport. (choices: "portr", "frp", "both", env: TUNNEL_TRANSPORT) |
|
|
270
|
+
| `--public-domain <value>` | Public tunnel domain. (env: TUNNEL_PUBLIC_DOMAIN) |
|
|
271
|
+
| `--subdomain <value>` | Portr subdomain. (env: SUBDOMAIN) |
|
|
272
|
+
| `--port <value>` | Public listener port. (env: DATABRICKS_APP_PORT) |
|
|
273
|
+
| `--app-port <value>` | Private wrapped application port. (env: TUNNEL_APP_PORT) |
|
|
274
|
+
| `--allow <value>` | Email allow-list patterns. (env: TUNNEL_AUTH_ALLOW) |
|
|
275
|
+
| `--subject <value>` | Verification email subject. (env: TUNNEL_AUTH_SUBJECT) |
|
|
276
|
+
| `--brand-name <value>` | Verification email brand name. (env: TUNNEL_AUTH_BRAND_NAME) |
|
|
277
|
+
| `--message <value>` | Verification email message. (env: TUNNEL_AUTH_MESSAGE) |
|
|
278
|
+
| `--session-ttl-seconds <value>` | Session lifetime in seconds. (env: TUNNEL_AUTH_SESSION_TTL) |
|
|
279
|
+
| `--code-ttl-seconds <value>` | One-time-code lifetime in seconds. (env: TUNNEL_AUTH_CODE_TTL) |
|
|
280
|
+
| `--session-cutoff <value>` | Invalidate sessions issued before this value. (env: TUNNEL_AUTH_SESSION_CUTOFF) |
|
|
281
|
+
| `--storage <value>` | Authentication database mode. (choices: "auto", "lakebase", "sqlite", env: TUNNEL_AUTH_STORAGE) |
|
|
282
|
+
| `--sqlite-path <value>` | Local authentication SQLite file. (env: TUNNEL_AUTH_SQLITE_PATH) |
|
|
283
|
+
| `--forward-headers <value>` | Additional forwarded request header patterns. (env: TUNNEL_FORWARD_HEADERS) |
|
|
284
|
+
| `--gate-paths <value>` | Additional path prefixes requiring authentication. (env: TUNNEL_GATE_PATHS) |
|
|
285
|
+
| `--bind-hosts <value>` | Interface IPs the gate listens on. (env: BIND_HOSTS) |
|
|
286
|
+
| `--insecure` | Run without an authentication gate. (env: TUNNEL_INSECURE) |
|
|
287
|
+
| `--no-insecure` | Disable run without an authentication gate. |
|
|
288
|
+
| `--frp-server <value>` | FRP control host. (env: FRP_SERVER) |
|
|
289
|
+
| `--frp-public-domain <value>` | FRP public HTTP domain. (env: TUNNEL_FRP_PUBLIC_DOMAIN) |
|
|
290
|
+
| `--frp-server-port <value>` | FRP control port. (env: FRP_SERVER_PORT) |
|
|
291
|
+
| `--frp-protocol <value>` | FRP transport protocol. (env: FRP_PROTOCOL) |
|
|
292
|
+
| `--frp-token <value>` | FRP authentication token. (env: FRP_TOKEN) |
|
|
293
|
+
| `--frp-proxy-name <value>` | FRP proxy registration name. (env: FRP_PROXY_NAME) |
|
|
161
294
|
|
|
162
|
-
|
|
295
|
+
#### Commands
|
|
163
296
|
|
|
164
|
-
|
|
297
|
+
| Command | Description |
|
|
298
|
+
| ---------------------------- | ---------------------------------------------- |
|
|
299
|
+
| `run [options] <command...>` | Wrap a command (the default action) |
|
|
300
|
+
| `status [options]` | Resolve the configuration and print it |
|
|
301
|
+
| `install [transport]` | Install public tunnel client binaries and exit |
|
|
302
|
+
|
|
303
|
+
### `dbx tunnel run`
|
|
304
|
+
|
|
305
|
+
Wrap a command (the default action)
|
|
165
306
|
|
|
166
307
|
```sh
|
|
167
|
-
|
|
308
|
+
tunnel run [options] <command...>
|
|
168
309
|
```
|
|
169
310
|
|
|
170
311
|
#### Arguments
|
|
171
312
|
|
|
172
|
-
| Argument
|
|
173
|
-
|
|
|
174
|
-
| `
|
|
313
|
+
| Argument | Description |
|
|
314
|
+
| --------- | ------------------------------- |
|
|
315
|
+
| `command` | the command to wrap, after `--` |
|
|
316
|
+
|
|
317
|
+
#### Options
|
|
318
|
+
|
|
319
|
+
| Option | Description |
|
|
320
|
+
| ------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
321
|
+
| `--transport <value>` | Public tunnel transport. (choices: "portr", "frp", "both", env: TUNNEL_TRANSPORT) |
|
|
322
|
+
| `--public-domain <value>` | Public tunnel domain. (env: TUNNEL_PUBLIC_DOMAIN) |
|
|
323
|
+
| `--subdomain <value>` | Portr subdomain. (env: SUBDOMAIN) |
|
|
324
|
+
| `--port <value>` | Public listener port. (env: DATABRICKS_APP_PORT) |
|
|
325
|
+
| `--app-port <value>` | Private wrapped application port. (env: TUNNEL_APP_PORT) |
|
|
326
|
+
| `--allow <value>` | Email allow-list patterns. (env: TUNNEL_AUTH_ALLOW) |
|
|
327
|
+
| `--subject <value>` | Verification email subject. (env: TUNNEL_AUTH_SUBJECT) |
|
|
328
|
+
| `--brand-name <value>` | Verification email brand name. (env: TUNNEL_AUTH_BRAND_NAME) |
|
|
329
|
+
| `--message <value>` | Verification email message. (env: TUNNEL_AUTH_MESSAGE) |
|
|
330
|
+
| `--session-ttl-seconds <value>` | Session lifetime in seconds. (env: TUNNEL_AUTH_SESSION_TTL) |
|
|
331
|
+
| `--code-ttl-seconds <value>` | One-time-code lifetime in seconds. (env: TUNNEL_AUTH_CODE_TTL) |
|
|
332
|
+
| `--session-cutoff <value>` | Invalidate sessions issued before this value. (env: TUNNEL_AUTH_SESSION_CUTOFF) |
|
|
333
|
+
| `--storage <value>` | Authentication database mode. (choices: "auto", "lakebase", "sqlite", env: TUNNEL_AUTH_STORAGE) |
|
|
334
|
+
| `--sqlite-path <value>` | Local authentication SQLite file. (env: TUNNEL_AUTH_SQLITE_PATH) |
|
|
335
|
+
| `--forward-headers <value>` | Additional forwarded request header patterns. (env: TUNNEL_FORWARD_HEADERS) |
|
|
336
|
+
| `--gate-paths <value>` | Additional path prefixes requiring authentication. (env: TUNNEL_GATE_PATHS) |
|
|
337
|
+
| `--bind-hosts <value>` | Interface IPs the gate listens on. (env: BIND_HOSTS) |
|
|
338
|
+
| `--insecure` | Run without an authentication gate. (env: TUNNEL_INSECURE) |
|
|
339
|
+
| `--no-insecure` | Disable run without an authentication gate. |
|
|
340
|
+
| `--frp-server <value>` | FRP control host. (env: FRP_SERVER) |
|
|
341
|
+
| `--frp-public-domain <value>` | FRP public HTTP domain. (env: TUNNEL_FRP_PUBLIC_DOMAIN) |
|
|
342
|
+
| `--frp-server-port <value>` | FRP control port. (env: FRP_SERVER_PORT) |
|
|
343
|
+
| `--frp-protocol <value>` | FRP transport protocol. (env: FRP_PROTOCOL) |
|
|
344
|
+
| `--frp-token <value>` | FRP authentication token. (env: FRP_TOKEN) |
|
|
345
|
+
| `--frp-proxy-name <value>` | FRP proxy registration name. (env: FRP_PROXY_NAME) |
|
|
346
|
+
|
|
347
|
+
### `dbx tunnel status`
|
|
348
|
+
|
|
349
|
+
Resolve the configuration and print it
|
|
350
|
+
|
|
351
|
+
```sh
|
|
352
|
+
tunnel status [options]
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
#### Options
|
|
356
|
+
|
|
357
|
+
| Option | Description |
|
|
358
|
+
| ------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
359
|
+
| `--transport <value>` | Public tunnel transport. (choices: "portr", "frp", "both", env: TUNNEL_TRANSPORT) |
|
|
360
|
+
| `--public-domain <value>` | Public tunnel domain. (env: TUNNEL_PUBLIC_DOMAIN) |
|
|
361
|
+
| `--subdomain <value>` | Portr subdomain. (env: SUBDOMAIN) |
|
|
362
|
+
| `--port <value>` | Public listener port. (env: DATABRICKS_APP_PORT) |
|
|
363
|
+
| `--app-port <value>` | Private wrapped application port. (env: TUNNEL_APP_PORT) |
|
|
364
|
+
| `--allow <value>` | Email allow-list patterns. (env: TUNNEL_AUTH_ALLOW) |
|
|
365
|
+
| `--subject <value>` | Verification email subject. (env: TUNNEL_AUTH_SUBJECT) |
|
|
366
|
+
| `--brand-name <value>` | Verification email brand name. (env: TUNNEL_AUTH_BRAND_NAME) |
|
|
367
|
+
| `--message <value>` | Verification email message. (env: TUNNEL_AUTH_MESSAGE) |
|
|
368
|
+
| `--session-ttl-seconds <value>` | Session lifetime in seconds. (env: TUNNEL_AUTH_SESSION_TTL) |
|
|
369
|
+
| `--code-ttl-seconds <value>` | One-time-code lifetime in seconds. (env: TUNNEL_AUTH_CODE_TTL) |
|
|
370
|
+
| `--session-cutoff <value>` | Invalidate sessions issued before this value. (env: TUNNEL_AUTH_SESSION_CUTOFF) |
|
|
371
|
+
| `--storage <value>` | Authentication database mode. (choices: "auto", "lakebase", "sqlite", env: TUNNEL_AUTH_STORAGE) |
|
|
372
|
+
| `--sqlite-path <value>` | Local authentication SQLite file. (env: TUNNEL_AUTH_SQLITE_PATH) |
|
|
373
|
+
| `--forward-headers <value>` | Additional forwarded request header patterns. (env: TUNNEL_FORWARD_HEADERS) |
|
|
374
|
+
| `--gate-paths <value>` | Additional path prefixes requiring authentication. (env: TUNNEL_GATE_PATHS) |
|
|
375
|
+
| `--bind-hosts <value>` | Interface IPs the gate listens on. (env: BIND_HOSTS) |
|
|
376
|
+
| `--insecure` | Run without an authentication gate. (env: TUNNEL_INSECURE) |
|
|
377
|
+
| `--no-insecure` | Disable run without an authentication gate. |
|
|
378
|
+
| `--frp-server <value>` | FRP control host. (env: FRP_SERVER) |
|
|
379
|
+
| `--frp-public-domain <value>` | FRP public HTTP domain. (env: TUNNEL_FRP_PUBLIC_DOMAIN) |
|
|
380
|
+
| `--frp-server-port <value>` | FRP control port. (env: FRP_SERVER_PORT) |
|
|
381
|
+
| `--frp-protocol <value>` | FRP transport protocol. (env: FRP_PROTOCOL) |
|
|
382
|
+
| `--frp-token <value>` | FRP authentication token. (env: FRP_TOKEN) |
|
|
383
|
+
| `--frp-proxy-name <value>` | FRP proxy registration name. (env: FRP_PROXY_NAME) |
|
|
384
|
+
|
|
385
|
+
### `dbx tunnel install`
|
|
386
|
+
|
|
387
|
+
Install public tunnel client binaries and exit
|
|
388
|
+
|
|
389
|
+
```sh
|
|
390
|
+
tunnel install [transport]
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
#### Arguments
|
|
394
|
+
|
|
395
|
+
| Argument | Description |
|
|
396
|
+
| ----------- | -------------------------------------- |
|
|
397
|
+
| `transport` | portr, frp, or both (default: "portr") |
|
|
398
|
+
|
|
399
|
+
### `dbx lakebase-proxy`
|
|
400
|
+
|
|
401
|
+
Run a loopback PostgreSQL proxy for Databricks Lakebase
|
|
402
|
+
|
|
403
|
+
```sh
|
|
404
|
+
lakebase-proxy [options] [command]
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
#### Options
|
|
408
|
+
|
|
409
|
+
| Option | Description |
|
|
410
|
+
| ----------------------------------- | ---------------------------------------------------------------------------- |
|
|
411
|
+
| `-V, --version` | output the version number |
|
|
412
|
+
| `--postgres-role <value>` | PostgreSQL role assumed after authentication. (env: DBX_TOOLS_POSTGRES_ROLE) |
|
|
413
|
+
| `--listen <value>` | Loopback listener address. (default: tcp://localhost:5432, env: LISTEN) |
|
|
414
|
+
| `--startup-timeout-seconds <value>` | Startup timeout in seconds. (default: 30, env: STARTUP_TIMEOUT_SECONDS) |
|
|
415
|
+
| `--profile <value>` | Exact Databricks profile. (env: DATABRICKS_CONFIG_PROFILE) |
|
|
416
|
+
|
|
417
|
+
#### Commands
|
|
418
|
+
|
|
419
|
+
| Command | Description |
|
|
420
|
+
| --------------- | --------------------------------------------------- |
|
|
421
|
+
| `url [options]` | Format a local PostgreSQL URL for a Lakebase target |
|
|
422
|
+
| `service` | Install and manage the desktop service |
|
|
423
|
+
|
|
424
|
+
### `dbx lakebase-proxy url`
|
|
425
|
+
|
|
426
|
+
Format a local PostgreSQL URL for a Lakebase target
|
|
427
|
+
|
|
428
|
+
```sh
|
|
429
|
+
lakebase-proxy url [options]
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
#### Options
|
|
433
|
+
|
|
434
|
+
| Option | Description |
|
|
435
|
+
| ------------------ | ----------------------------------------------------------------- |
|
|
436
|
+
| `--target <value>` | Lakebase project, resource path, host, or URL. (env: TARGET) |
|
|
437
|
+
| `--listen <value>` | Local proxy address. (default: tcp://localhost:5432, env: LISTEN) |
|
|
438
|
+
|
|
439
|
+
### `dbx lakebase-proxy service`
|
|
440
|
+
|
|
441
|
+
Install and manage the desktop service
|
|
442
|
+
|
|
443
|
+
```sh
|
|
444
|
+
lakebase-proxy service [command]
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
#### Commands
|
|
448
|
+
|
|
449
|
+
| Command | Description |
|
|
450
|
+
| ------------------- | ----------------------------------------------------- |
|
|
451
|
+
| `install [options]` | Install the service for the current user and start it |
|
|
452
|
+
| `start` | Start the installed service |
|
|
453
|
+
| `stop` | Stop the running service |
|
|
454
|
+
| `restart` | Restart the installed service |
|
|
455
|
+
| `status` | Print service installation and process state as JSON |
|
|
456
|
+
| `uninstall` | Stop and remove the service for the current user |
|
|
457
|
+
|
|
458
|
+
### `dbx lakebase-proxy service install`
|
|
459
|
+
|
|
460
|
+
Install the service for the current user and start it
|
|
461
|
+
|
|
462
|
+
```sh
|
|
463
|
+
lakebase-proxy service install [options]
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
#### Options
|
|
467
|
+
|
|
468
|
+
| Option | Description |
|
|
469
|
+
| ----------------------------------- | ---------------------------------------------------------------------------- |
|
|
470
|
+
| `--no-start` | Do not start the service after installation |
|
|
471
|
+
| `--postgres-role <value>` | PostgreSQL role assumed after authentication. (env: DBX_TOOLS_POSTGRES_ROLE) |
|
|
472
|
+
| `--listen <value>` | Loopback listener address. (default: tcp://localhost:5432, env: LISTEN) |
|
|
473
|
+
| `--startup-timeout-seconds <value>` | Startup timeout in seconds. (default: 30, env: STARTUP_TIMEOUT_SECONDS) |
|
|
474
|
+
| `--profile <value>` | Exact Databricks profile. (env: DATABRICKS_CONFIG_PROFILE) |
|
|
475
|
+
|
|
476
|
+
### `dbx lakebase-proxy service start`
|
|
477
|
+
|
|
478
|
+
Start the installed service
|
|
479
|
+
|
|
480
|
+
```sh
|
|
481
|
+
lakebase-proxy service start
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### `dbx lakebase-proxy service stop`
|
|
485
|
+
|
|
486
|
+
Stop the running service
|
|
487
|
+
|
|
488
|
+
```sh
|
|
489
|
+
lakebase-proxy service stop
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
### `dbx lakebase-proxy service restart`
|
|
493
|
+
|
|
494
|
+
Restart the installed service
|
|
495
|
+
|
|
496
|
+
```sh
|
|
497
|
+
lakebase-proxy service restart
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
### `dbx lakebase-proxy service status`
|
|
501
|
+
|
|
502
|
+
Print service installation and process state as JSON
|
|
503
|
+
|
|
504
|
+
```sh
|
|
505
|
+
lakebase-proxy service status
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
### `dbx lakebase-proxy service uninstall`
|
|
509
|
+
|
|
510
|
+
Stop and remove the service for the current user
|
|
511
|
+
|
|
512
|
+
```sh
|
|
513
|
+
lakebase-proxy service uninstall
|
|
514
|
+
```
|
|
175
515
|
|
|
176
516
|
### `dbx model-gateway`
|
|
177
517
|
|
|
178
|
-
Run the
|
|
518
|
+
Run or manage the AppKit Databricks model gateway
|
|
519
|
+
|
|
520
|
+
```sh
|
|
521
|
+
model-gateway [options] [command]
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
#### Options
|
|
525
|
+
|
|
526
|
+
| Option | Description |
|
|
527
|
+
| ---------------------- | ------------------------------------------------------------------------------------------ |
|
|
528
|
+
| `-v, --version` | output the version number |
|
|
529
|
+
| `--listen <value>` | Loopback listener address. (default: tcp://localhost:4000, env: LISTEN) |
|
|
530
|
+
| `--profile <value>` | Databricks profile used for model discovery and requests. (env: DATABRICKS_CONFIG_PROFILE) |
|
|
531
|
+
| `--body-limit <value>` | Maximum JSON request body size. (default: "100mb", env: BODY_LIMIT) |
|
|
532
|
+
| `--runtime-info` | Print runtime implementation metadata. (default: false, env: RUNTIME_INFO) |
|
|
533
|
+
| `--no-runtime-info` | Disable print runtime implementation metadata. |
|
|
534
|
+
|
|
535
|
+
#### Commands
|
|
536
|
+
|
|
537
|
+
| Command | Description |
|
|
538
|
+
| --------- | -------------------------------------- |
|
|
539
|
+
| `service` | Install and manage the desktop service |
|
|
540
|
+
|
|
541
|
+
### `dbx model-gateway service`
|
|
542
|
+
|
|
543
|
+
Install and manage the desktop service
|
|
544
|
+
|
|
545
|
+
```sh
|
|
546
|
+
model-gateway service [command]
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
#### Commands
|
|
550
|
+
|
|
551
|
+
| Command | Description |
|
|
552
|
+
| ------------------- | ----------------------------------------------------- |
|
|
553
|
+
| `install [options]` | Install the service for the current user and start it |
|
|
554
|
+
| `start` | Start the installed service |
|
|
555
|
+
| `stop` | Stop the running service |
|
|
556
|
+
| `restart` | Restart the installed service |
|
|
557
|
+
| `status` | Print service installation and process state as JSON |
|
|
558
|
+
| `uninstall` | Stop and remove the service for the current user |
|
|
559
|
+
|
|
560
|
+
### `dbx model-gateway service install`
|
|
561
|
+
|
|
562
|
+
Install the service for the current user and start it
|
|
563
|
+
|
|
564
|
+
```sh
|
|
565
|
+
model-gateway service install [options]
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
#### Options
|
|
569
|
+
|
|
570
|
+
| Option | Description |
|
|
571
|
+
| ------------ | ------------------------------------------- |
|
|
572
|
+
| `--no-start` | Do not start the service after installation |
|
|
573
|
+
|
|
574
|
+
### `dbx model-gateway service start`
|
|
575
|
+
|
|
576
|
+
Start the installed service
|
|
577
|
+
|
|
578
|
+
```sh
|
|
579
|
+
model-gateway service start
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
### `dbx model-gateway service stop`
|
|
583
|
+
|
|
584
|
+
Stop the running service
|
|
585
|
+
|
|
586
|
+
```sh
|
|
587
|
+
model-gateway service stop
|
|
588
|
+
```
|
|
589
|
+
|
|
590
|
+
### `dbx model-gateway service restart`
|
|
591
|
+
|
|
592
|
+
Restart the installed service
|
|
593
|
+
|
|
594
|
+
```sh
|
|
595
|
+
model-gateway service restart
|
|
596
|
+
```
|
|
597
|
+
|
|
598
|
+
### `dbx model-gateway service status`
|
|
599
|
+
|
|
600
|
+
Print service installation and process state as JSON
|
|
601
|
+
|
|
602
|
+
```sh
|
|
603
|
+
model-gateway service status
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
### `dbx model-gateway service uninstall`
|
|
607
|
+
|
|
608
|
+
Stop and remove the service for the current user
|
|
609
|
+
|
|
610
|
+
```sh
|
|
611
|
+
model-gateway service uninstall
|
|
612
|
+
```
|
|
613
|
+
|
|
614
|
+
### `dbx genie`
|
|
615
|
+
|
|
616
|
+
Run Genie Code through an authenticated local Databricks model gateway
|
|
179
617
|
|
|
180
618
|
```sh
|
|
181
|
-
|
|
619
|
+
genie [options] [genieArgs...]
|
|
182
620
|
```
|
|
183
621
|
|
|
184
622
|
#### Arguments
|
|
185
623
|
|
|
186
|
-
| Argument
|
|
187
|
-
|
|
|
188
|
-
| `
|
|
624
|
+
| Argument | Description |
|
|
625
|
+
| ----------- | --------------------------------------------------------------------------------------------- |
|
|
626
|
+
| `genieArgs` | arguments and unknown flags forwarded to Genie Code; wrapper options may be separated with -- |
|
|
627
|
+
|
|
628
|
+
#### Options
|
|
629
|
+
|
|
630
|
+
| Option | Description |
|
|
631
|
+
| -------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
632
|
+
| `--profile <value>` | Databricks profile used by the model-gateway sidecar. (env: DATABRICKS_CONFIG_PROFILE) |
|
|
633
|
+
| `--model <value>` | Model name resolved by the model gateway. (default: "gpt", env: MODEL) |
|
|
634
|
+
| `--gateway-listen <value>` | Loopback listener allocated for the model-gateway sidecar. (default: tcp://127.0.0.1:0, env: GATEWAY_LISTEN) |
|
|
189
635
|
|
|
190
636
|
### `dbx graphiti`
|
|
191
637
|
|
|
192
638
|
Run Graphiti or manage its current-user desktop service
|
|
193
639
|
|
|
194
640
|
```sh
|
|
195
|
-
|
|
641
|
+
graphiti [options] [command]
|
|
196
642
|
```
|
|
197
643
|
|
|
198
|
-
####
|
|
644
|
+
#### Options
|
|
645
|
+
|
|
646
|
+
| Option | Description |
|
|
647
|
+
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
648
|
+
| `-v, --version` | output the version number |
|
|
649
|
+
| `--profile <value>` | Databricks profile used for model discovery and authentication. (env: DATABRICKS_CONFIG_PROFILE) |
|
|
650
|
+
| `--graphiti-home <value>` | Application-owned Graphiti runtime directory. (env: GRAPHITI_HOME) |
|
|
651
|
+
| `--model <value>` | Fuzzy chat-model name or endpoint identifier. (default: "databricks-gpt-5-nano", env: MODEL_NAME) |
|
|
652
|
+
| `--temperature <value>` | Sampling temperature forwarded to the Graphiti LLM client. (default: 1, env: TEMPERATURE) |
|
|
653
|
+
| `--embedder-model <value>` | Fuzzy embedding-model name or endpoint identifier. (default: "gte-large-en", env: EMBEDDER_MODEL) |
|
|
654
|
+
| `--embedder-dimensions <value>` | Embedding vector dimensions expected by Graphiti. (default: 1024, env: EMBEDDER_DIMENSIONS) |
|
|
655
|
+
| `--structured-output-mode <value>` | Structured-output mode forwarded to Graphiti's OpenAI provider. (default: "json_object", env: LLM_STRUCTURED_OUTPUT_MODE) |
|
|
656
|
+
| `--startup-timeout-ms <value>` | Maximum milliseconds allowed for the Graphiti runtime to become ready. (default: 180000, env: DBX_TOOLS_GRAPHITI_STARTUP_TIMEOUT_MS) |
|
|
657
|
+
| `--listen <value>` | Graphiti HTTP listener. (default: tcp://127.0.0.1:7272, env: GRAPHITI_LISTEN) |
|
|
658
|
+
| `--database-url <value>` | PostgreSQL URL or Lakebase target. Omit it to use persistent embedded PostgreSQL. (env: LAKEBASE_ENDPOINT) |
|
|
659
|
+
| `--database-schema <value>` | PostgreSQL schema used for Lakebase graph tables. (default: "dbx_tools_graphiti", env: GRAPHITI_DATABASE_SCHEMA) |
|
|
660
|
+
| `--postgres-role <value>` | PostgreSQL role assumed after authentication. (env: DBX_TOOLS_POSTGRES_ROLE) |
|
|
661
|
+
|
|
662
|
+
#### Commands
|
|
663
|
+
|
|
664
|
+
| Command | Description |
|
|
665
|
+
| --------- | -------------------------------------- |
|
|
666
|
+
| `service` | Install and manage the desktop service |
|
|
667
|
+
|
|
668
|
+
### `dbx graphiti service`
|
|
669
|
+
|
|
670
|
+
Install and manage the desktop service
|
|
671
|
+
|
|
672
|
+
```sh
|
|
673
|
+
graphiti service [command]
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
#### Commands
|
|
677
|
+
|
|
678
|
+
| Command | Description |
|
|
679
|
+
| ------------------- | ----------------------------------------------------- |
|
|
680
|
+
| `install [options]` | Install the service for the current user and start it |
|
|
681
|
+
| `start` | Start the installed service |
|
|
682
|
+
| `stop` | Stop the running service |
|
|
683
|
+
| `restart` | Restart the installed service |
|
|
684
|
+
| `status` | Print service installation and process state as JSON |
|
|
685
|
+
| `uninstall` | Stop and remove the service for the current user |
|
|
686
|
+
|
|
687
|
+
### `dbx graphiti service install`
|
|
688
|
+
|
|
689
|
+
Install the service for the current user and start it
|
|
690
|
+
|
|
691
|
+
```sh
|
|
692
|
+
graphiti service install [options]
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
#### Options
|
|
696
|
+
|
|
697
|
+
| Option | Description |
|
|
698
|
+
| ------------ | ------------------------------------------- |
|
|
699
|
+
| `--no-start` | Do not start the service after installation |
|
|
700
|
+
|
|
701
|
+
### `dbx graphiti service start`
|
|
702
|
+
|
|
703
|
+
Start the installed service
|
|
704
|
+
|
|
705
|
+
```sh
|
|
706
|
+
graphiti service start
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
### `dbx graphiti service stop`
|
|
710
|
+
|
|
711
|
+
Stop the running service
|
|
712
|
+
|
|
713
|
+
```sh
|
|
714
|
+
graphiti service stop
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
### `dbx graphiti service restart`
|
|
199
718
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
719
|
+
Restart the installed service
|
|
720
|
+
|
|
721
|
+
```sh
|
|
722
|
+
graphiti service restart
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
### `dbx graphiti service status`
|
|
726
|
+
|
|
727
|
+
Print service installation and process state as JSON
|
|
728
|
+
|
|
729
|
+
```sh
|
|
730
|
+
graphiti service status
|
|
731
|
+
```
|
|
732
|
+
|
|
733
|
+
### `dbx graphiti service uninstall`
|
|
734
|
+
|
|
735
|
+
Stop and remove the service for the current user
|
|
736
|
+
|
|
737
|
+
```sh
|
|
738
|
+
graphiti service uninstall
|
|
739
|
+
```
|
|
203
740
|
|
|
204
741
|
<!-- cli-reference:end -->
|