命令列

以鍵盤驅動的面板，可用 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 面板從底部升起，而快速清單面板則從側邊滑入——兩者不會重疊。
  • 紀錄稿是暫時的。 關閉面板會保留紀錄稿；重新載入頁面則會清除它。

在行動裝置上

行動應用程式不提供此功能——請從網頁應用程式管理。

相關文章