Skip to content

CLI Flags

This page covers two separate programs. The desktop app is the Electron executable you install. The Ptah CLI is the @hive-academy/ptah-cli npm package, which provides the ptah command in a terminal.

The desktop app accepts one positional argument.

Terminal window
Ptah [workspace-path]

If workspace-path points to a directory, Ptah opens it as the active workspace on startup. Relative paths resolve against the current working directory.

The desktop app accepts no other flags. It reads one environment variable.

VariableValuesPurpose
PTAH_LOG_LEVELerror, warn, info, debug, traceSet the log level for one run.

Set PTAH_LOG_LEVEL=debug before you file a bug. See Logs & Diagnostics for where the log file lands.

The ptah command is a separate npm package. Run ptah --help for the full command list, and ptah <command> --help for one command. The command groups include init, config, harness, chat, doctor, packs, agent-cli, interact, mcp-serve, and tui.

ptah interact — embedded Anthropic-compatible proxy

Section titled “ptah interact — embedded Anthropic-compatible proxy”

ptah interact can boot an embedded HTTP proxy that exposes an Anthropic-compatible API surface, optionally re-exporting Ptah’s workspace MCP tools. Use it for external clients or supervisors that already speak the Anthropic protocol.

FlagArgumentPurpose
--proxy-startBoot the embedded Anthropic-compatible HTTP proxy
--proxy-port<n>TCP port (0 = OS-assigned)
--proxy-host<host>Bind host (default 127.0.0.1)
--proxy-expose-workspace-toolsSurface workspace MCP tools through the proxy

The bound address is printed on stderr as:

[ptah] proxy listening on http://127.0.0.1:54321

Supervisors can scrape that line to discover the live address when --proxy-port=0 is used.

Open a specific workspace with debug logging:

Terminal window
# Windows PowerShell
$env:PTAH_LOG_LEVEL = 'debug'
& "C:\Users\<you>\AppData\Local\Programs\Ptah\Ptah.exe" "D:\projects\my-app"
# macOS
PTAH_LOG_LEVEL=debug /Applications/Ptah.app/Contents/MacOS/Ptah ~/code/my-app
# Linux
PTAH_LOG_LEVEL=debug ./Ptah-*.AppImage ~/code/my-app