@dbx-tools/cli 0.9.38 → 0.9.40

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 (5) hide show
  1. package/README.md +141 -97
  2. package/index.ts +1 -1
  3. package/lib/index.d.ts +1 -1
  4. package/lib/index.js +2 -2
  5. package/package.json +9 -9
package/README.md CHANGED
@@ -1,137 +1,181 @@
1
1
  # @dbx-tools/cli
2
2
 
3
- The `dbx` CLI for workspace lifecycle, AppKit env, Databricks OAuth, and a
4
- gated public tunnel.
5
-
6
- Available commands:
7
-
8
- | Command | What it does |
9
- | -------------------- | ------------------------------------------------------------------------ |
10
- | `dbx dev` | Bootstrap or repair a dbx-tools workspace, then forward to projen. |
11
- | `dbx appkit env` | Print the environment an AppKit app resolves, as eval-able shell output. |
12
- | `dbx auth` | Generate U2M or M2M OAuth tokens with secure credential storage. |
13
- | `dbx tunnel` | Front any command with a public portr tunnel and an email-OTP gate. |
14
- | `dbx lakebase-proxy` | Run the loopback PostgreSQL proxy for Databricks Lakebase. |
15
-
16
- Key features:
17
-
18
- - Bootstrap path that scaffolds bun/projen into an empty or partially-set-up
19
- folder, including the initial install and synth.
20
- - Toolchain repair for a cloned repo whose generated files and `node_modules`
21
- are gitignored.
22
- - Transparent forwarding to projen for any task once the workspace is ready.
23
- - Custom-registry forcing that survives bun's own resolution rules, applied only
24
- when the effective registry is not npmjs.
25
- - Importable CLI/root/bun helpers for tests and thin wrapper commands.
26
-
27
- Every feature group lives in its own package:
28
- [`@dbx-tools/cli-appkit-env`](../appkit-env),
29
- [`@dbx-tools/cli-auth`](../auth), and
30
- [`@dbx-tools/cli-tunnel`](../tunnel). Each package is imported LAZILY, only once
31
- its name is matched, so `dbx dev` never pays to load AppKit, OAuth, SMTP, or
32
- X.509 code. Run
33
- `dbx <group> --help` for a group's own flags; each forwards `--help` to the child
34
- program rather than answering it at the root.
35
-
36
- The Lakebase proxy command runs the pure Node implementation.
3
+ Use one CLI to authenticate with Databricks, connect local PostgreSQL tools to
4
+ Lakebase, serve Databricks models to coding agents, run graph memory, and share
5
+ applications through a gated public URL.
37
6
 
38
- ## Bootstrap A Workspace
7
+ ## Install And Connect
39
8
 
40
9
  ```sh
41
- dbx dev sync
10
+ bun add --global @dbx-tools/cli
11
+ dbx auth login --profile MY-PROFILE
12
+ dbx auth status --profile MY-PROFILE
42
13
  ```
43
14
 
44
- In an empty folder this creates the minimum bun/projen structure needed for
45
- `@dbx-tools/projen`, installs the toolchain, and runs the first synth. In a
46
- freshly cloned repo it seeds the missing toolchain and synthesizes. This is the
47
- case projen cannot handle on its own, because there are no tasks to run yet.
15
+ `dbx-tools` is an alias for `dbx`. Choose a configured Databricks profile for
16
+ workspace commands; the examples use `MY-PROFILE` as a placeholder.
17
+
18
+ ## Serve Models To Local Tools
19
+
20
+ ```sh
21
+ dbx model-gateway --profile MY-PROFILE --port 4000
22
+ ```
48
23
 
