@jonit-dev/night-watch-cli 1.1.3 → 1.1.5

package/README.md

@@ -10,6 +10,17 @@ Night Watch is a battle-tested autonomous PRD executor that uses AI provider CLI
 
 ---
 
+## Table of Contents
+
+- [Quick Start](#quick-start)
+- [Supported Providers](#supported-providers)
+- [Using GLM-5 or Custom Endpoints](#using-glm-5-or-custom-endpoints)
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [License](#license)
+
+---
+
 ## Quick Start
 
 ```bash
@@ -21,7 +32,7 @@ cd your-project
 night-watch init
 
 # 3. Check provider detection
-night-watch run --dry-run    # Shows which provider CLI will be used
+night-watch run --dry-run
 
 # 4. Add your PRD files
 echo "# My First PRD\n\nImplement feature X..." > docs/PRDs/night-watch/my-feature.md
@@ -35,472 +46,83 @@ night-watch install       # Setup automated cron
 
 ## Supported Providers
 
-Night Watch acts as a wrapper/orchestrator that calls CLI-based AI coding tools. The following providers are supported:
-
 | Provider | CLI Command | Auto-Mode Flag | Slash Commands |
 |----------|-------------|----------------|----------------|
 | `claude` | `claude` | `--dangerously-skip-permissions` | `-p "/command-name"` |
 | `codex` | `codex` | `--yolo` | `--prompt "text"` |
 
-**Provider Detection:**
-- Night Watch auto-detects your provider based on the `provider` field in `night-watch.config.json`
 - Default provider is `claude`
-- Change provider with `--provider codex` flag or set `provider: "codex"` in config
-
----
-
-## Installation
-
-### npm (Recommended)
-
-```bash
-npm install -g night-watch-cli
-```
-
-### npx (No install)
-
-```bash
-npx night-watch-cli init
-```
-
-### From Source
-
-```bash
-git clone https://github.com/joaopio/night-watch-cli.git
-cd night-watch-cli
-npm install
-npm run build
-npm link
-```
-
----
-
-## Commands Reference
-
-### `night-watch init`
-
-Initialize Night Watch in your project. Creates all necessary directories, configuration files, and provider slash commands.
-
-```bash
-night-watch init            # Initialize with defaults
-night-watch init --force    # Overwrite existing configuration
-night-watch init --prd-dir docs/prds  # Custom PRD directory
-night-watch init --provider codex     # Use codex provider
-```
-
-**What it creates:**
-- `docs/PRDs/night-watch/done/` — Directory for completed PRDs
-- `docs/PRDs/night-watch/NIGHT-WATCH-SUMMARY.md` — Progress tracking file
-- `logs/` — Log files directory (added to .gitignore)
-- `.claude/commands/night-watch.md` — Claude slash command for PRD execution
-- `.claude/commands/night-watch-pr-reviewer.md` — Claude slash command for PR review
-- `night-watch.config.json` — Configuration file
-
-**Prerequisites:**
-- Git repository
-- GitHub CLI (`gh`) authenticated
-- Provider CLI installed (Claude CLI or Codex)
-
----
-
-### `night-watch run`
-
-Execute the PRD executor. Scans for eligible PRDs and implements them using the configured provider CLI.
-
-```bash
-night-watch run                    # Execute PRD executor
-night-watch run --dry-run          # Show what would be executed (with diagnostics)
-night-watch run --provider codex   # Override provider
-night-watch run --timeout 3600     # Override max runtime (1 hour)
-```
-
----
-
-### `night-watch review`
-
-Execute the PR reviewer. Finds open PRs on night-watch/ or feat/ branches, checks CI status and review scores, and fixes issues.
-
-```bash
-night-watch review                 # Execute PR reviewer
-night-watch review --dry-run       # Show PRs needing work (with diagnostics)
-night-watch review --provider codex # Override provider
-night-watch review --timeout 1800  # Override max runtime (30 min)
-```
-
----
-
-### `night-watch install`
-
-Install crontab entries for automated execution.
-
-```bash
-night-watch install                        # Install with default schedules
-night-watch install --schedule "0 * * * *" # Custom executor schedule
-night-watch install --reviewer-schedule "0 */2 * * *" # Custom reviewer schedule
-night-watch install --no-reviewer          # Skip reviewer cron
-```
-
-**Default Schedules:**
-- Executor: `0 0-15 * * *` (hourly from midnight to 3pm UTC)
-- Reviewer: `0 0,3,6,9,12,15 * * *` (every 3 hours)
+- Change with `--provider codex` flag or `"provider": "codex"` in config
 
 ---
 
-### `night-watch uninstall`
-
-Remove crontab entries for the current project.
-
-```bash
-night-watch uninstall
-```
-
----
+## Using GLM-5 or Custom Endpoints
 
-### `night-watch status`
+Night Watch supports passing custom environment variables to the provider CLI via the `providerEnv` config field. This lets you point the Claude CLI at any Anthropic-compatible endpoint — including **GLM-5**.
 
-Show current Night Watch status including lock files, PRD counts, open PRs, and log file info.
-
-```bash
-night-watch status          # Basic status
-night-watch status --verbose # Detailed status with log snippets
-night-watch status --json    # Output as JSON
-```
-
-**Status shows:**
-- Process status (executor/reviewer running or not)
-- PRD status (pending vs completed)
-- PR status (open PRs on night-watch/feat branches)
-- Crontab status (installed or not)
-- Log file status (size, last lines)
-
----
-
-### `night-watch logs`
-
-View log output from executor and reviewer.
-
-```bash
-night-watch logs                  # View last 50 lines of all logs
-night-watch logs -n 100           # View last 100 lines
-night-watch logs --follow         # Follow logs in real-time
-night-watch logs --type run       # View executor logs only
-night-watch logs --type review    # View reviewer logs only
-```
-
----
-
-## Configuration
-
-Configuration is loaded in this order (later overrides earlier):
-1. Default values
-2. Config file (`night-watch.config.json`)
-3. Environment variables
-4. CLI flags
-
-### Config File
-
-Create `night-watch.config.json` in your project root:
+Add `providerEnv` to your `night-watch.config.json`:
 
 ```json
 {
-  "projectName": "my-project",
-  "defaultBranch": "main",
   "provider": "claude",
-  "reviewerEnabled": true,
-  "prdDir": "docs/PRDs/night-watch",
-  "maxRuntime": 7200,
-  "reviewerMaxRuntime": 3600,
-  "branchPrefix": "night-watch",
-  "branchPatterns": ["feat/", "night-watch/"],
-  "minReviewScore": 80,
-  "maxLogSize": 524288,
-  "cronSchedule": "0 0-15 * * *",
-  "reviewerSchedule": "0 0,3,6,9,12,15 * * *"
+  "providerEnv": {
+    "ANTHROPIC_API_KEY": "your-glm5-api-key",
+    "ANTHROPIC_BASE_URL": "https://your-glm5-endpoint.example.com"
+  }
 }
 ```
 
-### Environment Variables
-
-**Night Watch Config (prefixed with `NW_`):**
-
-| Variable | Config Key |
-|----------|------------|
-| `NW_PRD_DIR` | `prdDir` |
-| `NW_MAX_RUNTIME` | `maxRuntime` |
-| `NW_REVIEWER_MAX_RUNTIME` | `reviewerMaxRuntime` |
-| `NW_BRANCH_PREFIX` | `branchPrefix` |
-| `NW_BRANCH_PATTERNS` | `branchPatterns` (JSON array or comma-separated) |
-| `NW_MIN_REVIEW_SCORE` | `minReviewScore` |
-| `NW_MAX_LOG_SIZE` | `maxLogSize` |
-| `NW_CRON_SCHEDULE` | `cronSchedule` |
-| `NW_REVIEWER_SCHEDULE` | `reviewerSchedule` |
-| `NW_PROVIDER` | `provider` |
-
-### CLI Flags
-
-Flags override all other configuration:
-
-```bash
-night-watch run --provider codex --timeout 3600
-night-watch review --provider claude --timeout 1800
-```
-
----
-
-## PRD Format
-
-Night Watch looks for PRD files in `docs/PRDs/night-watch/` (configurable). PRDs are markdown files with optional dependency declarations.
-
-### Basic PRD
-
-```markdown
-# Feature: User Authentication
-
-## Overview
-Implement user authentication using JWT tokens.
-
-## Requirements
-- [ ] Login endpoint
-- [ ] Logout endpoint
-- [ ] Token refresh
-- [ ] Password hashing
-
-## Acceptance Criteria
-- Users can log in with email/password
-- Tokens expire after 24 hours
-- All endpoints have proper error handling
-```
-
-### PRD with Dependencies
+These variables are:
+- **Injected into the provider CLI process** at runtime (`night-watch run`, `night-watch review`)
+- **Exported in cron entries** when you run `night-watch install`, so automated runs also pick them up
+- **Visible in `--dry-run` output** for easy debugging
 
-```markdown
-# Feature: User Profile
+### Common Use Cases
 
-Depends on: Feature: User Authentication
-
-## Overview
-Add user profile management.
-
-## Requirements
-- [ ] Profile page
-- [ ] Edit profile
-- [ ] Avatar upload
-```
+| Use Case | Environment Variables |
+|----------|----------------------|
+| GLM-5 via custom endpoint | `ANTHROPIC_API_KEY`, `ANTHROPIC_BASE_URL` |
+| Proxy / VPN routing | `HTTPS_PROXY`, `HTTP_PROXY` |
+| Custom model selection | Any provider-specific env var |
 
-When a PRD specifies `Depends on:`, Night Watch will only process it after the dependency's PRD file is moved to `done/`.
+See [Configuration > Provider Environment](docs/configuration.md#provider-environment-providerenv) for full details.
 
 ---
 
-## How It Works
-
-### Architecture Overview
-
-```
-+-------------------------------------------------------------+
-|                     Night Watch CLI                          |
-|  (Node.js wrapper for discoverability, config, distribution) |
-+-------------------------------------------------------------+
-                              |
-                              v
-+-------------------------------------------------------------+
-|                     Bash Scripts                             |
-|  (Battle-tested core logic for PRD execution and review)     |
-|                                                              |
-|  +---------------------+  +--------------------------------+ |
-|  | night-watch-cron.sh |  | night-watch-pr-reviewer-cron.sh | |
-|  |   (PRD Executor)    |  |        (PR Reviewer)            | |
-|  +---------------------+  +--------------------------------+ |
-|              |                          |                     |
-|              +-----------+--------------+                     |
-|                          v                                    |
-|            +-----------------------------+                    |
-|            | night-watch-helpers.sh      |                    |
-|            |   (Shared utilities)        |                    |
-|            +-----------------------------+                    |
-+-------------------------------------------------------------+
-                              |
-                              v
-+-------------------------------------------------------------+
-|                    External Tools                            |
-|                                                              |
-|  +----------------+  +------------+  +------------------+    |
-|  |  Provider CLI  |  | GitHub CLI |  |  Git Worktrees   |    |
-|  | (Claude/Codex) |  |  (PR mgmt) |  |  (Isolation)     |    |
-|  +----------------+  +------------+  +------------------+    |
-+-------------------------------------------------------------+
-```
-
-### PRD Execution Flow
-
-1. **Scan for PRDs** — Find markdown files in `docs/PRDs/night-watch/`
-2. **Check dependencies** — Skip PRDs with unmet dependencies
-3. **Check for open PRs** — Skip PRDs that already have an open PR
-4. **Acquire lock** — Prevent concurrent executions
-5. **Create worktree** — Isolate changes in a git worktree
-6. **Launch Provider CLI** — Execute PRD using provider CLI with slash command
-7. **Verify PR created** — Check that a PR was opened
-8. **Mark done** — Move PRD to `done/` directory
-9. **Cleanup** — Remove lock files and worktrees
-
-### PR Review Flow
-
-1. **Find open PRs** — Search for PRs on `night-watch/` or `feat/` branches
-2. **Check CI status** — Identify failed checks
-3. **Check review scores** — Find PRs with score < 80/100
-4. **Acquire lock** — Prevent concurrent executions
-5. **Launch Provider CLI** — Execute PR fix using provider CLI with slash command
-6. **Cleanup** — Remove lock files
-
----
-
-## Troubleshooting
-
-### "Current directory is not a git repository"
-
-Run `night-watch init` from the root of a git repository:
-
-```bash
-cd your-project
-git init  # if not already a git repo
-night-watch init
-```
-
-### "GitHub CLI (gh) is not authenticated"
-
-Authenticate with GitHub:
-
-```bash
-gh auth login
-```
-
-### "Provider CLI is not available"
-
-Install the appropriate provider CLI:
-
-```bash
-# Claude CLI
-# Follow instructions at https://docs.anthropic.com/en/docs/claude-cli
-
-# Codex CLI
-# Follow instructions at https://github.com/openai/codex
-```
-
-### "Night Watch is already installed"
-
-Uninstall first, then reinstall:
-
-```bash
-night-watch uninstall
-night-watch install
-```
-
-### "Lock file exists but process not running"
+## Installation
 
-Remove stale lock files:
+### npm (Recommended)
 
 ```bash
-rm /tmp/night-watch-*.lock
+npm install -g night-watch-cli
 ```
 
-Or use `night-watch status --verbose` to check which lock files are stale.
-
-### Logs not being created
-
-Ensure the logs directory exists and is writable:
+### npx (No install)
 
 ```bash
-mkdir -p logs
-chmod 755 logs
+npx night-watch-cli init
 ```
 
-### PRD not being processed
-
-Check:
-1. PRD is in the correct directory (`docs/PRDs/night-watch/`)
-2. Dependencies are satisfied (check `done/` directory)
-3. No open PR exists for this PRD
-4. Run `night-watch run --dry-run` to see what would be processed
-
----
-
-## Contributing
-
-### Development Setup
+### From Source
 
 ```bash
-git clone https://github.com/joaopio/night-watch-cli.git
+git clone https://github.com/jonit-dev/night-watch-cli.git
 cd night-watch-cli
-npm install
-```
-
-### Build
-
-```bash
-npm run build
-```
-
-### Test
-
-```bash
-npm test
-```
-
-### Run in Development
-
-```bash
-npm run dev -- init
-```
-
-### Project Structure
-
-```
-night-watch-cli/
-+-- bin/
-|   +-- night-watch.mjs      # ESM entry point
-+-- src/
-|   +-- cli.ts               # CLI entry
-|   +-- config.ts            # Config loader
-|   +-- types.ts             # TypeScript types
-|   +-- constants.ts         # Default values
-|   +-- commands/            # Command implementations
-|   |   +-- init.ts
-|   |   +-- run.ts
-|   |   +-- review.ts
-|   |   +-- install.ts
-|   |   +-- uninstall.ts
-|   |   +-- status.ts
-|   |   +-- logs.ts
-|   +-- utils/
-|       +-- shell.ts         # Shell execution
-|       +-- crontab.ts       # Crontab management
-+-- scripts/                 # Bundled bash scripts
-|   +-- night-watch-cron.sh
-|   +-- night-watch-pr-reviewer-cron.sh
-|   +-- night-watch-helpers.sh
-+-- templates/               # Template files
-|   +-- night-watch.md
-|   +-- night-watch-pr-reviewer.md
-|   +-- night-watch.config.json
-+-- dist/                    # Compiled output
+npm install && npm run build && npm link
 ```
 
 ---
 
-## Publishing (For Maintainers)
-
-To publish a new version to npm:
-
-```bash
-# 1. Update version in package.json
-# 2. Build and test
-npm run build
-npm test
-
-# 3. Publish to npm (public access)
-npm run publish:npm
-```
+## Documentation
 
-The `publish:npm` script runs `npm publish --access public`.
+| Document | Description |
+|----------|-------------|
+| [Commands Reference](docs/commands.md) | All CLI commands and their options |
+| [Configuration](docs/configuration.md) | Config file, environment variables, CLI flags, `providerEnv`, notifications |
+| [PRD Format](docs/prd-format.md) | How to write PRDs, dependencies, lifecycle |
+| [Architecture](docs/architecture.md) | System design, execution flows, project structure |
+| [Troubleshooting](docs/troubleshooting.md) | Common errors and how to fix them |
+| [Contributing](docs/contributing.md) | Development setup, building, testing, publishing |
 
 ---
 

package/dist/cli.js

@@ -10,6 +10,8 @@ import { installCommand } from './commands/install.js';
 import { uninstallCommand } from './commands/uninstall.js';
 import { statusCommand } from './commands/status.js';
 import { logsCommand } from './commands/logs.js';
+import { prdCommand } from './commands/prd.js';
+import { doctorCommand } from './commands/doctor.js';
 // Get package.json version
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -31,5 +33,9 @@ installCommand(program);
 uninstallCommand(program);
 statusCommand(program);
 logsCommand(program);
+// Register prd command
+prdCommand(program);
+// Register doctor command
+doctorCommand(program);
 program.parse();
 //# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,2BAA2B;AAC3B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACtC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;AAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;AAEvE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,kDAAkD,CAAC;KAC/D,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhC,wBAAwB;AACxB,WAAW,CAAC,OAAO,CAAC,CAAC;AAErB,uBAAuB;AACvB,UAAU,CAAC,OAAO,CAAC,CAAC;AAEpB,0BAA0B;AAC1B,aAAa,CAAC,OAAO,CAAC,CAAC;AAEvB,4BAA4B;AAC5B,cAAc,CAAC,OAAO,CAAC,CAAC;AACxB,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAC1B,aAAa,CAAC,OAAO,CAAC,CAAC;AACvB,WAAW,CAAC,OAAO,CAAC,CAAC;AAErB,OAAO,CAAC,KAAK,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,2BAA2B;AAC3B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACtC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;AAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;AAEvE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,kDAAkD,CAAC;KAC/D,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhC,wBAAwB;AACxB,WAAW,CAAC,OAAO,CAAC,CAAC;AAErB,uBAAuB;AACvB,UAAU,CAAC,OAAO,CAAC,CAAC;AAEpB,0BAA0B;AAC1B,aAAa,CAAC,OAAO,CAAC,CAAC;AAEvB,4BAA4B;AAC5B,cAAc,CAAC,OAAO,CAAC,CAAC;AACxB,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAC1B,aAAa,CAAC,OAAO,CAAC,CAAC;AACvB,WAAW,CAAC,OAAO,CAAC,CAAC;AAErB,uBAAuB;AACvB,UAAU,CAAC,OAAO,CAAC,CAAC;AAEpB,0BAA0B;AAC1B,aAAa,CAAC,OAAO,CAAC,CAAC;AAEvB,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/commands/doctor.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Doctor command for Night Watch CLI
+ * Validates webhook configuration and checks system health
+ */
+import { Command } from "commander";
+import { WebhookConfig } from "../types.js";
+/**
+ * Validate a single webhook configuration and return a list of issues.
+ * Returns an empty array if the webhook is valid.
+ */
+export declare function validateWebhook(webhook: WebhookConfig): string[];
+/**
+ * Register the doctor command on the program
+ */
+export declare function doctorCommand(program: Command): void;
+//# sourceMappingURL=doctor.d.ts.map

package/dist/commands/doctor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../src/commands/doctor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKpC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAW5C;;;GAGG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,EAAE,CAmDhE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAiGpD"}