@dbx-tools/cli

中文文档
0.9.206发布于 2026/11/11Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 8767

Dbx 用于工作空间生命周期、 AppKit 环境、 Databricks OAuth 和有门的隧道的 CLI

中文使用文档
文档目录54 节
  1. 安装和连接
  2. 导出一个品牌包
  3. 为本地工具提供模型
  4. 运行精灵代码
  5. 连接湖基地
  6. 添加内存或共享应用程序
  7. 导出 AppKit 配置
  8. 启动工作空间
  9. 命令参考
  10. dbx
  11. dbx dev
  12. dbx appkit
  13. dbx appkit env
  14. dbx auth
  15. dbx auth login
  16. dbx auth token
  17. dbx auth headers
  18. dbx auth profile
  19. dbx auth logout
  20. dbx auth status
  21. dbx brand
  22. dbx tunnel
  23. dbx tunnel run
  24. dbx tunnel status
  25. dbx tunnel install
  26. dbx lakebase-proxy
  27. dbx lakebase-proxy url
  28. dbx lakebase-proxy service
  29. dbx lakebase-proxy service install
  30. dbx lakebase-proxy service start
  31. dbx lakebase-proxy service stop
  32. dbx lakebase-proxy service restart
  33. dbx lakebase-proxy service status
  34. dbx lakebase-proxy service logs
  35. dbx lakebase-proxy service uninstall
  36. dbx model-gateway
  37. dbx model-gateway service
  38. dbx model-gateway service install
  39. dbx model-gateway service start
  40. dbx model-gateway service stop
  41. dbx model-gateway service restart
  42. dbx model-gateway service status
  43. dbx model-gateway service logs
  44. dbx model-gateway service uninstall
  45. dbx genie
  46. dbx graphiti
  47. dbx graphiti service
  48. dbx graphiti service install
  49. dbx graphiti service start
  50. dbx graphiti service stop
  51. dbx graphiti service restart
  52. dbx graphiti service status
  53. dbx graphiti service logs
  54. dbx graphiti service uninstall

@dbx-tools/cli (英语)

使用 dbx 将本地 PostgreSQL 工具连接到 Lakebase, 向本地客户端曝光工作空间模型, 运行图表内存, 并共享 通过访问控制的公共 URL 的应用程序.

安装和连接

bun add --global @dbx-tools/cli

dbx-tools 是用于 dbx。认证和配置的数据砖 配置文件自动解决。 使用的实例 MY-PROFILE 显示 明确覆盖.

操作失败会打印一个简洁的信息,而不会有内部堆栈的痕迹. 设定 LOG_LEVEL=debug 当重运行包含清理堆栈跟踪的命令时.

导出一个品牌包

dbx brand "A neighborhood coffee company for morning commuters"

指挥部研究了更广泛的网络 品牌事实和设计方向, 然后访问匹配 iOS App Store 和 Google Play 页面以补充 视觉参考. 它使用下载的图标和截图 多式联运合成不把移动设计当作全品牌. 普通状态行报告网页搜索、存储页面读取、图像审查、来源 收集, 并合成 发生.

默认情况下, 命令会创建一个独特的操作系统临时目录 并打印其路径 当世代完成。 该目录包含:

  • brand.yaml,兼容共享dbx-tools品牌上下文.
  • brand-package.json,有源出处和可视参考元数据.
  • showcase.html,带有桌面的自成一体的响应品牌演示文稿 和移动网站模拟.
  • references/ios/ 财务报告和审定财务报表 references/android/,使用移动图像 视觉研究.

对于具有已知品牌坐标的持久包:

dbx brand "Retail analytics for store operators" \
  --name "Acme Retail" \
  --website https://acme.example \
  --output branding/acme-retail

为本地工具提供模型

dbx model-gateway \
  --profile PRIMARY-PROFILE \
  --profile FALLBACK-PROFILE \
  --listen tcp://127.0.0.1:4000

重复配置文件构成一个命令的速率限制倒计时列表. 发现使用 第一个简介。 HTTP 429 冷却了工作空间和型号代号,重置 下一个可用的工作空间,然后返回重试后的第一个配置文件 间隔过期 .

指向 OpenAI 兼容客户端 http://127.0.0.1:4000/v1 (中文(简体) )生成 命令引用包括所有网关和桌面服务选项.

请求可以省略 model 来选择最佳的聊天端点。 客户 每个请求可选择一个类 x-dbx-tools-model-class 头曰.

