![\"npm](\"https://img.shields.io/npm/v/ironclaw?style=for-the-badge&color=000\")
\n ![\"Discord\"](\"https://img.shields.io/discord/1456350064065904867?label=Discord&logo=discord&logoColor=white&color=5865F2&style=for-the-badge\")
\n ![\"MIT](\"https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge\"){kind=icon}
\n\n
\n╔════════════════════════════════════════════════════════════════════╗\n║ ║\n║ ⚠️ DEPRECATION NOTICE ⚠️ ║\n║ ║\n║ This project (ironclaw) is DEPRECATED. ║\n║ It has been superseded by denchclaw. ║\n║ ║\n║ To use the supported version, run: ║\n║ ║\n║ npx denchclaw ║\n║ ║\n║ ironclaw will no longer receive updates. ║\n║ ║\n╚════════════════════════════════════════════════════════════════════╝\n\n\n\n
\n AI CRM, hosted locally on your Mac.\n
\n\n\n Chat with your database. Automate outreach. Enrich leads. All from a single prompt.\n
\n\n\n \n
\n Website · Docs · OpenClaw Framework · Discord · Skills Store\n
\n\n---\n\n## Install\n\n**Runtime: Node 22+**\n\n```bash\nnpm i -g ironclaw\nironclaw onboard --install-daemon\n```\n\nOpens at `localhost:3100`. That's it.\n\nThree steps total:\n\n```\n1. npm i -g ironclaw\n2. ironclaw onboard\n3. ironclaw gateway start\n```\n\n---\n\n## What is Ironclaw?\n\nIronclaw is a personal AI agent and CRM that runs locally on your machine. It connects to every messaging channel you use, manages structured data through DuckDB, browses the web with your Chrome profile, and gives you a full web UI for pipeline management, analytics, and document management.\n\nBuilt on [OpenClaw](https://github.com/openclaw/openclaw) with **Vercel AI SDK v6** as the LLM orchestration layer.\n\n**One prompt does everything:**\n\n- \"Find YC W26 founders building AI companies\" → scrapes YC directory + LinkedIn, returns 127 matches\n- \"Enrich all contacts with LinkedIn and email\" → fills in profiles with 98% coverage\n- \"Send personalized messages to qualified leads\" → crafts and sends custom outreach\n- \"Show me pipeline stats for this quarter\" → generates interactive charts from live data\n- \"Set up weekly follow-up sequences for all leads\" → creates automation rules that run in the background\n\n---\n\n## Use Cases\n\n### Find Leads\n\nType a prompt, Ironclaw scrapes the web using your actual Chrome profile (all your auth sessions, cookies, history). It logs into LinkedIn, browses YC batches, pulls company data. No separate login, no API keys for browsing.\n\n### Enrich Data\n\nPoint it at your contacts table. It fills in LinkedIn URLs, email addresses, education, company info. Enrichment runs in bulk with real-time progress.\n\n### Send Outreach\n\nPersonalized LinkedIn messages, cold emails, follow-up sequences. Each message is customized per lead. You see status (Sent, Sending, Queued) in real time.\n\n### Analyze Pipeline\n\nAsk for analytics in plain English. Ironclaw queries your DuckDB workspace and generates interactive Recharts dashboards inline. Pipeline funnels, outreach activity charts, conversion rates, donut breakdowns.\n\n### Automate Everything\n\nCron jobs that run on schedule. Follow-up if no reply after 3 days. Move leads to Qualified when they reply. Weekly pipeline reports every Monday. Alert on high-intent replies.\n\n---\n\n## Core Capabilities\n\n### Uses Your Chrome Profile\n\nUnlike other AI tools, Ironclaw copies your existing Chrome profile with all your auth sessions, cookies, and history. It logs into LinkedIn, scrapes YC batches, and sends messages as you. No separate browser login needed.\n\n### Chat with Your Database\n\nAsk questions in plain English. Ironclaw translates to SQL, queries your local DuckDB, and returns structured results. Like having a data analyst on speed dial.\n\n```\nYou: \"How many founders have we contacted from YC W26?\"\n\n→ SELECT \"Status\", COUNT(*) as count FROM v_founders GROUP BY \"Status\";\n\nYou've contacted 67 of 200 founders. 31 are qualified, 13 converted.\nReply rate is 34%.\n```\n\n### Coding Agent with Diffs\n\nIronclaw writes code. Review changes in a rich diff viewer before applying. Config changes, automation scripts, data transformations. All with diffs you approve.\n\n### Your Second Brain\n\nFull access to your Mac: files, apps, documents. It remembers context across sessions via persistent memory files. Learns your preferences. Proactively handles tasks during heartbeat checks.\n\n---\n\n## Web UI (Dench)\n\nThe web app runs at `localhost:3100` and includes:\n\n- **Chat panel** with streaming responses, chain-of-thought reasoning display, and markdown rendering\n- **Workspace sidebar** with file manager tree, knowledge base, and database viewer\n- **Object tables** powered by TanStack, with sorting, filtering, row selection, and bulk operations\n- **Entry detail modals** with field editing and media previews\n- **Kanban boards** with drag-and-drop that auto-update as leads reply\n- **Interactive report cards** with chart panels (bar, line, area, pie, donut, funnel, scatter, radar) and filter bars\n- **Document editor** with embedded live charts\n- **Media viewer** supporting images, video, audio, and PDFs\n\n---\n\n## Multi-Channel Inbox\n\nOne agent, every channel. Connect any messaging platform. Your AI agent responds everywhere, managed from a single terminal.\n\n| Channel | Setup |\n| ------------------- | ------------------------------------------------------------- |\n| **WhatsApp** | `ironclaw channels login` + set `channels.whatsapp.allowFrom` |\n| **Telegram** | Set `TELEGRAM_BOT_TOKEN` or `channels.telegram.botToken` |\n| **Slack** | Set `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN` |\n| **Discord** | Set `DISCORD_BOT_TOKEN` or `channels.discord.token` |\n| **Signal** | Requires `signal-cli` + `channels.signal` config |\n| **iMessage** | Via BlueBubbles (recommended) or legacy macOS integration |\n| **Microsoft Teams** | Configure Teams app + Bot Framework |\n| **Google Chat** | Chat API integration |\n| **Matrix** | Extension channel |\n| **WebChat** | Built-in, uses Gateway WebSocket directly |\n\n```\n WhatsApp · Telegram · Slack · Discord\n Signal · iMessage · Teams · WebChat\n │\n ▼\n ┌────────────────────────────┐\n │ Ironclaw Gateway │\n │ ws://127.0.0.1:18789 │\n └─────────────┬──────────────┘\n │\n ┌───────────┼───────────┐\n │ │ │\n ▼ ▼ ▼\n AI SDK Web UI CLI\n Engine (Dench) (ironclaw)\n```\n\n---\n\n## Integrations\n\nImport your data from anywhere: Google Drive, Notion, Salesforce, HubSpot, Gmail, Calendar, Obsidian, Slack, LinkedIn, Asana, Monday, ClickUp, PostHog, Sheets, Apple Notes, GitHub, and 50+ more via the Skills Store.\n\n---\n\n## Skills Platform\n\nExtend your agent with a single command. Browse skills from [skills.sh](https://skills.sh) and [ClawHub](https://clawhub.com).\n\n```bash\nnpx skills add vercel-labs/agent-browser\n```\n\nPopular skills:\n\n| Skill | Description | Installs |\n| ----------------------- | ---------------------------------------------------------- | -------- |\n| `crm-automation` | CRM workflow automation, lead scoring, pipeline management | 18.2K |\n| `linkedin-outreach` | Automated LinkedIn prospecting and follow-up sequences | 14.8K |\n| `lead-enrichment` | Enrich contacts with LinkedIn, email, and company data | 12.1K |\n| `email-sequences` | Multi-step cold email campaigns with personalization | 9.7K |\n| `agent-browser` | Browser automation and web scraping for agents | 35.8K |\n| `web-design-guidelines` | Best practices for modern web design | 99.4K |\n| `frontend-design` | Expert frontend engineering patterns | 68.9K |\n| `typescript-expert` | Advanced TypeScript patterns and best practices | 15.1K |\n\nOr write your own. Skills are just a `SKILL.md` file with instructions + optional scripts.\n\n---\n\n## Analytics & Reports\n\nAsk \"show me pipeline analytics\" and get interactive charts generated from your live DuckDB data.\n\n- **Outreach Activity** — area charts tracking LinkedIn and email volume over time\n- **Pipeline Breakdown** — donut charts showing lead distribution by status\n- **Conversion Funnel** — stage-by-stage conversion rates with overall percentage\n- **Deal Pipeline** — bar charts, funnel views, revenue by stage\n- **Custom Reports** — save as `.report.json` files that render as live dashboards\n\nReports use the `report-json` format and render inline in chat as interactive Recharts components.\n\n---\n\n## Kanban Pipeline\n\nDrag-and-drop kanban boards that auto-update as leads reply. Ironclaw moves cards through your pipeline automatically.\n\nColumns like New Lead → Contacted → Qualified → Demo Scheduled → Closed map to your sales process. Each card shows the lead name, company, and last action taken.\n\n---\n\n## Documents, Reports & Cron Jobs\n\n### Documents\n\nRich markdown documents with embedded live charts. SOPs, playbooks, onboarding guides. Documents nest under objects or stand alone in the file tree.\n\n### Cron Jobs\n\nScheduled automations that run in the background:\n\n| Job | Schedule | Description |\n| ---------------------- | -------------- | ------------------------------------ |\n| Weekly pipeline report | `0 9 * * MON` | Auto-generates pipeline summary |\n| Lead enrichment sync | Every 6h | Enriches new contacts |\n| Email follow-up check | Every 30m | Checks for replies needing follow-up |\n| Inbox digest | `0 8,18 * * *` | Morning and evening inbox summary |\n| Competitor monitoring | `0 6 * * *` | Tracks competitor activity |\n| CRM backup to S3 | `0 2 * * *` | Nightly workspace backup |\n\n```bash\nironclaw cron list\n```\n\n---\n\n## Gateway\n\nThe Gateway is the local-first WebSocket control plane that routes everything:\n\n- **Sessions** — main sessions for DMs, isolated sessions for group chats, sub-agent sessions for background tasks\n- **Channels** — route inbound messages from any platform to the right session\n- **Tools** — browser control, canvas, nodes, cron, messaging, file operations\n- **Events** — webhooks, Gmail Pub/Sub, cron triggers, heartbeats\n- **Multi-agent routing** — route channels/accounts/peers to isolated agents with separate workspaces\n\n### Session Model\n\n- `main` — direct 1:1 chats with persistent context\n- `group` — isolated per-group sessions with mention gating\n- `isolated` — sub-agent sessions for background tasks (cron jobs, spawned work)\n\n### Security\n\n- **DM pairing** enabled by default. Unknown senders get a pairing code.\n- Approve with `ironclaw pairing approve`\n- Non-main sessions can be sandboxed in Docker\n- Run `ironclaw doctor` to audit DM policies\n\n---\n\n## Companion Apps\n\n- **macOS** — menu bar app with Voice Wake, Push-to-Talk, Talk Mode overlay, WebChat, and debug tools\n- **iOS** — Canvas, Voice Wake, Talk Mode, camera, screen recording, Bonjour pairing\n- **Android** — Canvas, Talk Mode, camera, screen recording, optional SMS\n\n---\n\n## Configuration\n\nConfig lives at `~/.openclaw/openclaw.json`:\n\nSupports all latest and greatest mainstream LLM models. BYOK.\n\n---\n\n## Chat Commands\n\nSend these in any connected channel:\n\n| Command | Description |\n| ----------------------------- | ------------------------------- |\n| `/status` | Session status (model + tokens) |\n| `/new` or `/reset` | Reset the session |\n| `/compact` | Compact session context |\n| `/think ` | Set thinking level |\n| `/verbose on\\|off` | Toggle verbose output |\n| `/usage off\\|tokens\\|full` | Per-response usage footer |\n| `/restart` | Restart the gateway |\n| `/activation mention\\|always` | Group activation toggle |\n\n---\n\n## DuckDB Workspace\n\nAll structured data lives in a local DuckDB database. Objects, fields, entries, relations. EAV pattern with auto-generated PIVOT views so you query like normal tables:\n\n```sql\nSELECT * FROM v_leads WHERE \"Status\" = 'New' ORDER BY created_at DESC LIMIT 50;\nSELECT \"Status\", COUNT(*) FROM v_leads GROUP BY \"Status\";\n```\n\nFeatures:\n\n- Custom objects with typed fields (text, email, phone, number, boolean, date, enum, relation, user)\n- Full-text search\n- Bulk import/export (CSV, Parquet)\n- Automatic view generation\n- Kanban support with drag-and-drop\n\n---\n\n## Quick Start\n\n```bash\n# Install\nnpm i -g ironclaw\n\n# Run onboarding wizard\nironclaw onboard --install-daemon\n\n# Start the gateway\nironclaw gateway start\n\n# Open the web UI\nopen http://localhost:3100\n\n# Talk to your agent from CLI\nironclaw agent --message \"Summarize my inbox\" --thinking high\n\n# Send a message\nironclaw message send --to +1234567890 --message \"Hello from Ironclaw\"\n```\n\n---\n\n## From Source\n\n```bash\ngit clone https://github.com/kumarabhirup/ironclaw.git\ncd ironclaw\n\npnpm install\npnpm build\n\npnpm dev onboard --install-daemon\n```\n\nWeb UI development:\n\n```bash\ncd apps/web\npnpm install\npnpm dev\n```\n\n---\n\n## Project Structure\n\n```\nsrc/ Core CLI, commands, gateway, agent, media pipeline\napps/web/ Next.js web UI (Dench)\napps/ios/ iOS companion node\napps/android/ Android companion node\napps/macos/ macOS menu bar app\nextensions/ Channel plugins (MS Teams, Matrix, Zalo, voice-call)\ndocs/ Documentation\nscripts/ Build, deploy, and utility scripts\nskills/ Workspace skills\n```\n\n---\n\n## Development\n\n```bash\npnpm install # Install deps\npnpm build # Type-check + build\npnpm check # Lint + format check\npnpm test # Run tests (vitest)\npnpm test:coverage # Tests with coverage\npnpm dev # Dev mode (auto-reload)\n```\n\n---\n\n## Upstream\n\nIronclaw is built on [OpenClaw](https://github.com/openclaw/openclaw). To sync with upstream:\n\n```bash\ngit remote add upstream https://github.com/openclaw/openclaw.git\ngit fetch upstream\ngit merge upstream/main\n```\n\n---\n\n## Open Source\n\nMIT Licensed. Fork it, extend it, make it yours.\n\n\n ![\"GitHub](\"https://img.shields.io/github/stars/DenchHQ/ironclaw?style=for-the-badge\")
\n
\n","readmeFilename":"README.md"}