49
- The three cases `dbx dev` dispatches on, in order:
24
+ Point an OpenAI-compatible client at `http://127.0.0.1:4000/v1`. See
25
+ [model gateway](../model-gateway#command-reference) for all options and desktop
26
+ service commands.
50
27
 
51
- | Workspace state | What happens |
52
- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
53
- | No `.projenrc.ts` | Full bootstrap: scaffold, install, initial synth. |
54
- | `.projenrc.ts` but no installed toolchain | Seed the toolchain, run the initial synth, then install. Task args are not forwarded, because the tasks they name do not exist until the first synth. |
55
- | Established workspace | Ensure deps, bring the engine up to this CLI's version, forward the args to projen. |
28
+ ## Connect To Lakebase
56
29
 
57
- Everything after `dev` is forwarded verbatim, flags included - `dbx dev sync
58
- --watch` runs the `sync` task with `--watch`. `dev` is an explicit subcommand
59
- rather than the bare root action so a projen task name can never collide with a
60
- sibling command group.
30
+ ```sh
31
+ dbx lakebase-proxy --profile MY-PROFILE --port 5432
32
+ ```
61
33
 
62
- ## After Bootstrap, Use The Projen Tasks
34
+ Connect your PostgreSQL client to the loopback listener. See
35
+ [Lakebase proxy](../lakebase-proxy#command-reference) for target selection,
36
+ connection URLs, and service commands.
63
37
 
64
- The engine registers its commands as projen tasks on the workspace root, so run
65
- them directly instead of going through this CLI:
38
+ ## Add Memory Or Share An App
66
39
 
67
40
  ```sh
68
- bun run sync # one-shot full synth
69
- bun run sync -- --watch # projenrc + barrels + openapi watchers
70
- bun run barrels # rebuild every package-root index.ts barrel
71
- bun run openapi # generate the openapi packages from tsoa controllers
72
- bun run clean # remove generated (read-only) files; -y to skip the picker
41
+ dbx graphiti --profile MY-PROFILE
42
+ dbx tunnel --allow example.com -- bun src/server.ts
73
43
  ```
74
44
 
75
- `dbx dev <task>` still works and forwards to the same projen task, but the
76
- `bun run` form is the documented one for an established workspace.
45
+ [Graphiti](../graphiti#command-reference) provides graph memory for agents.
46
+ [Tunnel](../tunnel#command-reference) adds a public URL with passwordless access
47
+ to an existing process. Each guide includes setup requirements and a generated
48
+ command reference.
77
49
 
78
- ## Resolve AppKit Env
50
+ ## Export AppKit Configuration
79
51
 
80
52
  ```sh
81
53
  eval "$(dbx appkit env --quiet)"
82
54
  ```
83
55
 
84
- See [`@dbx-tools/cli-appkit-env`](../appkit-env) for output formats and
85
- configuration behavior.
56
+ Use the resolved AppKit environment before starting another process. See
57
+ [AppKit environment](../appkit-env#command-reference) for JSON and Windows
58
+ output, and [authentication](../auth#command-reference) for token commands.
86
59
 
87
- ## Authenticate With Databricks User OAuth
60
+ ## Bootstrap A Workspace
88
61
 
89
62
  ```sh
90
- dbx auth login --profile my-workspace
91
- dbx auth token --profile my-workspace
92
- dbx auth status --profile my-workspace
63
+ dbx dev sync
93
64
  ```
94
65
 
95
- The auth command uses `@dbx-tools/auth` for preferred U2M browser OAuth, M2M
96
- client credentials, refresh, locking, and file or memory
97
- storage. See [`@dbx-tools/cli-auth`](../auth) for the complete command and
98
- option surface.
66
+ In an empty folder, this creates and initializes a Bun/Projen workspace. In a
67
+ cloned workspace, it installs missing tooling before running the requested task.
68
+ Arguments after `dev` are forwarded to Projen.
99
69
 
100
- ## Put A Gated Public URL In Front Of A Command
70
+ Once the workspace is initialized, use its tasks directly:
101
71
 
102
72
  ```sh
103
- dbx tunnel status --allow databricks.com
104
- dbx tunnel --allow databricks.com -- bun src/server.ts
73
+ bun run sync
74
+ bun run sync -- --watch
75
+ bun run barrels
76
+ bun run openapi
77
+ ```
78
+
79
+ See [`@dbx-tools/projen`](../../../../projen) for workspace configuration and
80
+ generation. The command reference below lists the top-level groups; each linked
81
+ package guide documents that group's complete options and subcommands.
82
+
83
+ <!-- cli-reference:start -->
84
+
85
+ ## Command Reference
86
+
87
+ ### `dbx`
88
+
89
+ ```text
90
+ Usage: dbx [command]
91
+
92
+ Databricks developer tools: workspace lifecycle, AppKit env, auth, tunnels, and local proxies
93
+
94
+ Commands:
95
+ dev [projenArgs...] Bootstrap or repair a dbx-tools workspace, then forward to projen
96
+ appkit [args...] AppKit helpers (env: print the environment an AppKit app resolves)
97
+ auth [args...] Authenticate to Databricks and manage OAuth tokens
98
+ tunnel [args...] Run a public portr tunnel with an email-OTP gate
99
+ lakebase-proxy [args...] Run the Node Databricks Lakebase PostgreSQL proxy
100
+ model-gateway [args...] Run the foreground AppKit Databricks model gateway
101
+ graphiti [args...] Run Graphiti or manage its current-user desktop service
102
+ ```
103
+
104
+ ### `dbx dev`
105
+
106
+ ```text
107
+ Usage: dbx dev [projenArgs...]
108
+
109
+ Bootstrap or repair a dbx-tools workspace, then forward to projen
110
+
111
+ Arguments:
112
+ projenArgs projen task and arguments (e.g. sync --watch)
105
113
  ```
106
114
 
107
- `dbx tunnel` claims the public port, moves the wrapped command to a private
108
- loopback port, and reverse-proxies between them so an email one-time-code gate
109
- sits in front of traffic the command never has to know about. The command does
110
- not have to be a Node server - anything that honors `PORT` /
111
- `DATABRICKS_APP_PORT` works. An AppKit app should prefer the in-process plugin
112
- path instead; see [`@dbx-tools/cli-tunnel`](../tunnel) for that comparison, the
113
- full flag table, and the request flow.
115
+ ### `dbx appkit`
114
116
 
115
- ## Use The CLI Internals
117
+ ```text
118
+ Usage: dbx appkit [args...]
116
119
 
117
- ```ts
118
- import { cli, root, bun } from "@dbx-tools/cli";
120
+ AppKit helpers (env: print the environment an AppKit app resolves)
119
121
 
120
- await cli.prepareAndRunProjen(["sync"]);
121
- const workspaceRoot = await root.findWorkspaceRoot();
122
- bun.runProjen(["barrels"], workspaceRoot);
122
+ Arguments:
123
+ args arguments forwarded to appkit
123
124
  ```
124
125
 
125
- Importing internals is mainly useful for tests or wrapper scripts; most users
126
- should run the `dbx` bin.
126
+ ### `dbx auth`
127
127
 
128
- ## Modules
128
+ ```text
129
+ Usage: dbx auth [args...]
129
130
 
130
- - `cli` - the root commander program (`buildProgram()`, `runCli()`) and the
131
- `dev` implementation `prepareAndRunProjen()`.
132
- - `bootstrap` - empty-workspace bootstrap, toolchain seeding, and the initial synth.
133
- - `root` - workspace-root detection and bootstrap/install checks.
134
- - `bun` - bun discovery, workspace install, registry forcing, and projen delegation.
131
+ Authenticate to Databricks and manage OAuth tokens
132
+
133
+ Arguments:
134
+ args arguments forwarded to auth
135
+ ```
136
+
137
+ ### `dbx tunnel`
138
+
139
+ ```text
140
+ Usage: dbx tunnel [args...]
141
+
142
+ Run a public portr tunnel with an email-OTP gate
143
+
144
+ Arguments:
145
+ args arguments forwarded to tunnel
146
+ ```
147
+
148
+ ### `dbx lakebase-proxy`
149
+
150
+ ```text
151
+ Usage: dbx lakebase-proxy [args...]
152
+
153
+ Run the Node Databricks Lakebase PostgreSQL proxy
154
+
155
+ Arguments:
156
+ args arguments forwarded to lakebase-proxy
157
+ ```
158
+
159
+ ### `dbx model-gateway`
160
+
161
+ ```text
162
+ Usage: dbx model-gateway [args...]
163
+
164
+ Run the foreground AppKit Databricks model gateway
165
+
166
+ Arguments:
167
+ args arguments forwarded to model-gateway
168
+ ```
169
+
170
+ ### `dbx graphiti`
171
+
172
+ ```text
173
+ Usage: dbx graphiti [args...]
174
+
175
+ Run Graphiti or manage its current-user desktop service
176
+
177
+ Arguments:
178
+ args arguments forwarded to graphiti
179
+ ```
135
180
 
136
- The reusable project classes and generators live in
137
- [`@dbx-tools/projen`](../../../../projen).
181
+ <!-- cli-reference:end -->
package/index.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // Hand edits are overwritten on the next watch; this file is read-only.
4
4
 
5
5
  export const PACKAGE_IDENTIFIER = "@dbx-tools/cli";
6
- export const PACKAGE_VERSION = "0.9.38";
6
+ export const PACKAGE_VERSION = "0.9.40";
7
7
  export * as bootstrap from "./src/bootstrap.ts";
8
8
  export * as bun from "./src/bun.ts";
9
9
  export * as cli from "./src/cli.ts";
package/lib/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const PACKAGE_IDENTIFIER = "@dbx-tools/cli";
2
- export declare const PACKAGE_VERSION = "0.9.38";
2
+ export declare const PACKAGE_VERSION = "0.9.40";
3
3
  export * as bootstrap from "./src/bootstrap.ts";
4
4
  export * as bun from "./src/bun.ts";
5
5
  export * as cli from "./src/cli.ts";
package/lib/index.js CHANGED
@@ -2,11 +2,11 @@
2
2
  // Regenerated from the exporting modules in ./src.
3
3
  // Hand edits are overwritten on the next watch; this file is read-only.
4
4
  export const PACKAGE_IDENTIFIER = "@dbx-tools/cli";
5
- export const PACKAGE_VERSION = "0.9.38";
5
+ export const PACKAGE_VERSION = "0.9.40";
6
6
  export * as bootstrap from "./src/bootstrap.js";
7
7
  export * as bun from "./src/bun.js";
8
8
  export * as cli from "./src/cli.js";
9
9
  export * as root from "./src/root.js";
10
10
  export { resolveBunArgv } from "./src/bun.js";
11
11
  export { workspaceRoot } from "./src/root.js";
12
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxnQkFBZ0IsQ0FBQztBQUNuRCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsUUFBUSxDQUFDO0FBQ3hDLE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxLQUFLLEdBQUcsTUFBTSxjQUFjLENBQUM7QUFDcEMsT0FBTyxLQUFLLEdBQUcsTUFBTSxjQUFjLENBQUM7QUFDcEMsT0FBTyxLQUFLLElBQUksTUFBTSxlQUFlLENBQUM7QUFDdEMsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUM5QyxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sZUFBZSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gR0VORVJBVEVEIGJ5IHByb2plbiB3YXRjaCAtIERPIE5PVCBFRElULlxuLy8gUmVnZW5lcmF0ZWQgZnJvbSB0aGUgZXhwb3J0aW5nIG1vZHVsZXMgaW4gLi9zcmMuXG4vLyBIYW5kIGVkaXRzIGFyZSBvdmVyd3JpdHRlbiBvbiB0aGUgbmV4dCB3YXRjaDsgdGhpcyBmaWxlIGlzIHJlYWQtb25seS5cblxuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfSURFTlRJRklFUiA9IFwiQGRieC10b29scy9jbGlcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS4zOFwiO1xuZXhwb3J0ICogYXMgYm9vdHN0cmFwIGZyb20gXCIuL3NyYy9ib290c3RyYXAudHNcIjtcbmV4cG9ydCAqIGFzIGJ1biBmcm9tIFwiLi9zcmMvYnVuLnRzXCI7XG5leHBvcnQgKiBhcyBjbGkgZnJvbSBcIi4vc3JjL2NsaS50c1wiO1xuZXhwb3J0ICogYXMgcm9vdCBmcm9tIFwiLi9zcmMvcm9vdC50c1wiO1xuZXhwb3J0IHsgcmVzb2x2ZUJ1bkFyZ3YgfSBmcm9tIFwiLi9zcmMvYnVuLnRzXCI7XG5leHBvcnQgeyB3b3Jrc3BhY2VSb290IH0gZnJvbSBcIi4vc3JjL3Jvb3QudHNcIjtcbiJdfQ==
12
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxnQkFBZ0IsQ0FBQztBQUNuRCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsUUFBUSxDQUFDO0FBQ3hDLE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxLQUFLLEdBQUcsTUFBTSxjQUFjLENBQUM7QUFDcEMsT0FBTyxLQUFLLEdBQUcsTUFBTSxjQUFjLENBQUM7QUFDcEMsT0FBTyxLQUFLLElBQUksTUFBTSxlQUFlLENBQUM7QUFDdEMsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUM5QyxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sZUFBZSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gR0VORVJBVEVEIGJ5IHByb2plbiB3YXRjaCAtIERPIE5PVCBFRElULlxuLy8gUmVnZW5lcmF0ZWQgZnJvbSB0aGUgZXhwb3J0aW5nIG1vZHVsZXMgaW4gLi9zcmMuXG4vLyBIYW5kIGVkaXRzIGFyZSBvdmVyd3JpdHRlbiBvbiB0aGUgbmV4dCB3YXRjaDsgdGhpcyBmaWxlIGlzIHJlYWQtb25seS5cblxuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfSURFTlRJRklFUiA9IFwiQGRieC10b29scy9jbGlcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS40MFwiO1xuZXhwb3J0ICogYXMgYm9vdHN0cmFwIGZyb20gXCIuL3NyYy9ib290c3RyYXAudHNcIjtcbmV4cG9ydCAqIGFzIGJ1biBmcm9tIFwiLi9zcmMvYnVuLnRzXCI7XG5leHBvcnQgKiBhcyBjbGkgZnJvbSBcIi4vc3JjL2NsaS50c1wiO1xuZXhwb3J0ICogYXMgcm9vdCBmcm9tIFwiLi9zcmMvcm9vdC50c1wiO1xuZXhwb3J0IHsgcmVzb2x2ZUJ1bkFyZ3YgfSBmcm9tIFwiLi9zcmMvYnVuLnRzXCI7XG5leHBvcnQgeyB3b3Jrc3BhY2VSb290IH0gZnJvbSBcIi4vc3JjL3Jvb3QudHNcIjtcbiJdfQ==
package/package.json CHANGED
@@ -28,14 +28,14 @@
28
28
  },
29
29
  "dependencies": {
30
30
  "@clack/prompts": "^1.7.0",
31
- "@dbx-tools/cli-appkit-env": "^0.9.38",
32
- "@dbx-tools/cli-auth": "^0.9.38",
33
- "@dbx-tools/cli-graphiti": "^0.9.38",
34
- "@dbx-tools/cli-lakebase-proxy": "^0.9.38",
35
- "@dbx-tools/cli-model-gateway": "^0.9.38",
36
- "@dbx-tools/cli-tunnel": "^0.9.38",
37
- "@dbx-tools/core": "^0.9.38",
38
- "@dbx-tools/shared-core": "^0.9.38",
31
+ "@dbx-tools/cli-appkit-env": "^0.9.40",
32
+ "@dbx-tools/cli-auth": "^0.9.40",
33
+ "@dbx-tools/cli-graphiti": "^0.9.40",
34
+ "@dbx-tools/cli-lakebase-proxy": "^0.9.40",
35
+ "@dbx-tools/cli-model-gateway": "^0.9.40",
36
+ "@dbx-tools/cli-tunnel": "^0.9.40",
37
+ "@dbx-tools/core": "^0.9.40",
38
+ "@dbx-tools/shared-core": "^0.9.40",
39
39
  "commander": "^15.0.0"
40
40
  },
41
41
  "main": "./lib/index.js",
@@ -72,7 +72,7 @@
72
72
  "./package.json": "./package.json"
73
73
  }
74
74
  },
75
- "version": "0.9.38",
75
+ "version": "0.9.40",
76
76
  "types": "./lib/index.d.ts",
77
77
  "dbxToolsConfig": {
78
78
  "tags": [