在前方运行一个终端会话的网关 。 安装其 当本地工具需要终端后的终点时, 当前用户服务 关闭 :

dbx model-gateway service install
dbx model-gateway service status

嵌入 @dbx-tools/appkit-模范出道道 当网关属于 AppKit 应用程序时 .

运行精灵代码

dbx genie 运行 Databricks Genie Code CLI 与 dbx-tools 模型发现, 认证和配置。 它取消了通常需要的设置步骤 在第一个非交互式精灵命令之前 :

  • 没有精灵登入或分离 genie 初始化.
  • 没有Genie配置配置配置可以创建或通过.
  • 没有手动提供者 URL, 令牌命令, 工作空间头, 或 config.toml。 。 。 .
  • 当 dbx- 工具发现配置时, 没有明确的配置选择 数据砖简介.
  • 对Genie Code的默认模型没有限制. 选择任何兼容的模型 在工作空间中可以使用,包括GBT、Grok、Claude、双子座和自定义 服务端点.

在没有模型选择的情况下, dbx 工具选择最佳可用的工具功能聊天 型号。 选择接受模糊或准确的终点名称或能力带:

dbx genie
dbx genie --model-class chat-fast
dbx genie --profile MY-PROFILE --model databricks-gpt-5-6-sol

dbx-genie 是已安装的等效二进制 :

dbx-genie --model gpt

命令安装被绑定的 Genie 码包 ~/.dbx-tools 财务报告和审定财务报表 每个精确的 Databricks 剖面图创建一个恒定的家. 模型分享 家庭对话状态和项目信任,而每次引用都收到 以独立的本地网关端口和证书方式覆盖模型.

未知的旗帜、 提示和额外参数被转发到 Genie 代码 :

dbx genie --model gpt "Summarize the changes since the latest release."
dbx genie --model claude -- exec --ephemeral "Review this repository."

使用 -- 仅在诸如 --model 必须发送到 Genie 而不是被消费 dbx genie。 。 。 .

连接湖基地

dbx lakebase-proxy --profile MY-PROFILE --listen tcp://127.0.0.1:5432

将您的 PostgreSQL 客户端连接到回回听器 。 命令参考 包括目标选择、连接 URL 和服务命令.

添加内存或共享应用程序

dbx graphiti --profile MY-PROFILE
dbx tunnel --allow example.com -- bun src/server.ts

graphiti 为代理提供图表内存. tunnel 以 对现有进程无密码访问 .

导出 AppKit 配置

eval "$(dbx appkit env --quiet)"

在启动另一个进程之前使用已解析的 AppKit 环境 .

启动工作空间

dbx dev sync

在空文件夹中, 创建并初始化一个 Bun/ Projen 工作空间 。 在一个 被克隆的工作空间,它在执行所请求的任务之前会安装缺失的工具. 参数后 dev 转呈普罗让.

工作空间初始化后,直接使用它的任务:

bun run sync
bun run sync -- --watch
bun run barrels

见 @dbx-tools/ projen (英语) 用于工作空间配置和 生成。 命令执行可从 @dbx-tools/cli/appkit, (中文(简体) ), /auth, (中文(简体) ), /brand, (中文(简体) ), /genie, (中文(简体) ), /graphiti, (中文(简体) ), /lakebase-proxy, (中文(简体) ), /model-gateway, (中文(简体) ), 财务报告和审定财务报表 /tunnel 当一个节点呼叫器需要嵌入一个解析器时.

命令参考

dbx

Databricks 开发工具:工作空间生命周期、 AppKit env、 认证、 品牌生成、 隧道和本地代理

dbx [command]

图标

命令说明
dev [projenArgs...]脚套或修补 Dbx 工具的工作空间,然后转发到 projen
appkitAppKit 帮助者: 解决 AppKit 应用程序开始的环境 .
auth [options]以用户或机器 OAuth 认证到 Databricks
brand [options] <prompt>研究品牌简介和出口品牌. 有网络和移动可视参考文献的 yaml
tunnel [options] [command...]用公用地道和无密码认证前置命令
lakebase-proxy [options]为 Databricks Lakebase 运行回转 PostgreSQL 代理服务器
model-gateway [options]运行或管理 AppKit Databricks 模型网关
genie [options] [genieArgs...]通过经认证的本地 Databricks 模型网关运行 Genie 代码
graphiti [options]运行 Graphiti 或管理其当前用户桌面服务

dbx dev

脚套或修补 Dbx 工具的工作空间,然后转发到 projen

dbx dev [projenArgs...]

