dibbla

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Dibbla CLI

Dibbla CLI

The
dibbla
CLI scaffolds projects and manages applications, databases, secrets, and workflows on the Dibbla platform. Deployed apps are available at
https://<alias>.dibbla.com
.
The
dibbla
CLI 可生成项目脚手架,并在Dibbla平台上管理应用数据库密钥工作流。部署完成的应用可通过
https://<alias>.dibbla.com
访问。

Commands at a glance

常用命令概览

AreaCommands
Feedback
feedback <message>
,
feedback list
,
feedback delete <id>
Deploy
deploy [path] [--alias name]
— deploy from directory
Apps
apps list
,
apps update <alias>
,
apps delete <alias>
Db
db list
,
db create
,
db delete
,
db dump
,
db restore
,
db connect
Secrets
secrets list
,
secrets set
,
secrets get
,
secrets delete
(global or
-d <alias>
)
Workflows
workflows list
,
get
,
create
,
update
,
delete
,
validate
,
execute
,
url
,
api-docs
Nodes
nodes add <wf>
,
nodes remove <wf> <id>
Edges
edges add <wf> "<edge>"
,
edges remove
,
edges list
Inputs
inputs set <wf> <node> <input> <value>
Tools
tools add <wf> <agent> <tool>
,
tools remove
Revisions
revisions list <wf>
,
revisions create
,
revisions restore
Functions
functions list
,
functions get <server> <name>
功能领域命令
反馈
feedback <message>
,
feedback list
,
feedback delete <id>
部署
deploy [path] [--alias name]
— 从指定目录部署
应用管理
apps list
,
apps update <alias>
,
apps delete <alias>
数据库管理
db list
,
db create
,
db delete
,
db dump
,
db restore
,
db connect
密钥管理
secrets list
,
secrets set
,
secrets get
,
secrets delete
(全局生效或通过
-d <alias>
指定应用)
工作流管理
workflows list
,
get
,
create
,
update
,
delete
,
validate
,
execute
,
url
,
api-docs
节点管理
nodes add <wf>
,
nodes remove <wf> <id>
边管理
edges add <wf> "<edge>"
,
edges remove
,
edges list
输入管理
inputs set <wf> <node> <input> <value>
工具管理
tools add <wf> <agent> <tool>
,
tools remove
版本管理
revisions list <wf>
,
revisions create
,
revisions restore
函数管理
functions list
,
functions get <server> <name>

Agent guidelines

Agent 使用指南

Interactive prompts: The following commands prompt for confirmation and will block if run non-interactively. Always pass
--yes
(or
-y
) when running these as an agent:
  • dibbla apps delete <alias> --yes
  • dibbla db delete <name> --yes
  • dibbla secrets delete <name> --yes
  • dibbla workflows delete <name> --yes
  • dibbla nodes remove <wf> <id> --yes
  • dibbla feedback delete <id> --yes
Deploying an app for the first time:
  1. Check if the app already exists:
    dibbla apps list
  2. If it does not exist, deploy with all required environment variables included in the deploy command — there is no app to attach them to yet:
    bash
    dibbla deploy . --alias my-app -e DATABASE_URL=postgres://... -e API_KEY=secret -e NODE_ENV=production
  3. If it already exists, use
    --update
    for a zero-downtime rolling update:
    bash
    dibbla deploy . --alias my-app --update
    To change env vars on an existing app, use
    apps update
    instead:
    bash
    dibbla apps update my-app -e NEW_VAR=value
Key rules:
  • --force
    causes downtime (tears down and redeploys). Prefer
    --update
    for existing apps.
  • --force
    and
    --update
    are mutually exclusive.
  • Environment variables set via
    deploy -e
    or
    apps update -e
    persist across updates — you only need to pass them once.
  • Use
    --quiet
    /
    -q
    on
    db list
    ,
    db delete
    ,
    db connect
    for machine-readable output in scripts.
  • db create --deployment <alias>
    scopes the database and its auto-created
    DATABASE_URL
    secret to a specific deployment.
  • db connect
    prints a psql-compatible connection string via the Dibbla database proxy. Use
    -q
    for scripting:
    psql $(dibbla db connect mydb -q)
    .
Pre-deploy guardrails: Before calling
dibbla deploy
, you MUST complete the pre-deploy checklist and present findings to the user. Always wait for explicit user confirmation before deploying or fixing issues — never deploy autonomously. See guardrails.md for the full checklist.
交互式提示: 以下命令会触发确认提示,如果在非交互式场景下运行会阻塞。作为Agent运行这些命令时,请始终传入
--yes
(或
-y
)参数:
  • dibbla apps delete <alias> --yes
  • dibbla db delete <name> --yes
  • dibbla secrets delete <name> --yes
  • dibbla workflows delete <name> --yes
  • dibbla nodes remove <wf> <id> --yes
  • dibbla feedback delete <id> --yes
首次部署应用:
  1. 检查应用是否已存在:
    dibbla apps list
  2. 如果应用不存在,部署时请携带所有必填的环境变量——此时还没有可绑定环境变量的应用:
    bash
    dibbla deploy . --alias my-app -e DATABASE_URL=postgres://... -e API_KEY=secret -e NODE_ENV=production
  3. 如果应用已存在,使用
    --update
    参数执行零停机滚动更新:
    bash
    dibbla deploy . --alias my-app --update
    如需修改已有应用的环境变量,请改用
    apps update
    命令:
    bash
    dibbla apps update my-app -e NEW_VAR=value
核心规则:
  • --force
    参数会导致服务中断(销毁现有实例后重新部署)。对于已有应用,优先使用
    --update
    参数。
  • --force
    --update
    参数互斥,不可同时使用。
  • 通过
    deploy -e
    apps update -e
    设置的环境变量会在后续更新中持久保留——只需设置一次即可。
  • db list
    db delete
    db connect
    命令中使用
    --quiet
    /
    -q
    参数可输出适合脚本处理的机器可读格式。
  • db create --deployment <alias>
    可将数据库及其自动生成的
    DATABASE_URL
    密钥绑定到指定部署实例。
  • db connect
    会通过Dibbla数据库代理输出兼容psql的连接字符串。脚本场景下可使用
    -q
    参数:
    psql $(dibbla db connect mydb -q)
部署前防护规则: 调用
dibbla deploy
之前,你必须完成部署前检查清单并将结果告知用户。部署或修复问题前请始终等待用户明确确认——绝对不要自主执行部署操作。完整检查清单请参考 guardrails.md

Additional resources

更多资源

  • Full command and flag reference: see reference.md for usage, arguments, and all flags.
  • Usage examples: see examples.md for copy-paste examples and scripting patterns.
  • Pre-deploy guardrails: see guardrails.md for the mandatory pre-deploy checklist.
When suggesting or generating
dibbla
commands, use the reference for exact syntax and the examples for typical workflows.
  • 完整命令与参数参考: 查看 reference.md 了解用法、参数和所有可选标志。
  • 使用示例: 查看 examples.md 了解可直接复用的示例和脚本编写模式。
  • 部署前防护规则: 查看 guardrails.md 了解强制要求的部署前检查清单。
建议或生成
dibbla
命令时,请参考参考文档获取准确语法,参考示例文档了解典型工作流。