Install Principles Disciple
One command installs everything: runtime hooks, pd CLI, and the review console. The installer checks your environment and auto-launches the console.
Step 1 · Prerequisites
- Node.js ≥ 18 — nodejs.org
- OpenClaw — OpenClaw official install(OpenClaw host only; Codex host can skip with --host codex)
Step 2 · One-command install
npx create-principles-disciple --yesInstalls three components in one pass:
- Runtime hooks — capture pain signals and inject approved principles while the agent runs
- pd CLI — CLI tool: health checks, diagnostics, console launch
- Review console（pd-console）— browser UI to review and approve principles
--yes skips the npx install confirmation; Installer auto-detects Node and OpenClaw and provides official download links if missing.
Step 3 · Register PD gateway (OpenClaw host)
openclaw gateway --forceAfter install, register the PD gateway in OpenClaw. Use --force for first-time registration or to overwrite a previous version. PD hooks become active once registered. Codex host skips this step.
Step 4 · After install · Launch the review console
The review console is installed together with PD — no separate install. The installer auto-launches it and opens /welcome on first run. Reopen it anytime with:
pd console open --workspace "<your-workspace-path>"Binds to 127.0.0.1:3100 on your machine only; if the port is busy it auto-tries the next local port. To verify the install is healthy:
pd runtime canary --workspace "<your-workspace-path>" --jsonA healthy status means the pipeline works; degraded means a non-fatal issue (e.g. a fresh install not exercised yet, blocked queue tasks, or orphan candidates) — the console still works; follow summary / recommendedNextActions in the output.
Desktop PD Companion (Windows)
Prefer no terminal? PD Companion turns the console into a resident desktop app: its own window, a system tray icon, and real-time approval/update notifications.
Prerequisite: PD must already be installed (Companion is an add-on to an existing PD install, not a replacement).
v1 installers are unsigned — if SmartScreen appears: More info → Run anyway.
Codex host (CLI / Desktop)
codex plugin marketplace add csuzngjh/principlescodex plugin add principles-disciple@principlesRequires Codex CLI >= 0.147 and Node >= 20. After installing the plugin, run $pd-setup in a Codex session to initialize the workspace, then trust the PD hooks via /hooks. $pd-review opens the owner console; $pd-disable stops PD instantly.