参数

参数说明
projenArgsProjen 任务和参数, 例如同步 -- watch

dbx appkit

AppKit 帮助者: 解决 AppKit 应用程序开始的环境 .

dbx appkit [command]

图标

命令说明
env [options]运行 AppKit 自动配置并打印出新/已更改的env vars.

dbx appkit env

运行 AppKit 自动配置并打印出新/已更改的env vars.

dbx appkit env [options]

选项

选项说明
-f, --format <value>输出格式:导出,窗口,或json. (选择:"出口","窗口","json",默认:"出口","env:FORMAT")
-q, --quiet禁止自动配置日志输出 。 (默认:假, env: QUIET)
--no-quiet禁用自动配置日志输出 .

dbx auth

以用户或机器 OAuth 认证到 Databricks

dbx auth [options] [command]

选项

选项说明
--profile <value>Databricks CLI简介. (中文(简体) )
-s, --scopes <value>OAuth 范围 。 (默认: [], env: SCOPES)
-t, --target <value>OAuth目标. (选择:"工作空间","帐户","统一",内涵:TARGET)
--lock-timeout-ms <value>信用锁定超时 毫秒。 (默认: 0, env: LOCK TIMEOUT MS)
--login-timeout-ms <value>浏览器登录超时, 以毫秒计 。 (默认: 9000, env: LOGIN TIMEOUT MS) (中文(简体) )
-r, --refresh-buffer-ms <value>以毫秒为单位的托肯刷新缓冲. (默认: 3000, env: REFRESH BUFFER MS)
--prefer-user-to-machine优先使用匹配的用户配置 。 (默认:真, env: PRIFER USER TO MACHINE)
--no-prefer-user-to-machine禁用匹配的用户配置文件, 而不是选中的机器证书 .

图标

命令说明
login强制浏览器登录并返回访问令牌
token [options]返回有效的访问令牌, 在需要时登录
headers返回当前 Databricks 认证头
profile打印已配置或自动检测的配置文件
logout删除所选配置文件的存储证书
status显示已解析的认证客户端配置

dbx auth login

强制浏览器登录并返回访问令牌

dbx auth login

dbx auth token

返回有效的访问令牌, 在需要时登录

dbx auth token [options]

选项

选项说明
--force-refresh在还原前刷新标志 。 (默认:假, env: FORCE REFRESH)
--no-force-refresh禁用在返回前刷新符号 .
-l, --login当证书缺失或无效时登录 。 (默认: true, env: LOGIN)
--no-login缺少或无效证书时禁用日志 .
--format <value>输出结构化的符号元数据或仅访问符号. (选择:"json","text",默认:"json",env:FORMAT)

dbx auth headers

返回当前 Databricks 认证头

dbx auth headers

dbx auth profile

打印已配置或自动检测的配置文件

dbx auth profile

dbx auth logout

删除所选配置文件的存储证书

dbx auth logout

dbx auth status

显示已解析的认证客户端配置

dbx auth status

dbx brand

研究品牌简介和出口品牌. 有网络和移动可视参考文献的 yaml

dbx brand [options] <prompt>

参数

参数说明
prompt品牌、公司、产品或设计简介

选项

选项说明
-p, --profile <value>Databricks CLI简介. (中文(简体) )
-n, --name <value>已知克能克品牌名. (env:名称)
-w, --website <value>已知的HTTPS官方网站. (env:WEBSITE) (英语)
-o, --output <value>品牌持续输出目录. 雅姆,展示,来源, 和视觉参考。 关闭临时目录 。 (env: 关闭)
--model <value>可选的Databricks模型偏好品牌合成. (env: MODEL)
--max-sources <value>要读取的最大一般网络源 。 (默认: 4, 内: MAX Sources)
--source-max-length <value>从每个源页面保留最大字符 。 (默认: 8000, env: Sour MAX LENGTH)
--showcase反应HTML品牌展示和网站模型. (默认:真,内:SHOWCASE)
--no-showcase禁用响应的 html 品牌演示和网站模型 .
-f, --force在已有输出目录中替换文件 。 (默认:假, env: FORCE)
--no-force禁用在现有输出目录中替换文件 .

dbx tunnel

用公用地道和无密码认证前置命令

dbx tunnel [options] [command] [command...]

参数

参数说明
command关闭命令后 --

选项

