@shaifulshabuj-waymarks/cli 0.2.0 → 0.3.1

package/README.md

@@ -0,0 +1,213 @@
+# Waymark
+
+**Control what AI agents can do in your codebase.**
+
+Waymark sits between your team and any AI agent.
+Every file action is intercepted, logged, and checked
+against your policies before it executes.
+Dangerous commands are blocked. Sensitive paths
+require human approval. Everything is reversible.
+
+---
+
+## The Problem
+
+AI agents like Claude Code are powerful.
+They can also write to your .env, run rm -rf,
+or modify your database schema without asking.
+
+You find out after it happens.
+
+## The Solution
+
+Waymark intercepts every action before it runs:
+
+| Agent tries to...          | Waymark does...                        |
+|----------------------------|----------------------------------------|
+| Write to .env              | Blocks it instantly. Logged.           |
+| Run rm -rf                 | Blocks it instantly. Logged.           |
+| Pipe curl to bash          | Blocks it instantly. Logged.           |
+| Modify src/db/schema.ts    | Holds it. Asks for your approval.      |
+| Write to src/              | Allows it. Logged with full rollback.  |
+| Read any file              | Logged with path and content snapshot. |
+
+---
+
+## Install
+
+```bash
+cd your-project
+npx @shaifulshabuj-waymarks/cli init
+npx @shaifulshabuj-waymarks/cli start
+```
+
+Restart Claude Code. Done.
+Waymark is now active in this project.
+
+---
+
+## How It Works
+
+```
+Your Prompt
+    ↓
+Claude Code
+    ↓
+Waymark MCP Server  ← intercepts here
+    ↓
+Policy Engine
+    ↓
+allowed  → executes + logged
+blocked  → stopped + logged
+pending  → held + approval required
+    ↓
+Dashboard: http://localhost:3001
+```
+
+---
+
+## Dashboard
+
+Open **http://localhost:3001** after running
+`npx @shaifulshabuj-waymarks/cli start`.
+
+- See every agent action in real time
+- Approve or reject pending actions
+- Roll back any write with one click
+- Filter by allowed / blocked / pending
+
+---
+
+## Configuration
+
+Edit `waymark.config.json` in your project root:
+
+```json
+{
+  "policies": {
+    "allowedPaths": [
+      "./src/**",
+      "./data/**",
+      "./README.md"
+    ],
+    "blockedPaths": [
+      "./.env",
+      "./.env.*",
+      "./package-lock.json",
+      "/etc/**"
+    ],
+    "blockedCommands": [
+      "rm -rf",
+      "DROP TABLE",
+      "regex:\\|\\s*bash",
+      "regex:\\$\\(curl"
+    ],
+    "requireApproval": [
+      "./src/db/**",
+      "./waymark.config.json"
+    ]
+  }
+}
+```
+
+### Policy Rules
+
+**allowedPaths** — Agent can read and write these.
+Supports glob patterns.
+
+**blockedPaths** — Agent can never touch these.
+Takes priority over allowedPaths.
+
+**blockedCommands** — Bash commands containing
+these strings are blocked. Prefix with `regex:`
+for pattern matching.
+
+**requireApproval** — Actions on these paths are
+held until a human approves from the dashboard.
+
+---
+
+## CLI Commands
+
+```bash
+npx @shaifulshabuj-waymarks/cli init    # Set up Waymark in current project
+npx @shaifulshabuj-waymarks/cli start   # Start dashboard + MCP server (background)
+npx @shaifulshabuj-waymarks/cli stop    # Stop the running servers
+npx @shaifulshabuj-waymarks/cli status  # Check if server is running
+npx @shaifulshabuj-waymarks/cli logs    # View recent actions in terminal
+npx @shaifulshabuj-waymarks/cli logs --pending   # Show only pending actions
+npx @shaifulshabuj-waymarks/cli logs --blocked   # Show only blocked actions
+```
+
+---
+
+## Slack Notifications
+
+Get notified when an agent action needs approval:
+
+```bash
+# Add to .env in your project
+WAYMARK_SLACK_WEBHOOK_URL=https://hooks.slack.com/...
+WAYMARK_SLACK_CHANNEL=#engineering
+WAYMARK_BASE_URL=http://localhost:3001
+```
+
+Create a Slack webhook at:
+api.slack.com/apps → Incoming Webhooks
+
+---
+
+## Works With
+
+- **Claude Code** — native MCP integration,
+  zero configuration after init
+- **Any MCP-compatible agent** — register
+  the Waymark MCP server in your agent config
+- More integrations coming
+
+---
+
+## Requirements
+
+- Node.js 18 or higher
+- Claude Code (for MCP integration)
+- macOS or Linux (Windows support coming)
+
+---
+
+## Roadmap
+
+- [ ] Team approval routing
+  (assign approvals to specific teammates)
+- [ ] Session-level rollback
+  (undo an entire agent run at once)
+- [ ] CLI agent wrapping
+  (waymark run <any-agent-command>)
+- [ ] Proxy mode
+  (drop-in for any OpenAI-compatible agent)
+- [ ] Email notifications
+- [ ] Windows support
+
+---
+
+## Contributing
+
+Waymark is MIT licensed and open to contributions.
+
+1. Fork the repo
+2. Create a feature branch
+3. Open a pull request
+
+Please open an issue before starting large changes.
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE)
+
+---
+
+Built for developers who want to use AI agents
+seriously — without giving them unsupervised
+access to production systems.

