pretticlaw 0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# Contributing to Pretticlaw
+
+Thank you for your interest in contributing to **Pretticlaw**! We welcome contributions from everyone.
+
+## Getting Started
+
+1. **Fork** the repository on [GitHub](https://github.com/prettiflow/pretticlaw).
+2. **Clone** your fork locally:
+   ```bash
+   git clone https://github.com/<your-username>/pretticlaw.git
+   cd pretticlaw
+   ```
+3. **Install dependencies**:
+   ```bash
+   npm install
+   ```
+4. **Build** the project:
+   ```bash
+   npm run build
+   ```
+5. **Link** for local testing:
+   ```bash
+   npm link
+   ```
+
+## Development Workflow
+
+1. Create a new branch from `main`:
+   ```bash
+   git checkout -b feat/my-feature
+   ```
+2. Make your changes.
+3. Run the build to verify everything compiles:
+   ```bash
+   npm run build
+   ```
+4. Run tests:
+   ```bash
+   npm test
+   ```
+5. Commit your changes with a clear message:
+   ```bash
+   git commit -m "feat: add support for new provider"
+   ```
+6. Push and open a Pull Request against `main`.
+
+## Commit Convention
+
+We use conventional commits:
+
+| Prefix | Usage |
+|---|---|
+| `feat:` | New feature |
+| `fix:` | Bug fix |
+| `docs:` | Documentation only |
+| `refactor:` | Code change that neither fixes a bug nor adds a feature |
+| `test:` | Adding or updating tests |
+| `chore:` | Tooling, CI, or dependency updates |
+
+## Project Structure
+
+```
+src/
+├── agent/         # Agent loop, context, memory, skills, tools
+├── bus/           # Event bus and async queue
+├── channels/      # Discord, Telegram, stub channels
+├── cli/           # CLI commands
+├── config/        # Config loader and schema
+├── cron/          # Cron service and types
+├── dashboard/     # Dashboard HTML assets
+├── heartbeat/     # Heartbeat service
+├── providers/     # LLM providers (OpenAI, Anthropic, Groq, OpenRouter, custom)
+├── session/       # Session manager
+├── skills/        # Built-in skills (cron, github, memory, weather, etc.)
+├── templates/     # Agent prompt templates
+├── utils/         # Helpers
+└── web/           # Web server for dashboard
+```
+
+## Adding a New Provider
+
+1. Create a new file in `src/providers/` (e.g., `my-provider.ts`).
+2. Extend `BaseProvider` from `src/providers/base.ts`.
+3. Register it in `src/providers/registry.ts`.
+4. Add any config schema changes to `src/config/schema.ts`.
+
+## Adding a New Tool
+
+1. Create a new file in `src/agent/tools/` (e.g., `my-tool.ts`).
+2. Extend `BaseTool` from `src/agent/tools/base.ts`.
+3. Register it in `src/agent/tools/registry.ts`.
+
+## Adding a New Skill
+
+1. Create a new directory under `src/skills/` (e.g., `src/skills/my-skill/`).
+2. Add a `SKILL.md` file describing the skill.
+3. The skill will be auto-discovered at runtime.
+
+## Code Style
+
+- **TypeScript** — all source code lives in `src/` and compiles to `dist/`.
+- Follow existing patterns and conventions in the codebase.
+- Keep functions small and focused.
+- Prefer explicit types over `any`.
+
+## Reporting Issues
+
+Please [open an issue](https://github.com/prettiflow/pretticlaw/issues) with:
+- A clear description of the problem.
+- Steps to reproduce.
+- Expected vs. actual behavior.
+- Your environment (OS, Node version, Pretticlaw version).
+
+## Links
+
+- [Prettiflow](https://prettiflow.tech) — our main platform
+- [Pretticlaw](https://prettiflow.tech/claw) — this project
+
+---
+
+<div align="center">
+  <sub>Built with ❤️ by the <a href="https://prettiflow.tech">Prettiflow</a> team</sub>
+</div>

package/README.md

@@ -0,0 +1,150 @@
+<div align="center">
+  <img src="/assets/logo.png" alt="Pretticlaw" width="320">
+  <h1>Pretticlaw</h1>
+  <p><strong>Lightweight AI Assistant That Lives in Your Computer.</strong></p>
+  <p>Inspired by <a href="https://openclaw.ai">OpenClaw</a>.</p>
+  <p>
+    <a href="https://prettiflow.tech/claw"><strong>prettiflow.tech/claw</strong></a>
+    · <a href="https://prettiflow.tech">prettiflow.tech</a>
+    · <a href="https://openclaw.ai">openclaw.ai</a>
+    · <a href="https://github.com/prettiflow/pretticlaw/blob/main/LICENSE">MIT</a>
+  </p>
+</div>
+
+---
+
+## What is Pretticlaw?
+
+Pretticlaw is a **minimal yet full-featured** agent platform that ships with:
+
+- Zero boilerplate CLI: `pretticlaw agent`, `pretticlaw gateway`, `pretticlaw doctor`.
+- A **rich browser dashboard** on port 6767 with tabs for chat, channels, cron, settings, and status.
+- Tool-call aware chat + spinner/hover cues + live channel/cron wiring.
+- Multi-provider support: <a href="https://platform.openai.com">OpenAI</a>, <a href="https://docs.anthropic.com">Anthropic</a>, <a href="https://console.groq.com">Groq</a>, <a href="https://openrouter.ai">OpenRouter</a>, and more, all tuned for tool-call support.
+
+Part of the <a href="https://prettiflow.tech">Prettiflow</a> ecosystem, the first infrastructure for AI-built software.
+
+## Use Cases
+
+### 📈 Around-the-Clock Market Intelligence
+
+Pretticlaw can monitor stocks, crypto, forex, and commodities in real time, delivering automated alerts, trend summaries, and portfolio snapshots while you sleep. Set up a cron job and wake up to a full market briefing every morning.
+
+### 🚀 Your Software Engineer Intern
+
+Need a REST API scaffolded, a React dashboard wired up, or a database migration written? Pretticlaw reads your codebase, writes production-grade code, runs shell commands, and iterates on bugs, acting as a full-stack engineer that never clocks out.
+
+### 📅 Intelligent Daily Planner
+
+From scheduling meetings to sending reminders and organizing your to-do list, Pretticlaw manages your daily workflow. It learns your habits through memory, prioritizes tasks, and keeps your routine on track with scheduled heartbeat check-ins.
+
+### 📚 Personal Research and Knowledge Companion
+
+Ask Pretticlaw anything: summarize a paper, search the web for the latest docs, compile notes from multiple sources, or maintain a personal knowledge base. It fetches, reads, and distills information so you can focus on what matters.
+
+## Quick Install
+
+```bash
+npm install -g pretticlaw
+pretticlaw onboarding
+pretticlaw gateway         # start gateway + dashboard
+pretticlaw agent -m "Hello"
+```
+
+## Running Locally
+
+1. **Global binary**: `pretticlaw` is published as an npm CLI (call `pretticlaw --help`).
+2. **Development**: clone the <a href="https://github.com/prettiflow/pretticlaw">repo</a>, run `npm install`, `npm run build`, `npm link` to test changes.
+3. **Dashboard**: while the gateway runs, visit <a href="http://localhost:6767/chat">`http://localhost:6767/chat`</a> to interact, adjust channels, tweak cron jobs, or inspect status.
+
+## Providers
+
+Pretticlaw supports multiple LLM providers out of the box:
+
+| Provider | Link | Notes |
+|---|---|---|
+| **OpenAI** | <a href="https://platform.openai.com">platform.openai.com</a> | GPT-4o, GPT-4, GPT-3.5, full tool-call support |
+| **Anthropic** | <a href="https://docs.anthropic.com">docs.anthropic.com</a> | Claude 4, Claude 3.5 Sonnet, tool-use ready |
+| **Groq** | <a href="https://console.groq.com">console.groq.com</a> | GPT-OSS-120B, Llama 4, ultra-fast inference |
+| **OpenRouter** | <a href="https://openrouter.ai">openrouter.ai</a> | Unified access to 200+ models |
+| **Custom** | - | Any OpenAI-compatible endpoint |
+
+Configure your provider during `pretticlaw onboarding` or via `~/.pretticlaw/config.json`.
+
+## Channel Onboarding
+
+`pretticlaw onboarding` walks you through:
+1. Provider / model / API key selection.
+2. Whether you want a chat channel (Telegram / WhatsApp).
+3. Channel token input, stored directly in `~/.pretticlaw/config.json`.
+
+Want to tweak later? Update the dashboard <a href="http://localhost:6767/channels">`/channels`</a> tab or edit `~/.pretticlaw/config.json`.
+
+## Cron + Heartbeat
+
+- Add jobs with `pretticlaw cron add --name "digest" --every 3600 --message "report"`.
+- List jobs: `pretticlaw cron list`.
+- Run a job: `pretticlaw cron run <id>`.
+- Heartbeat wakes every 30m and executes tasks in `~/.pretticlaw/workspace/HEARTBEAT.md`.
+
+## Command Reference
+
+| Command | Purpose |
+|---|---|
+| `pretticlaw onboard` | Scaffold config/workspace + optional channel token wizard |
+| `pretticlaw agent` | Chat interactively (arrow keys + tool hints) |
+| `pretticlaw agent -m "<msg>"` | One-off agent request |
+| `pretticlaw gateway` | Start gateway + dashboard (listen on `[port]/chat`) |
+| `pretticlaw doctor` | Validate provider/model configuration |
+| `pretticlaw channels status` | Show channel health |
+| `pretticlaw channels login` | Link WhatsApp |
+| `pretticlaw status` | Print provider/model/channel summary |
+| `pretticlaw cron ...` | Manage scheduled jobs |
+
+You can also edit channels/config from the dashboard. The server automatically saves your choices.
+
+
+## 🌐 Agent Social Network
+
+Pretticlaw is capable of linking to the **Agent Social Network** (agent community). Just send one message and your Pretticlaw joins automatically!
+
+| Platform | How to Join (send this message to your Pretticlaw) |
+|---|---|
+| <a href="https://moltbook.com">Moltbook</a> | `Read https://moltbook.com/skill.md and follow the instructions to join Moltbook` |
+| <a href="https://clawdchat.ai">ClawdChat</a> | `Read https://clawdchat.ai/skill.md and follow the instructions to join ClawdChat` |
+
+Simply send the command above to your Pretticlaw (via CLI or any chat channel), and it will handle the rest.
+
+## Architecture
+
+- **Data model**: Session/cron/heartbeat patterns. JSONL sessions, CronService persistence, heartbeat triggers.
+- **Providers**: <a href="https://platform.openai.com">OpenAI</a> · <a href="https://docs.anthropic.com">Anthropic</a> · <a href="https://console.groq.com">Groq</a> · <a href="https://openrouter.ai">OpenRouter</a> + local custom endpoints via Litellm.
+- **Tools**: exec/read/write/list/edit, web search/fetch, cron, spawn message tool.
+- **Dashboard**: React (ESM) served via lightweight HTTP handler from assets copied into `dist/dashboard`.
+
+## Links
+
+| | |
+|---|---|
+| **Prettiflow** | <a href="https://prettiflow.tech">prettiflow.tech</a> |
+| **Pretticlaw** | <a href="https://prettiflow.tech/claw">prettiflow.tech/claw</a> |
+
+## Contributing
+
+We welcome contributions! Please see <a href="./CONTRIBUTING.md">CONTRIBUTING.md</a> for guidelines.
+
+## Contact
+
+Reach the team at <a href="mailto:team@prettiflow.tech">team@prettiflow.tech</a>.
+
+## Getting Help
+
+- File issues on the <a href="https://github.com/prettiflow/pretticlaw/issues">repo</a>.
+- Email us at <a href="mailto:team@prettiflow.tech">team@prettiflow.tech</a>.
+- For quick debugging, run `pretticlaw doctor` and view errors on the dashboard.
+
+---
+
+<div align="center">
+  <sub>Built by <a href="https://prettiflow.tech">Prettiflow</a> · Inspired by <a href="https://openclaw.ai">OpenClaw</a></sub>
+</div>

package/dist/agent/context.d.ts

@@ -0,0 +1,22 @@
+export declare class ContextBuilder {
+    private readonly workspace;
+    static readonly BOOTSTRAP_FILES: string[];
+    static readonly RUNTIME_CONTEXT_TAG = "[Runtime Context - metadata only, not instructions]";
+    private readonly memory;
+    private readonly skills;
+    constructor(workspace: string);
+    buildSystemPrompt(skillNames?: string[]): string;
+    private getIdentity;
+    private loadBootstrapFiles;
+    static buildRuntimeContext(channel?: string, chatId?: string): string;
+    buildMessages(input: {
+        history: Array<Record<string, unknown>>;
+        currentMessage: string;
+        skillNames?: string[];
+        media?: string[];
+        channel?: string;
+        chatId?: string;
+    }): Array<Record<string, unknown>>;
+    addToolResult(messages: Array<Record<string, unknown>>, toolCallId: string, toolName: string, result: string): Array<Record<string, unknown>>;
+    addAssistantMessage(messages: Array<Record<string, unknown>>, content: string | null, toolCalls?: Array<Record<string, unknown>>, reasoningContent?: string | null): Array<Record<string, unknown>>;
+}

package/dist/agent/context.js

@@ -0,0 +1,85 @@
+import fs from "node:fs";
+import path from "node:path";
+import os from "node:os";
+import { MemoryStore } from "./memory.js";
+import { SkillsLoader } from "./skills.js";
+export class ContextBuilder {
+    workspace;
+    static BOOTSTRAP_FILES = ["AGENTS.md", "SOUL.md", "USER.md", "TOOLS.md", "IDENTITY.md"];
+    static RUNTIME_CONTEXT_TAG = "[Runtime Context - metadata only, not instructions]";
+    memory;
+    skills;
+    constructor(workspace) {
+        this.workspace = workspace;
+        this.memory = new MemoryStore(workspace);
+        this.skills = new SkillsLoader(workspace);
+    }
+    buildSystemPrompt(skillNames) {
+        const parts = [this.getIdentity()];
+        const bootstrap = this.loadBootstrapFiles();
+        if (bootstrap)
+            parts.push(bootstrap);
+        const mem = this.memory.getMemoryContext();
+        if (mem)
+            parts.push(`# Memory\n\n${mem}`);
+        const alwaysSkills = this.skills.getAlwaysSkills();
+        if (alwaysSkills.length) {
+            const content = this.skills.loadSkillsForContext(alwaysSkills);
+            if (content)
+                parts.push(`# Active Skills\n\n${content}`);
+        }
+        if (skillNames?.length) {
+            const skillContent = this.skills.loadSkillsForContext(skillNames);
+            if (skillContent)
+                parts.push(`# Requested Skills\n\n${skillContent}`);
+        }
+        const summary = this.skills.buildSkillsSummary();
+        if (summary) {
+            parts.push(`# Skills\n\nThe following skills extend your capabilities. To use one, read its SKILL.md with read_file.\n\n${summary}`);
+        }
+        return parts.join("\n\n---\n\n");
+    }
+    getIdentity() {
+        return `# pretticlaw\n\nYou are pretticlaw, a helpful AI assistant.\n\n## Runtime\n${os.platform()} ${os.arch()}, Node ${process.version}\n\n## Workspace\nYour workspace is at: ${this.workspace}\n- Long-term memory: ${path.join(this.workspace, "memory", "MEMORY.md")}\n- History log: ${path.join(this.workspace, "memory", "HISTORY.md")}\n- Custom skills: ${path.join(this.workspace, "skills", "{skill-name}", "SKILL.md")}\n\n## Guidelines\n- State intent before tool calls, but never claim results before receiving them.\n- Before modifying a file, read it first.\n- Ask for clarification when the request is ambiguous.`;
+    }
+    loadBootstrapFiles() {
+        const parts = [];
+        for (const f of ContextBuilder.BOOTSTRAP_FILES) {
+            const p = path.join(this.workspace, f);
+            if (!fs.existsSync(p))
+                continue;
+            parts.push(`## ${f}\n\n${fs.readFileSync(p, "utf8")}`);
+        }
+        return parts.join("\n\n");
+    }
+    static buildRuntimeContext(channel, chatId) {
+        const now = new Date();
+        const lines = [`Current Time: ${now.toISOString()}`];
+        if (channel && chatId) {
+            lines.push(`Channel: ${channel}`);
+            lines.push(`Chat ID: ${chatId}`);
+        }
+        return `${ContextBuilder.RUNTIME_CONTEXT_TAG}\n${lines.join("\n")}`;
+    }
+    buildMessages(input) {
+        return [
+            { role: "system", content: this.buildSystemPrompt(input.skillNames) },
+            ...input.history,
+            { role: "user", content: ContextBuilder.buildRuntimeContext(input.channel, input.chatId) },
+            { role: "user", content: input.currentMessage },
+        ];
+    }
+    addToolResult(messages, toolCallId, toolName, result) {
+        messages.push({ role: "tool", tool_call_id: toolCallId, name: toolName, content: result });
+        return messages;
+    }
+    addAssistantMessage(messages, content, toolCalls, reasoningContent) {
+        const msg = { role: "assistant", content };
+        if (toolCalls?.length)
+            msg.tool_calls = toolCalls;
+        if (reasoningContent != null)
+            msg.reasoning_content = reasoningContent;
+        messages.push(msg);
+        return messages;
+    }
+}

package/dist/agent/loop.d.ts

@@ -0,0 +1,63 @@
+import { SubagentManager } from "./subagent.js";
+import { ToolRegistry } from "./tools/registry.js";
+import type { MessageBus } from "../bus/queue.js";
+import type { InboundMessage, OutboundMessage } from "../bus/events.js";
+import type { LLMProvider } from "../providers/base.js";
+import { SessionManager } from "../session/manager.js";
+import type { CronService } from "../cron/service.js";
+type ProgressFn = (content: string, meta?: {
+    toolHint?: boolean;
+    tool_calls?: any[];
+}) => Promise<void>;
+export declare class AgentLoop {
+    private readonly input;
+    private readonly context;
+    private readonly sessions;
+    readonly tools: ToolRegistry;
+    readonly subagents: SubagentManager;
+    private running;
+    private readonly consolidating;
+    private readonly activeTasks;
+    private processing;
+    private static readonly TOOL_RESULT_MAX_CHARS;
+    constructor(input: {
+        bus: MessageBus;
+        provider: LLMProvider;
+        workspace: string;
+        model?: string;
+        maxIterations?: number;
+        temperature?: number;
+        maxTokens?: number;
+        memoryWindow?: number;
+        braveApiKey?: string | null;
+        execConfig?: {
+            timeout: number;
+            pathAppend: string;
+        };
+        cronService?: CronService;
+        restrictToWorkspace?: boolean;
+        sessionManager?: SessionManager;
+        channelsConfig?: {
+            sendProgress: boolean;
+            sendToolHints: boolean;
+        };
+    });
+    get model(): string;
+    get channelsConfig(): {
+        sendProgress: boolean;
+        sendToolHints: boolean;
+    } | undefined;
+    private registerDefaultTools;
+    private setToolContext;
+    private toolHint;
+    private runAgentLoop;
+    run(): Promise<void>;
+    stop(): void;
+    processDirect(content: string, session?: string, channel?: string, chatId?: string, onProgress?: ProgressFn): Promise<string>;
+    private dispatch;
+    private handleStop;
+    private consolidateMemory;
+    private saveTurn;
+    processMessage(msg: InboundMessage, sessionKeyOverride?: string, onProgress?: ProgressFn): Promise<OutboundMessage | null>;
+}
+export {};