docyrus-cli-app

Docyrus CLI

docyrus CLI（@docyrus/docyrus）命令索引。此技能是现有命令的快速参考。如需了解任何命令的准确标志、参数和负载结构，请运行其帮助命令——这是权威且始终最新的信息来源：

docyrus <command> --help                 # flags + args for a command or group
docyrus <command> <subcommand> --help     # drill into a subcommand
docyrus <command> --llms                  # machine-readable (LLM) manifest of a command tree

约定（适用于所有命令）

• **输出：**添加 --json（或 --format <toon|json|yaml|md|jsonl>）以获取机器可读输出；--verbose 会显示完整信封。
• 标志形式：--help 会以 kebab-case 格式打印标志（--app-slug、--from-file）；解析器也接受 camelCase 架构键（--appSlug、--fromFile）。两种形式都可用。
• 选择器成对互斥——每组只能传入其中一个；CLI 会解析另一个：--appId | --appSlug、--dataSourceId | --dataSourceSlug、--fieldId | --fieldSlug 等。
• **写入负载：**变更命令接受便捷标志，和／或 --data '<json>'／--from-file <path.json>。显式标志会覆盖 JSON 中的值。复杂对象（嵌套的 data、field_mapping、架构、条件）必须通过 --data／--from-file 传入。
• **设置范围与会话：**设置存储在项目本地的 ./.docyrus/ 文件夹中（从 cwd 向上查找）；-g／--global 使用 ~/.docyrus/。身份验证和当前租户按范围区分。
• 备用方式：docyrus curl <path> [-X .. -d .. -G] 可向任意 API 路径发送经过身份验证的请求——用于没有专用命令的端点（例如模板渲染、webform 项目）。对于复杂读取，可使用 -G -d '{...}' 将查询参数作为一个 JSON 对象传入（系统会为你进行 URL 编码）。

命令索引

运行 docyrus <command> --help 查看标志。标记为 (group) 的命令组有自己的子命令——使用 --help 深入查看。

auth — 身份验证、账户、租户

login · logout · who · tenant · set-tokens · sso-session · github · sandbox · git-credential · accounts（命令组）· tenants（命令组）

apps — 应用与应用范围内的资源

create（需要 --slug）· clone · templates · check-slug（创建应用 + 本地开发环境引导——参见 docyrus-create-app）· list · update · delete · restore · permanent-delete · set-agent-context · actions（命令组：操作的 CRUD + 运行）· ai-tools（命令组：应用范围内 AI 工具的 CRUD——参见 docyrus-app-ai-tools）

ds — 数据记录（CRUD + 子对象）

get（数据源元数据）· list（查询记录）· create · update · delete · comments（命令组：记录评论）· files（命令组：记录文件附件，包括 upload）

dsql — 逻辑 SQL 查询

query（对 appSlug.dataSourceSlug 执行只读 SELECT）· ask（自然语言 → 查询 → 执行）· generate（自然语言 → 查询，不执行）· schema（命令组：发现架构）。参见 docyrus-dsql-query-design。 自定义查询记录（已保存的参数化查询模板）：list-custom-query · get-custom-query · create-custom-query · update-custom-query · delete-custom-query · run-custom-query（执行；--debug = 编译后的 SQL，--simulate = EXPLAIN ANALYZE）。参见 docyrus-custom-query。

studio — 开发应用架构 CRUD

数据源：create-data-source · get-data-source · update-data-source · delete-data-source · restore-data-source · permanent-delete-data-source · list-data-sources · bulk-create-data-sources 字段：create-field · get-field · update-field · delete-field · list-fields · create-fields-batch · update-fields-batch · delete-fields-batch · search-fields 枚举：create-enums · update-enums · delete-enums · list-enums · search-enums · search-enum-sets 数据视图：create-data-view · get-data-view · update-data-view · delete-data-view · list-data-views 表单：create-form · get-form · update-form · delete-form · list-forms Web 表单：create-webform · get-webform · update-webform · delete-webform · list-webforms（参见 docyrus-webform-design） HTML/PDF 模板：create-html-template · get-html-template · update-html-template · delete-html-template · list-html-templates（参见 docyrus-print-pdf-template-design） 邮件模板：create-email-template · get-email-template · update-email-template · delete-email-template · list-email-templates（参见 docyrus-email-template-design） → 设计指南：docyrus-data-source-design。

automation — 工作流

自动化：create · get · update · delete · list 触发器：create-trigger · update-trigger · delete-trigger · get-trigger · list-triggers 操作节点：create-node · update-node · delete-node · get-node · list-nodes → 设计指南：docyrus-automation-design。

agent — 自定义 AI Agent 及子资源

Agent：create · get · update · delete · list · upload 子资源组（每组均支持 list/get/create/update/delete）：models · tools · data-sources · docs · mcps · connections · dynamic-contexts · workflow-steps · deployments · deployment-tools · deployment-data-sources · workflow-jobs（只读 + delete）· tasks · recurring-tasks → 设计指南：docyrus-agent-design。

messaging — 邮件与通知