package/dist/commands/logs.js

@@ -37,7 +37,7 @@ async function run() {
         rows = await res.json();
     }
     catch {
-        console.log('Waymark is not running. Start with: waymark start');
+        console.log('Waymark is not running. Start with: npx @shaifulshabuj-waymarks/cli start');
         return;
     }
     if (pendingOnly)

package/dist/commands/start.js

@@ -72,7 +72,7 @@ function run() {
     const waymarkDir = path.join(projectRoot, '.waymark');
     const pidFile = path.join(waymarkDir, 'waymark.pid');
     if (!fs.existsSync(configPath)) {
-        console.error('waymark.config.json not found. Run waymark init first.');
+        console.error('waymark.config.json not found. Run: npx @shaifulshabuj-waymarks/cli init');
         process.exit(1);
     }
     // Guard: already running
@@ -82,7 +82,7 @@ function run() {
             if (isAlive(saved.api) || isAlive(saved.mcp)) {
                 console.log('Waymark is already running.');
                 console.log('Dashboard:  http://localhost:3001');
-                console.log('Run "waymark stop" to stop it.');
+                console.log('Run "npx @shaifulshabuj-waymarks/cli stop" to stop it.');
                 process.exit(0);
             }
         }
@@ -120,6 +120,6 @@ function run() {
         console.log('Waymark started (background)');
         console.log('Dashboard:  http://localhost:3001');
         console.log('MCP server: active (stdio)');
-        console.log('Run "waymark stop" to stop.');
+        console.log('Run "npx @shaifulshabuj-waymarks/cli stop" to stop.');
     }, 1500);
 }

package/dist/commands/status.js

@@ -49,7 +49,7 @@ function isAlive(pid) {
 async function run() {
     const pidFile = path.join(process.cwd(), '.waymark', 'waymark.pid');
     if (!fs.existsSync(pidFile)) {
-        console.log('Waymark is not running. Start with: waymark start');
+        console.log('Waymark is not running. Start with: npx @shaifulshabuj-waymarks/cli start');
         return;
     }
     let saved;
@@ -57,12 +57,12 @@ async function run() {
         saved = JSON.parse(fs.readFileSync(pidFile, 'utf8'));
     }
     catch {
-        console.log('Waymark is not running. Start with: waymark start');
+        console.log('Waymark is not running. Start with: npx @shaifulshabuj-waymarks/cli start');
         return;
     }
     if (!isAlive(saved.api) && !isAlive(saved.mcp)) {
         fs.unlinkSync(pidFile);
-        console.log('Waymark is not running (crashed). Start with: waymark start');
+        console.log('Waymark is not running (crashed). Start with: npx @shaifulshabuj-waymarks/cli start');
         return;
     }
     try {
@@ -82,6 +82,6 @@ async function run() {
         console.log(`Total actions logged: ${total}`);
     }
     catch {
-        console.log('Waymark is not running. Start with: waymark start');
+        console.log('Waymark is not running. Start with: npx @shaifulshabuj-waymarks/cli start');
     }
 }

package/dist/index.js

@@ -17,7 +17,7 @@ switch (command) {
         require('./commands/logs').run();
         break;
     default:
-        console.log('Usage: waymark <init|start|stop|status|logs>');
+        console.log('Usage: npx @shaifulshabuj-waymarks/cli <init|start|stop|status|logs>');
         console.log('');
         console.log('Commands:');
         console.log('  init    Set up Waymark in the current project');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shaifulshabuj-waymarks/cli",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Control what AI agents can do in your codebase",
   "author": "Waymark <hello@waymarks.dev>",
   "license": "MIT",
@@ -31,7 +31,7 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@shaifulshabuj-waymarks/server": "0.2.0"
+    "@shaifulshabuj-waymarks/server": "0.3.1"
   },
   "devDependencies": {
     "@types/node": "^20.11.5",