Summary

CraftBot is a 24/7 personal AI assistant designed to operate autonomously within a user's machine, interpreting tasks, planning actions, and executing them to achieve defined goals. It learns user preferences and objectives, proactively assisting with life goals. The system targets users seeking advanced automation and personalized AI support.

How It Works

It utilizes a flexible Bring-Your-Own-Key (BYOK) LLM system, supporting providers like OpenAI, Gemini, and local Ollama. A RAG-based memory system consolidates daily events, while a proactive agent learns user goals to initiate tasks. A novel "Living UI" enables dynamic, agent-aware applications that CraftBot can interact with. Integration with external services is facilitated via MCP and an extensible skill framework.

Quick Start & Requirements

Installation options include a recommended Service install (python craftbot.py install) that manages environments and runs in the background, a Conda-based install (python install.py --conda), or a Manual pip install (python install.py). Docker support is also provided. Prerequisites: Python 3.10+, git, LLM API key. Node.js 18+ is required for the browser interface.

Highlighted Details

• BYOK LLM Flexibility: Supports OpenAI, Gemini, Claude, and local Ollama models.
• Proactive Agent & Memory: Learns user goals, consolidates events, and initiates tasks autonomously.
• Living UI System: Enables creation/import of agent-aware, dynamic applications.
• Extensive Integrations: Connects to Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram via MCP/OAuth.
• Cross-Platform: Supports Windows, macOS, Linux, and Docker.

Maintenance & Community

Developed by CraftOS and contributors @zfoong, @ahmad-ajmal. Community support is available via Discord; contact thamyikfoong(at)craftos.net for inquiries. Contributions are welcomed via PRs as per CONTRIBUTING.md.

Licensing & Compatibility

MIT License. Allows free use, hosting, and monetization with attribution. Compatible with commercial use.

Limitations & Caveats

GUI (desktop automation) mode is deprecated; Browser, TUI, or CLI interfaces must be used. Browser mode requires Node.js 18+ (TUI/CLI are alternatives). Optional WhatsApp Web integration via Playwright Chromium may have installation complexities but does not affect core functionality.