create-principles-disciple 1.0.0 → 1.73.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Principles Disciple Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Principles Disciple Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,30 +1,108 @@
 # create-principles-disciple
 
-Interactive CLI installer for [Principles Disciple](https://github.com/csuzngjh/principles) OpenClaw plugin.
+MVP-First Prerequisite Installer for [Principles Disciple](https://github.com/csuzngjh/principles).
+
+## What This Installer Delivers
+
+| Component | Status | Description |
+|-----------|--------|-------------|
+| Runtime integration | Installed & verified | OpenClaw plugin with MVP activation channels |
+| Operator CLI (`pd`) | Installed & verified | Command-line tool for diagnostics and demo |
+| Review console | Installed & configured | Local web UI for principle review (loopback only) |
+
+### MVP Activation Channels
+
+Three MVP-Core channels are always enabled and cannot be disabled:
+
+- `prompt` — soft principle injection
+- `code_tool_hook` — RuleHost hard enforcement
+- `defer_archive` — graceful deferral
+
+Quiet and gone capabilities (gfi, nocturnal, idle_trigger, model_training, trainer) are **not surfaced** to users.
 
 ## Usage
 
+### Interactive
+
 ```bash
 npx create-principles-disciple
 ```
 
+### Non-interactive / JSON
+
+```bash
+npx create-principles-disciple --yes --workspace "/path/to/workspace" --json
+```
+
+`--json` implies non-interactive. Output is exactly one parseable JSON object on stdout.
+
 ## Options
 
+```text
+--lang <en|zh>          Language preference (default: zh)
+--force                 Force overwrite existing installation
+--smart                 Smart merge mode (generate .update files)
+--yes                   Non-interactive mode with defaults
+--non-interactive       Skip prompts
+--workspace <path>      Workspace directory
+--json                  Output result as JSON (implies non-interactive)
 ```
---lang <en|zh>    Language preference (default: en)
---force           Force overwrite existing installation
+
+## Post-Install Verification
+
+The installer automatically verifies the installation during setup:
+
+1. **Feature flags** — `.pd/feature-flags.yaml` is generated and validated
+2. **Story A demo** — `pd demo story-a` is executed to confirm runtime integration
+3. **Console health** — `/api/health` is checked on the local console instance
+
+After a successful install, you can re-verify at any time:
+
+```bash
+pd runtime canary --workspace "<path>" --json
+```
+
+## Console
+
+The installer delivers a local pd-console web UI for principle review.
+
+### Starting the Console
+
+```bash
+pd console --workspace "/path/to/workspace" --no-auth
 ```
 
+The console listens on **127.0.0.1 only** (loopback) — it is not accessible from other machines on the network. When using `--no-auth`, loopback binding is enforced; the server will refuse to start if `--no-auth` is combined with a non-loopback host.
+
+Open `http://127.0.0.1:3100` in your browser to access the console.
+
+### Console Security
+
+- Default binding: `127.0.0.1` (loopback only)
+- `--no-auth` is only permitted with loopback binding
+- For network access, use `--host <ip>` with `--token <secret>` or set `PD_CONSOLE_TOKEN` environment variable
+
+## Rerun / Reinstall
+
+Re-running the installer updates the feature-flags.yaml. All three MVP-Core channels
+are always enabled — the installer does not allow partial disabling of core channels.
+The installer reads actual enabled channels from disk and reports them in the output.
+
+## Update Failure Recovery
+
+If an update fails, the installer automatically restores the previous working installation from backup. No manual recovery steps are needed.
+
+If the installer cannot restore the backup (rare), re-run the installer with `--force`.
+
 ## Commands
 
-- `install` - Install OpenClaw plugin (default)
-- `uninstall` - Remove OpenClaw plugin
-- `status` - Show installation status
+- `install` — Install PD (default command)
+- `uninstall` — Remove PD (preserves user data)
+- `status` — Show installation status
 
 ## Requirements
 
 - Node.js >= 18.0.0
-- Claude Code CLI
 
 ## License
 

package/console/dist/lib/utils.d.ts

@@ -0,0 +1,2 @@
+import { type ClassValue } from "clsx";
+export declare function cn(...inputs: ClassValue[]): string;

package/console/dist/lib/utils.js

@@ -0,0 +1,5 @@
+import { clsx } from "clsx";
+import { twMerge } from "tailwind-merge";
+export function cn(...inputs) {
+    return twMerge(clsx(inputs));
+}

package/console/dist/server/config/AuthConfig.d.ts

@@ -0,0 +1,14 @@
+import type { IncomingMessage } from 'node:http';
+export interface AuthConfigOptions {
+    cliToken?: string;
+    envToken?: string;
+    noAuth?: boolean;
+}
+export declare class AuthConfig {
+    private readonly token;
+    private readonly enabled;
+    constructor(opts?: AuthConfigOptions);
+    isEnabled(): boolean;
+    getToken(): string | null;
+    isAuthenticated(req: IncomingMessage): boolean;
+}

package/console/dist/server/config/AuthConfig.js

@@ -0,0 +1,36 @@
+import * as crypto from 'crypto';
+export class AuthConfig {
+    token;
+    enabled;
+    constructor(opts = {}) {
+        const token = opts.cliToken ?? opts.envToken ?? null;
+        this.enabled = !opts.noAuth && token !== null && token.length > 0;
+        this.token = token;
+    }
+    isEnabled() {
+        return this.enabled;
+    }
+    getToken() {
+        return this.token;
+    }
+    isAuthenticated(req) {
+        if (!this.enabled) {
+            return true;
+        }
+        const authHeader = req.headers.authorization;
+        if (typeof authHeader !== 'string') {
+            return false;
+        }
+        const match = /^Bearer\s+(.+)$/i.exec(authHeader);
+        if (!match) {
+            return false;
+        }
+        const [, provided] = match;
+        const providedBuf = Buffer.from(provided, 'utf8');
+        const expectedBuf = Buffer.from(this.token, 'utf8');
+        if (providedBuf.length !== expectedBuf.length) {
+            return false;
+        }
+        return crypto.timingSafeEqual(providedBuf, expectedBuf);
+    }
+}

package/console/dist/server/config/WorkspaceConfigStore.d.ts

@@ -0,0 +1,15 @@
+import type { WorkspaceEntry, WorkspaceConfig } from '../types/index.js';
+export declare class WorkspaceConfigStore {
+    private readonly configDir;
+    private readonly configPath;
+    private readonly entries;
+    constructor(configDir?: string);
+    getWorkspaces(): WorkspaceEntry[];
+    getWorkspace(name: string): WorkspaceEntry | null;
+    addWorkspace(name: string, workspacePath: string): void;
+    updateWorkspace(name: string, updates: Partial<WorkspaceConfig>): void;
+    removeWorkspace(name: string): void;
+    updateSyncTime(name: string): void;
+    private load;
+    private save;
+}

package/console/dist/server/config/WorkspaceConfigStore.js

@@ -0,0 +1,100 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+const CONFIG_DIR_NAME = '.pd-console';
+const WORKSPACES_FILE = 'workspaces.json';
+export class WorkspaceConfigStore {
+    configDir;
+    configPath;
+    entries;
+    constructor(configDir) {
+        this.configDir = configDir ?? path.join(os.homedir(), CONFIG_DIR_NAME);
+        this.configPath = path.join(this.configDir, WORKSPACES_FILE);
+        this.entries = this.load();
+    }
+    getWorkspaces() {
+        return this.entries;
+    }
+    getWorkspace(name) {
+        return this.entries.find(e => e.name === name) ?? null;
+    }
+    addWorkspace(name, workspacePath) {
+        if (!name || name.length > 128) {
+            throw new Error('Workspace name must be between 1 and 128 characters');
+        }
+        if (name.includes('/') || name.includes('\\')) {
+            throw new Error('Workspace name cannot contain slashes');
+        }
+        if (this.entries.some(e => e.name === name)) {
+            throw new Error(`Workspace "${name}" already exists`);
+        }
+        this.entries.push({
+            name,
+            path: path.resolve(workspacePath),
+            lastSync: null,
+            config: {
+                workspaceName: name,
+                enabled: true,
+                displayName: null,
+                syncEnabled: true,
+            },
+        });
+        this.save();
+    }
+    updateWorkspace(name, updates) {
+        const entry = this.entries.find(e => e.name === name);
+        if (!entry) {
+            throw new Error(`Workspace "${name}" not found`);
+        }
+        if (entry.config) {
+            entry.config = { ...entry.config, ...updates };
+        }
+        else {
+            entry.config = {
+                workspaceName: name,
+                enabled: true,
+                displayName: null,
+                syncEnabled: true,
+                ...updates,
+            };
+        }
+        this.save();
+    }
+    removeWorkspace(name) {
+        const index = this.entries.findIndex(e => e.name === name);
+        if (index === -1) {
+            throw new Error(`Workspace "${name}" not found`);
+        }
+        this.entries.splice(index, 1);
+        this.save();
+    }
+    updateSyncTime(name) {
+        const entry = this.entries.find(e => e.name === name);
+        if (entry) {
+            entry.lastSync = new Date().toISOString();
+            this.save();
+        }
+    }
+    load() {
+        if (!fs.existsSync(this.configPath)) {
+            return [];
+        }
+        try {
+            const raw = fs.readFileSync(this.configPath, 'utf8');
+            const parsed = JSON.parse(raw);
+            if (!Array.isArray(parsed)) {
+                return [];
+            }
+            return parsed;
+        }
+        catch {
+            return [];
+        }
+    }
+    save() {
+        fs.mkdirSync(this.configDir, { recursive: true });
+        const tmpPath = this.configPath + '.tmp';
+        fs.writeFileSync(tmpPath, JSON.stringify(this.entries, null, 2), 'utf8');
+        fs.renameSync(tmpPath, this.configPath);
+    }
+}

package/console/dist/server/index.d.ts

@@ -0,0 +1 @@
+export declare function main(): Promise<void>;