accounts（列出租户邮件账户）· email（分组：包括 send）

account — 租户账户管理

brands（分组：租户品牌 CRUD — list · get · create · update · delete · fetch-from-website）· user-profile（分组：get · update 当前用户自己的资料）· tenant-preferences（分组：get · update 租户的区域/格式偏好设置）

• brands — 租户的视觉形象、字体、品牌语调和内容指南（tenant_brand）。create/update 接受 camelCase 便捷标志（与 snake_case DTO 键一一对应），以及 --data / --from-file；create 必须提供 --name。→ 管理指南（包括完整字段目录）：docyrus-tenant-brand-management。
• user-profile — 已认证用户自己的资料（get/update，无需选择器）。update 标志涵盖自助服务字段：--firstname · --lastname · --mobile · --dateOfBirth · --gender · --timeZone · --language。
• tenant-preferences — 工作区的区域/格式设置。update 仅限租户管理员使用，接受 camelCase 标志（与 snake_case --data 键一一对应），以及 --data / --from-file：--language · --locale · --timeZone · --startWeekOn · --fiscalYear · --dateFormat · --dateTimeFormat · --timeFormat · --longDateFormat · --businessHoursBegin · --businessHoursEnd · --dailyWorkingHours（秒）· --weeklyWorkingCapacity · --timeRounding · --baseCurrency · --currencyAbbrPosition（BEFORE/AFTER）· --decimalPrecision · --decimalSeparator · --thousandSeparator。get 仅返回偏好设置记录（camelCase 键）。

→ user-profile / tenant-preferences 指南（包括完整字段目录）：docyrus-account-settings。

connect — 连接器与操作

list-connectors · get-connector · list-connections · get-action · run-action · curl（通过连接器的提供方身份验证发送请求） → 使用指南：docyrus-integrations-and-connectors。

discover — 租户 OpenAPI 发现

api（下载规范） · namespaces · path · endpoint · entity · search

curl — 原始 API

docyrus curl <path> [-X <method>] [-d <body>] [-G] [-H <header>] — 向任意 Docyrus API 路径发送经过身份验证的请求。

• 请求体： docyrus curl -X POST /v1/apps -d '{"name":"..."}' — JSON 格式的 -d 会作为请求体发送。
• 查询参数： 使用 -G 时，将一个单一 JSON 对象传给 -d——每个键都会成为查询参数，嵌套值会转换为 JSON 字符串，所有值都会自动进行 URL 编码。这是发送复杂读取请求（columns、filters、childQueries）而无需转义的方式： docyrus curl "/v1/apps/<app>/data-sources/<ds>/items/<id>" -G -d '{"columns":"id,rel(id,name),app_child__ref","childQueries":[{"alias":"app_child__ref","from":"app_child","using":"ref","columns":"name"}]}'
• -d 只能指定一个值（不可重复），且没有 --data-urlencode——上面的 -G JSON 对象形式可替代两者。

AI Agent 与运行时

docy "<prompt>"（与平台的主 AI Agent 聊天） · worky（pi Cowork Agent） · cody / coder（pi 编码 Agent） · server（从 pi Agent 到 AI SDK useChat 的 HTTP 桥接）

browser — 浏览器自动化（本地 Chrome 或远程 Cloudflare）

start · url · nav · snapshot · click · fill · select · eval · run-script · screenshot · content · console · network · cookies · devtools · info · tabs · wait · close

knowledge — 仓库知识图谱（开发工具）

search · section · locate · refs · expand · check · doctor · audit-staged · pre-commit · list-impacted · init · generate-initial · refresh · config · hook

project-plan — 仓库跟踪的项目计划（开发工具）

show · summary · list-phases · list-features · list-tasks · find-tasks · get-task · upsert-phase · upsert-feature · upsert-task · set-task-status · set-order · ensure · check · config · create-linked-todo · upsert-from-architect · upsert-from-plan

release — 版本管理

new-version · status

tui — 终端 UI

docyrus tui — 启动 OpenTUI 终端 UI（需要 Bun；如果未安装 Bun，会在交互式终端中提示安装）。

内置功能

docyrus completions（Shell 补全） · docyrus mcp add（注册为 MCP 服务） · docyrus skills add（同步技能文件） · 全局选项 --mcp（以 MCP stdio 服务模式启动）。

相关技能

如需创建应用和引导本地开发（docyrus apps create / clone / templates），请使用 docyrus-create-app。如需设计这些命令所管理的内容，请使用专门的技能：docyrus-data-source-design、docyrus-automation-design、docyrus-agent-design、docyrus-app-ai-tools、docyrus-email-template-design、docyrus-print-pdf-template-design、docyrus-webform-design、docyrus-acl-design（docyrus acl）、docyrus-tenant-brand-management（docyrus account brands）、docyrus-account-settings（docyrus account user-profile / tenant-preferences）、docyrus-dsql-query-design、docyrus-custom-query（通过 docyrus dsql *-custom-query 管理已保存的查询记录）。如需了解平台架构和概念：docyrus-platform。如需在应用代码中使用 REST API：docyrus-api-dev。