选项说明
-t, --transport <value>公共地道交通. (选择:"口","口","口","口","口","口":通"口"
--public-domain <value>公有地道域. (env:TUNNEL PUBLIC DOMAIN) (法语)
--subdomain <value>波特尔子域. (env: SUBDOMAIN) (中文(简体) )
--port <value>公共听众端口. (env: DATABRIKKS APP PORT) (法语)
--app-port <value>私人包裹的应用程序端口. (env:TUNNEL APP PORT) (法语)
--allow <value>电子邮件允许列表模式 。 (env:TUNNEL AUTH ALLOW) (法语)
--subject <value>校验电子邮件主题 。 (env:TUNNEL AUTH SUBJECT) (法语)
--brand-name <value>验证电子邮件品牌名称. (env:TUNNEL AUTH BRAND NAME) (法语)
--passkeys密码签入和注册。 (env:TUNNEL AUTH PASKYS) (英语)
--no-passkeys禁用密码签入和注册.
--passkey-name-prefix <value>人化地道密码名的前缀. (env:TUNNEL AUTH PASKEY NAME PREFIX) (英语)
-m, --message <value>验证电子邮件消息 。 (env:TUNNEL AUTH MESSAGE) (英语)
--session-ttl-seconds <value>会话寿命数秒。 (env:TUNNEL AUTH SESSION TTL) (法语)
-c, --code-ttl-seconds <value>一次性代码寿命数秒. (env:TUNNEL AUTH CODE TTL)
--session-cutoff <value>在此值之前已发布的会话无效 。 (env:TUNNEL AUTH SESSION-CUTOFF) (法语)
--storage <value>认证数据库模式 。 (选择:"自发","Lakebase","sqlite", env:TUNNEL AUTH STORAGE)
--sqlite-path <value>本地认证 SQLite 文件 。 (env:TUNNEL AUTH SQLITE PATH) (中文(简体) )
--forward-headers <value>额外的转发请求头模式 。 (env:TUNNEL FORWARD HEADERS) (法语)
-g, --gate-paths <value>需要认证的其他路径前缀 。 (env:TUNNEL GATE PATHS) (法语)
--bind-hosts <value>接口 IP 门听取. (env: BIND HOSTS) (英语)
-i, --insecure没有认证门就运行 。 (env:通尼尔 INSECURE)
--no-insecure禁用没有认证门的运行 .
--frp-server <value>FRP控制主机. (env: FRP SERVER) (法语)
--frp-public-domain <value>FRP公共HTTP域名. (env:TUNNEL FRP PUBLIC DOMAIN) (法语)
--frp-server-port <value>FRP控制口. (env:FRP SERVER PORT) (法语)
--frp-protocol <value>FRP运输协议. (env:FRP PROTOCOL) (法语)
--frp-token <value>FRP认证符. (env:FRP Token) (法语)
--frp-proxy-name <value>FRP代理注册名称. (env:FRP PROXY NAME) (法语)

图标

命令说明
run [options] <command...>环绕命令( 默认动作)
status [options]解析配置并打印
install [transport]安装公共隧道客户端二进制并退出

dbx tunnel run

环绕命令( 默认动作)

dbx tunnel run [options] <command...>

参数

参数说明
command关闭命令后 --

选项

选项说明
-t, --transport <value>公共地道交通. (选择:"口","口","口","口","口","口":通"口"
--public-domain <value>公有地道域. (env:TUNNEL PUBLIC DOMAIN) (法语)
--subdomain <value>波特尔子域. (env: SUBDOMAIN) (中文(简体) )
--port <value>公共听众端口. (env: DATABRIKKS APP PORT) (法语)
--app-port <value>私人包裹的应用程序端口. (env:TUNNEL APP PORT) (法语)
--allow <value>电子邮件允许列表模式 。 (env:TUNNEL AUTH ALLOW) (法语)
--subject <value>校验电子邮件主题 。 (env:TUNNEL AUTH SUBJECT) (法语)
--brand-name <value>验证电子邮件品牌名称. (env:TUNNEL AUTH BRAND NAME) (法语)
--passkeys密码签入和注册。 (env:TUNNEL AUTH PASKYS) (英语)
--no-passkeys禁用密码签入和注册.
--passkey-name-prefix <value>人化地道密码名的前缀. (env:TUNNEL AUTH PASKEY NAME PREFIX) (英语)
-m, --message <value>验证电子邮件消息 。 (env:TUNNEL AUTH MESSAGE) (英语)
--session-ttl-seconds <value>会话寿命数秒。 (env:TUNNEL AUTH SESSION TTL) (法语)
-c, --code-ttl-seconds <value>一次性代码寿命数秒. (env:TUNNEL AUTH CODE TTL)
--session-cutoff <value>在此值之前已发布的会话无效 。 (env:TUNNEL AUTH SESSION-CUTOFF) (法语)
--storage <value>认证数据库模式 。 (选择:"自发","Lakebase","sqlite", env:TUNNEL AUTH STORAGE)
--sqlite-path <value>本地认证 SQLite 文件 。 (env:TUNNEL AUTH SQLITE PATH) (中文(简体) )
--forward-headers <value>额外的转发请求头模式 。 (env:TUNNEL FORWARD HEADERS) (法语)
-g, --gate-paths <value>需要认证的其他路径前缀 。 (env:TUNNEL GATE PATHS) (法语)
--bind-hosts <value>接口 IP 门听取. (env: BIND HOSTS) (英语)
-i, --insecure没有认证门就运行 。 (env:通尼尔 INSECURE)
--no-insecure禁用没有认证门的运行 .
--frp-server <value>FRP控制主机. (env: FRP SERVER) (法语)
--frp-public-domain <value>FRP公共HTTP域名. (env:TUNNEL FRP PUBLIC DOMAIN) (法语)
--frp-server-port <value>FRP控制口. (env:FRP SERVER PORT) (法语)
--frp-protocol <value>FRP运输协议. (env:FRP PROTOCOL) (法语)
--frp-token <value>FRP认证符. (env:FRP Token) (法语)
--frp-proxy-name <value>FRP代理注册名称. (env:FRP PROXY NAME) (法语)

dbx tunnel status

解析配置并打印

dbx tunnel status [options]

选项

选项说明
-t, --transport <value>公共地道交通. (选择:"口","口","口","口","口","口":通"口"
--public-domain <value>公有地道域. (env:TUNNEL PUBLIC DOMAIN) (法语)
--subdomain <value>波特尔子域. (env: SUBDOMAIN) (中文(简体) )
--port <value>公共听众端口. (env: DATABRIKKS APP PORT) (法语)
--app-port <value>私人包裹的应用程序端口. (env:TUNNEL APP PORT) (法语)
--allow <value>电子邮件允许列表模式 。 (env:TUNNEL AUTH ALLOW) (法语)
--subject <value>校验电子邮件主题 。 (env:TUNNEL AUTH SUBJECT) (法语)
--brand-name <value>验证电子邮件品牌名称. (env:TUNNEL AUTH BRAND NAME) (法语)
--passkeys密码签入和注册。 (env:TUNNEL AUTH PASKYS) (英语)
--no-passkeys禁用密码签入和注册.
--passkey-name-prefix <value>人化地道密码名的前缀. (env:TUNNEL AUTH PASKEY NAME PREFIX) (英语)
-m, --message <value>验证电子邮件消息 。 (env:TUNNEL AUTH MESSAGE) (英语)
--session-ttl-seconds <value>会话寿命数秒。 (env:TUNNEL AUTH SESSION TTL) (法语)
-c, --code-ttl-seconds <value>一次性代码寿命数秒. (env:TUNNEL AUTH CODE TTL)
--session-cutoff <value>在此值之前已发布的会话无效 。 (env:TUNNEL AUTH SESSION-CUTOFF) (法语)
--storage <value>认证数据库模式 。 (选择:"自发","Lakebase","sqlite", env:TUNNEL AUTH STORAGE)
--sqlite-path <value>本地认证 SQLite 文件 。 (env:TUNNEL AUTH SQLITE PATH) (中文(简体) )
--forward-headers <value>额外的转发请求头模式 。 (env:TUNNEL FORWARD HEADERS) (法语)
-g, --gate-paths <value>需要认证的其他路径前缀 。 (env:TUNNEL GATE PATHS) (法语)
--bind-hosts <value>接口 IP 门听取. (env: BIND HOSTS) (英语)
-i, --insecure没有认证门就运行 。 (env:通尼尔 INSECURE)
--no-insecure禁用没有认证门的运行 .
--frp-server <value>FRP控制主机. (env: FRP SERVER) (法语)
--frp-public-domain <value>FRP公共HTTP域名. (env:TUNNEL FRP PUBLIC DOMAIN) (法语)
--frp-server-port <value>FRP控制口. (env:FRP SERVER PORT) (法语)
--frp-protocol <value>FRP运输协议. (env:FRP PROTOCOL) (法语)
--frp-token <value>FRP认证符. (env:FRP Token) (法语)
--frp-proxy-name <value>FRP代理注册名称. (env:FRP PROXY NAME) (法语)

dbx tunnel install

安装公共隧道客户端二进制并退出

dbx tunnel install [transport]

参数

参数说明
transportportr, frp, 或两者兼有( 默认: “ portr” )

dbx lakebase-proxy

为 Databricks Lakebase 运行回转 PostgreSQL 代理服务器

dbx lakebase-proxy [options] [command]

选项

选项说明
-V, --version输出版本编号
--postgres-role <value>PostgreSQL角色在认证后承担. (env: POSTGRES ROLE) (法语)
-l, --listen <value>循环收听器地址 。 (默认:tcp://localhost:5432,env:Listen)
-s, --startup-timeout-seconds <value>启动超时数秒。 (默认: 30, env: SAPUP TIMEOUT SECONDS)
--profile <value>准确的Databricks简介. (中文(简体) )

图标

命令说明
url [options]为 Lakebase 目标格式化本地 PostgreSQL URL
service安装和管理桌面服务

dbx lakebase-proxy url

为 Lakebase 目标格式化本地 PostgreSQL URL

dbx lakebase-proxy url [options]

选项

选项说明
-t, --target <value>Lakebase 项目,资源路径,主机,或 URL. (env: TARGET)
--listen <value>本地代理地址 。 (默认:tcp://localhost:5432,env:Listen)

dbx lakebase-proxy service

安装和管理桌面服务

dbx lakebase-proxy service [command]

图标

命令说明
install [options]为当前用户安装并启动服务
start启动已安装的服务
stop停止运行服务
restart重新启动已安装的服务
status打印服务安装和处理状态为 JSON
logs [command...]打印服务日志路径或将其附加到命令中
uninstall停止并删除当前用户的服务

dbx lakebase-proxy service install

为当前用户安装并启动服务

dbx lakebase-proxy service install [options]

选项

选项说明
--start安装后启动服务 。 (默认:真实)
--no-start安装后禁用服务 .
--python-project <value>本地 Python 项目已安装, 而不是注册包 .
--offline从 uv 缓存中安装 Python 包而无需网络访问 。 (默认:虚假)
--no-offline禁用从 uv 缓存中安装 python 包而无需网络访问 .
--wait-for-auth <value>认证准备模式:当服务提供适用的认证前飞行时,自动等待,真实需要,而假跳过. (选择:"自发","真","假",默认:"自发")
--postgres-role <value>PostgreSQL角色在认证后承担. (env: POSTGRES ROLE) (法语)
-l, --listen <value>循环收听器地址 。 (默认:tcp://localhost:5432,env:Listen)
-s, --startup-timeout-seconds <value>启动超时数秒。 (默认: 30, env: SAPUP TIMEOUT SECONDS)
--profile <value>准确的Databricks简介. (中文(简体) )

dbx lakebase-proxy service start

启动已安装的服务

dbx lakebase-proxy service start

dbx lakebase-proxy service stop

停止运行服务

dbx lakebase-proxy service stop

dbx lakebase-proxy service restart

重新启动已安装的服务

dbx lakebase-proxy service restart

dbx lakebase-proxy service status

打印服务安装和处理状态为 JSON

dbx lakebase-proxy service status

dbx lakebase-proxy service logs

打印服务日志路径或将其附加到命令中

dbx lakebase-proxy service logs [command...]

参数

参数说明
command在服务日志路径前运行的命令和参数

dbx lakebase-proxy service uninstall

停止并删除当前用户的服务

dbx lakebase-proxy service uninstall

dbx model-gateway

运行或管理 AppKit Databricks 模型网关

dbx model-gateway [options] [command]

选项

选项说明
-v, --version输出版本编号
--model <value>可选的模糊或精确的模型名. (env: MODEL)
--model-class <value>选择默认模型时使用的可选模型能力类. (选择:"聊天-思考","聊天-平衡","聊天-快","嵌入",入声:MODEL CLASS)
--smart-router <value>智能路由器模式:自动仅在可用时发布广告,真实需要,而虚假则会禁用. (选择:"自发","真","假",默认:"自发",收录:SMART ROUTER)
--smart-router-timeout-ms <value>最多允许一个 Databricks 智能路由器请求 。 (默认: 10000, env: SMART ROUTER TIMEOUT MS)
--smart-router-context-token-budget <value>o200k 基准符号预算用于构建智能路由器任务上下文. (默认:4096, env: SMART ROUTER CONTEXT TOKEN BUDGET) (中文(简体) )
--smart-router-probe-ttl-ms <value>Millyseconds 一个成功的记忆智能路由器能力探测器仍然有效. (默认: 3000, env: SMART ROUTER PROBE TTL MS) (中文(简体) )
--smart-router-probe-refresh-interval-ms <value>在未读取的背景刷新 缓存的智能路由器探测器之间相隔米秒 (默认:3600000, env: SMART ROUTER PROBE REFRESH INTERVAL MS)
--smart-router-route-ttl-seconds <value>秒后逻辑转弯仍被其智能路由器所选择的模式所固定. (默认:21600, env: SMART ROUTER ROUTE TTL SECONDS) (中文(简体) )
--prefer-system-modelsPrefer system.ai服务超越服务端点进行非精确模型选择. (默认:虚假, env: PRIFER SYSTEM MODELS)
--no-prefer-system-models禁用system.ai服务而不是服务端点,用于非精确模型选择.
-l, --listen <value>循环收听器地址 。 (默认:tcp://localhost:4000,env:Listen)
--profile <value>订购用于模型发现和速率限制回落的Databricks剖面图. (中文(简体) )
--body-limit <value>最大JSON请求体型. (默认:"100mb", env: Bodit LIMIT) (中文(简体) )
-r, --runtime-info打印运行时间执行元数据. (默认:假, env: RUNTIME INFO)
--no-runtime-info禁用打印运行时间执行元数据 .
--select-model-from <value>从 JSON 或文本文件中选择一个智能路由器模型; 用于标准输入 。 (env:SELECT MODEL FROM) (法语)

图标

命令说明
service安装和管理桌面服务

dbx model-gateway service

安装和管理桌面服务

dbx model-gateway service [command]

图标

命令说明
install [options]为当前用户安装并启动服务
start启动已安装的服务
stop停止运行服务
restart重新启动已安装的服务
status打印服务安装和处理状态为 JSON
logs [command...]打印服务日志路径或将其附加到命令中
uninstall停止并删除当前用户的服务

dbx model-gateway service install

为当前用户安装并启动服务

dbx model-gateway service install [options]

选项

选项说明
--start安装后启动服务 。 (默认:真实)
--no-start安装后禁用服务 .
--python-project <value>本地 Python 项目已安装, 而不是注册包 .
--offline从 uv 缓存中安装 Python 包而无需网络访问 。 (默认:虚假)
--no-offline禁用从 uv 缓存中安装 python 包而无需网络访问 .
--wait-for-auth <value>认证准备模式:当服务提供适用的认证前飞行时,自动等待,真实需要,而假跳过. (选择:"自发","真","假",默认:"自发")

dbx model-gateway service start

启动已安装的服务

dbx model-gateway service start

dbx model-gateway service stop

停止运行服务

dbx model-gateway service stop

dbx model-gateway service restart

重新启动已安装的服务

dbx model-gateway service restart

dbx model-gateway service status

打印服务安装和处理状态为 JSON

dbx model-gateway service status

dbx model-gateway service logs

打印服务日志路径或将其附加到命令中

dbx model-gateway service logs [command...]

参数

参数说明
command在服务日志路径前运行的命令和参数

dbx model-gateway service uninstall

停止并删除当前用户的服务

dbx model-gateway service uninstall

dbx genie

通过经认证的本地 Databricks 模型网关运行 Genie 代码

dbx genie [options] [genieArgs...]

参数

参数说明
genieArgs争吵和不明旗帜被传送到Genie Code. 单独的包装选项为 --

选项

选项说明
--model <value>可选的模糊或精确的模型名. (env: MODEL)
--model-class <value>选择默认模式时使用的可选聊天能力类 。 (选择:"聊天-思考","聊天-平衡","聊天-快",收录:MODEL CLASS)
-p, --profile <value>模型-出道侧车所使用的 Databricks profile. (中文(简体) )
-g, --gateway-listen <value>为型号出道道侧车分配了回回听器. (默认:tcp://127.0.0.1:0,env:GATEWAY LISTEN)

dbx graphiti

运行 Graphiti 或管理其当前用户桌面服务

dbx graphiti [options] [command]

选项

选项说明
-v, --version输出版本编号
--profile <value>Databricks profile 用于模型发现和认证. (中文(简体) )
-b, --bearer <value>每个 Graphiti HTTP 端点都需要可选的无记名符号 。 (env:GRAPHITI TOKEN) (法语)
-g, --graphiti-home <value>应用程序拥有的 Graphiti 运行时目录 。 (env:GRAPHITI HOME) (法语)
-m, --model-class <value>选择默认模式时使用的可选聊天能力类 。 (选择:"聊天-思考","聊天-平衡","聊天-快",默认:"聊天-快",env: MODEL CLASS)
-t, --temperature <value>向Graphiti LLM客户端传送了样本温度。 (默认:1,env:TEMPERATURE)
--structured-output-mode <value>结构化输出模式传输到 Graphiti 的 OpenAI 提供者 。 (默认:"json object", env: LLM structured UTPUT MODE) (中文(简体) )
--startup-timeout-ms <value>最多允许 Graphiti 运行时间准备好 。 (默认:180000, env: GRAPHITI STARTUP TIMEOUT MS) (中文(简体) )
-l, --listen <value>Graphiti HTTP 监听器 。 (默认:tcp://127.0.0.1:727,env:GRAPHITI LISTEN)
--database-url <value>PostgreSQL URL或Lakebase目标. 允许它使用持续的嵌入式 PostgreSQL. (env:Lakebase endPOINT) (法语)
--database-schema <value>用于Lakebase图表的 PostgreSQL schema. (默认:"dbx tools graphiti", env: GRAPHITI DATABASE SCHEMA) (中文(简体) )
--postgres-role <value>PostgreSQL角色在认证后承担. (env: POSTGRES ROLE) (法语)

图标

命令说明
service安装和管理桌面服务

dbx graphiti service

安装和管理桌面服务

dbx graphiti service [command]

图标

命令说明
install [options]为当前用户安装并启动服务
start启动已安装的服务
stop停止运行服务
restart重新启动已安装的服务
status打印服务安装和处理状态为 JSON
logs [command...]打印服务日志路径或将其附加到命令中
uninstall停止并删除当前用户的服务

dbx graphiti service install

为当前用户安装并启动服务

dbx graphiti service install [options]

选项

选项说明
--start安装后启动服务 。 (默认:真实)
--no-start安装后禁用服务 .
--python-project <value>本地 Python 项目已安装, 而不是注册包 .
--offline从 uv 缓存中安装 Python 包而无需网络访问 。 (默认:虚假)
--no-offline禁用从 uv 缓存中安装 python 包而无需网络访问 .
--wait-for-auth <value>认证准备模式:当服务提供适用的认证前飞行时,自动等待,真实需要,而假跳过. (选择:"自发","真","假",默认:"自发")

dbx graphiti service start

启动已安装的服务

dbx graphiti service start

dbx graphiti service stop

停止运行服务

dbx graphiti service stop

dbx graphiti service restart

重新启动已安装的服务

dbx graphiti service restart

dbx graphiti service status

打印服务安装和处理状态为 JSON

dbx graphiti service status

dbx graphiti service logs

打印服务日志路径或将其附加到命令中

dbx graphiti service logs [command...]

参数

参数说明
command在服务日志路径前运行的命令和参数

dbx graphiti service uninstall

停止并删除当前用户的服务

dbx graphiti service uninstall

版本与发布记录

@dbx-tools/cli 共发布 373 个版本,首次发布于 2026/07/08;过去 12 个月发布了 373 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.9.206latest2026/11/11今天
0.9.2052026/11/111 天前
0.9.2032026/11/074 天前
0.9.2022026/11/065 天前
0.9.2012026/11/056 天前
0.9.2002026/11/056 天前

关于 @dbx-tools/cli 的常见问题

@dbx-tools/cli 是什么?

Dbx 用于工作空间生命周期、 AppKit 环境、 Databricks OAuth 和有门的隧道的 CLI

如何安装 @dbx-tools/cli?

在项目目录运行 npm install @dbx-tools/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 dbx、dbx-genie、dbx-tools、dbx-graphiti、dbx-model-gateway、dbx-lakebase-proxy,可以用 npx dbx 直接运行。

@dbx-tools/cli 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dbx-tools/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@dbx-tools/cli 可以商用吗?

@dbx-tools/cli 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@dbx-tools/cli 的下载量有多少?

根据 npm 官方下载统计,@dbx-tools/cli 在 2026/10/12 – 2026/11/10 这 30 天内被下载 8,767 次,日均约 292 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dbx-tools/cli 还在维护吗?

最新版本 0.9.206 发布于 2026/11/11(今天);至今共发布 373 个版本,其中过去 12 个月发布了 373 个;首次发布于 2026/07/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。