@dbx-tools/cli-model-gateway
v0.9.58
Published
Foreground and system-tray AppKit model-gateway CLI
Readme
@dbx-tools/cli-model-gateway
Expose Databricks-hosted models on a local OpenAI-compatible endpoint for Codex, SDKs, and development tools. The CLI discovers models from the selected workspace and can run temporarily in a terminal or continuously as a current-user service.
Quick Start
dbx model-gateway --profile PROFILE --listen :4000Point an OpenAI-compatible client at http://127.0.0.1:4000/v1, then inspect
the models available to that client:
curl http://127.0.0.1:4000/v1/modelsThe standalone dbx-model-gateway executable accepts the same options.
Run As A Service
Install the gateway when local tools need it outside an active terminal:
dbx model-gateway service install --listen :4401 --profile PROFILE
dbx model-gateway service status
dbx model-gateway service restart
dbx model-gateway service uninstallThe installed service remembers the host, port, profile, and request body
limit. Its tray menu opens the active /v1/models response and provides a clean
quit action. service status prints installation and process state as JSON.
service restart relaunches the installed executable. Re-run service install
after upgrading the CLI to rebuild that executable and update its saved options.
Connection Behavior
The gateway binds to loopback only; valid hosts are 127.0.0.1, ::1, and
localhost. Choose --profile explicitly when more than one Databricks profile
is configured. Use --runtime-info to print the implementation and package
version without starting the server.
The loopback server accepts JSON request bodies up to 100 MB so long-running agent and Codex histories reach the selected model service instead of failing at the local gateway. The client and upstream service still enforce their own context and request limits.
For embedded AppKit use, protocol support, and request compatibility, see
@dbx-tools/appkit-model-gateway. Browser-safe
model discovery lives in
@dbx-tools/shared-model-gateway.
Command Reference
dbx model-gateway
Run or manage the AppKit Databricks model gateway
dbx model-gateway [options] [command]Options
| Option | Description |
| ---------------------- | ------------------------------------------------------------------------------------------ |
| -v, --version | output the version number |
| --listen <value> | Loopback listener address. (default: tcp://localhost:4000, env: LISTEN) |
| --profile <value> | Databricks profile used for model discovery and requests. (env: DATABRICKS_CONFIG_PROFILE) |
| --body-limit <value> | Maximum JSON request body size. (default: "100mb", env: BODY_LIMIT) |
| --runtime-info | Print runtime implementation metadata. (default: false, env: RUNTIME_INFO) |
| --no-runtime-info | Disable print runtime implementation metadata. |
Commands
| Command | Description |
| --------- | -------------------------------------- |
| service | Install and manage the desktop service |
dbx model-gateway service
Install and manage the desktop service
dbx model-gateway service [command]Commands
| Command | Description |
| ------------------- | ----------------------------------------------------- |
| install [options] | Install the service for the current user and start it |
| start | Start the installed service |
| stop | Stop the running service |
| restart | Restart the installed service |
| status | Print service installation and process state as JSON |
| uninstall | Stop and remove the service for the current user |
dbx model-gateway service install
Install the service for the current user and start it
dbx model-gateway service install [options]Options
| Option | Description |
| ------------ | ----------------------------------------------------------------- |
| --start | Start the service after installation. (default: true, env: START) |
| --no-start | Disable start the service after installation. |
dbx model-gateway service start
Start the installed service
dbx model-gateway service startdbx model-gateway service stop
Stop the running service
dbx model-gateway service stopdbx model-gateway service restart
Restart the installed service
dbx model-gateway service restartdbx model-gateway service status
Print service installation and process state as JSON
dbx model-gateway service statusdbx model-gateway service uninstall
Stop and remove the service for the current user
dbx model-gateway service uninstall