命令面板

以键盘驱动的面板，可用 shell 风格的命令操作 Ceum——列出实体、跳转到实体、控制计时器、清除、获取帮助。以反引号开启。

CLI 是一个以键盘驱动的面板，让你用简短的 shell 风格命令在 Ceum 中移动并缩小工作区范围。它的命令与 MCP 集成向外部工具公开的操作相同——面板是在应用内运行这些操作的方式，并且计划推出通过 MCP 连接的独立终端程序。

开启面板

在任何文本字段之外按下反引号（`）。面板会从底部向上滑出，覆盖在导航栏之上。按 Escape 即可关闭。

面板内你会看到：

  • 一个具备 tab 补全的命令输入框。
  • 你近期命令及其输出的记录稿（最后 100 条）。
  • 用于调整面板高度的把手。

命令

CLI 主要用于列出和跳转到你的数据，以及计时器控制。主要的命令家族有：

  • <entity> list（例如 clients list、tasks list、invoices list）——列出客户、项目、任务、发票、订阅、交易、文档、事件，以及你的状态／类型／关系配置。许多列表接受筛选条件，例如 tasks list --projectId P-3、transactions list --type income 或 documents list --clientId C-1，并可用 --columns 选择要显示的内容。
  • timer start|stop|resume|pause|status|discard|list——不离开键盘即可控制运行中的时间会话。停止时会报告会话名称与经过的时长。
  • <entity> get——详细显示某一张发票或某一份文档。
  • clear——清除记录稿。
  • help——命令参考（见下方）。

<entity> list 的结果可点击：每一行都链接到对应的项目（配置行则链接到其设置编辑页面），因此 CLI 同时也是深入跳进工作区的快捷方式。跟随任何链接都会进行导航并关闭面板。

获取帮助

help 会根据你指定的精确程度进行调整：

  • help——以三栏对齐、按命令家族分组的总览：根名词（每个家族显示一次）、子命令，以及其参数（例如 documents 家族在单一 documents 标题下列出 list、get、versions、delete，每个都附其选项）。
  • help <family>——同样的分组列表，但缩小到单一家族（例如 help timer）。
  • help <command>——单一命令的完整细节，包含每个选项的数据类型以及它是否为必填（例如 help transactions list）。

选项都有类型：--start <ISO datetime>、--amount <number>、--type <income|expense>。当某命令缺少必填选项时，错误会逐一列出每一项——每行一个——并附上其数据类型，而不只是说“required”。

命令语法

此参考是从命令本身生成的，因此它始终与 CLI 实际接受的内容一致。必填选项没有括号；可选的则以 [ ] 包裹。

clear
clients list [--columns <id|name|status|email|company|uuid>] [--id <string>]
documents delete [--id <string>]
documents get [--id <string>]
documents list [--columns <id|name|description|clients|projects|updatedAt|uuid>] [--id <string>] [--projectId <string>] [--clientId <string>]
documents versions [--id <string>]
events create --title <string> --start <ISO datetime> --end <ISO datetime> [--description <string>]
events list [--columns <title|start|end|recurring|description|uuid>] [--from <date>] [--to <date>]
exit
help [command]
invoices delete [--id <string>]
invoices flag [--id <string>] [--description <string>]
invoices get <id> [--id <string>]
invoices list [--columns <id|invoiceNumber|client|amount|status|issueDate|dueDate|currency|flagged|uuid>] [--id <string>] [--clientId <string>]
invoices unflag [--id <string>]
mail logs list [--columns <to|subject|status|sentAt|templateType|uuid>]
mail templates create --name <string> --subject <string> --body <string> --template-type <message_client|send_invoice|send_overdue_reminder|send_project_email|send_task_email>
mail templates list [--columns <name|subject|templateType|uuid>]
projects list [--columns <id|name|status|client|uuid>] [--id <string>] [--clientId <string>]
relationship-types list [--columns <scope|typeId|name|enabled|order|color|uuid>] [--scope <project|task>]
statuses list [--columns <entityType|name|statusId|enabled|finished|order|color|uuid>] [--entity-type <client|project|task|invoice>]
subscriptions create --name <string> --cost <number> --billing-period <weekly|monthly|quarterly|yearly> --billing-date <string> [--currency <string>] [--tags <string>] [--notes <string>] [--inactive]
subscriptions list [--columns <name|cost|billingPeriod|billingsPerPeriod|billingDate|currency|active|uuid>]
task-types list [--columns <typeId|name|enabled|billable|standalone|embeddable|order|color|uuid>]
tasks list [--columns <id|name|status|type|deadline|uuid>] [--id <string>] [--projectId <string>] [--clientId <string>]
timer discard
timer list [--columns <name|startTime|endTime|status|task|uuid>]
timer pause
timer resume
timer start [--name <string>] [--taskId <string>]
timer status
timer stop
transactions create --date <date> --desc <string> --amount <number> --type <income|expense> [--currency <string>] [--tags <string>] [--clientId <string>] [--projectId <string>] [--taskId <string>]
transactions list [--columns <date|desc|amount|type|currency|client|project|uuid>] [--type <income|expense>] [--projectId <string>] [--clientId <string>]

命令执行期间

需要连接服务器的命令会显示实时指示——一个小型旋转图标与以秒计的经过时间——直到完成为止，让你能分辨请求是慢还是卡住了。

Tab 补全

补全的运作方式与 shell 中相同：

  • 按一次 Tab——填入最长的共同前缀。
  • 按两次 Tab——显示所有候选项。
  • 它会补全命令关键字、标志名称与标志值——包含多值列，因此 tasks list --columns name,<Tab> 会提供剩余的列。

提示与特殊情况

  • 点击以聚焦。 点击面板空白处的任何位置都会聚焦命令输入框，因此你无需瞄准输入行即可开始输入。
  • 觉得反引号别扭？ 若你的键盘布局让反引号难以按到，你仍可通过键盘快捷键中的组合键链来切换 CLI。
  • 快速清单就在附近。 CLI 面板从底部升起，而快速清单面板则从侧边滑入——两者不会重叠。
  • 记录稿是临时的。 关闭面板会保留记录稿；重新加载页面则会清除它。

在移动设备上

移动应用程序不提供此功能——请从网页应用程序管理。

相关文章