語言EN
首頁
文件
參考資料 / CLI 參考

CLI 參考

安裝後的 command 是 heddle。預設會操作目前工作目錄;除非你傳入 --cwd 指定其他工作區。

主要指令

heddle                       # Start interactive terminal chat
heddle chat                  # Start interactive terminal chat
heddle ask "<goal>"          # Run a one-shot prompt and save it as a session
heddle daemon                # Start the local browser control plane
heddle init                  # Create a local .heddle/config.json template

常用 flag

--cwd <path>

針對另一個工作區路徑執行。

--model <name>

選擇 active model。

--max-steps <n>

限制 agent loop 長度。

--prefer-api-key

優先使用 provider API key,而不是已儲存的 OpenAI OAuth credential。

Provider auth

heddle auth status
heddle auth login openai
heddle auth login openai --no-browser
heddle auth logout openai

Memory 指令

heddle memory status
heddle memory init
heddle memory list [path]
heddle memory read <path> [--offset n] [--max-lines n]
heddle memory search <query> [--path path] [--max-results n]
heddle memory validate [--repair]
heddle memory maintain [--dry-run] [--reconcile]

Heartbeat 指令

heddle heartbeat start [--every 30m] [--task "<task>"] [--poll 60s] [--once]
heddle heartbeat task add --id <id> --task "<task>" [--every 15m]
heddle heartbeat task list
heddle heartbeat task show <id>
heddle heartbeat task enable <id>
heddle heartbeat task disable <id>
heddle heartbeat run [--task <id>]
heddle heartbeat runs list [--task <id>] [--limit 10]
heddle heartbeat runs show <run-id|latest> [--task <id>]

Heartbeat 指令會連到 live control-plane server,或在需要時啟動 embedded server,讓 terminal 與 browser client 使用相同的 task 與 run-record shape。

Interactive chat 指令

/help
/model
/model list
/model set <query>
/model <name>
/reasoning
/reasoning set <query>
/reasoning <low|medium|high>
/reasoning default
/auth
/session list
/session choose <query>
/session new [name]
/session switch <id>
/session continue <id>
/session rename <name>
/session pin
/session unpin
/session close <id>
/continue
/compact
/drift
/drift on
/drift off
!<command>

Workspace state

Heddle 會把工作區本地 state 放在 .heddle/。Saved session 使用 .heddle/chat-sessions.catalog.json,以及 .heddle/chat-sessions/ 下的 per-session file。Session name、pin state、archive state、model choice 與 reasoning effort 都會跟著 saved session 保存。Browser control plane 可以註冊並切換本地工作區,但每個工作區都保有自己的 session、trace、memory 與 task。