diff --git a/README.cn.md b/README.cn.md index f8edba71..f7daf679 100644 --- a/README.cn.md +++ b/README.cn.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
大多数 Agent 框架止步于对话和工具调用,CraftBot 走得更远。它会自己构建、演进并运行 SaaS 工具,然后通过这套工具层与你沟通,并替你完成自动化工作。 @@ -21,6 +21,10 @@ Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 日本語 | 繁體中文 | 한국어 | Español | Português | Français | Deutsch

-
- CraftBot Banner -
- ## ✨ 核心特性 除了能够创建并运行自有 SaaS 工具,CraftBot 还具备 Agent 框架的全部核心能力,可以作为一个通用 AI Agent 陪你处理任务、工具、记忆与日常工作流。 @@ -52,42 +45,18 @@ - **Living UI.** 在 CraftBot 内部构建、导入或演进自定义应用。Agent 始终感知 UI 状态,并能直接读取、写入和操作其中的数据。 - **多任务与会话路由.** 还在手动敲 `/new` 吗?CraftBot 能自行判断何时开启新会话、何时继续旧任务,让对话与上下文保持统一。 - **自托管与 BYOK.** 灵活的 LLM 提供商体系,支持 OpenAI、Google Gemini、Anthropic Claude、OpenRouter 等。也可以用 Ollama 自行托管模型,实现零 Token 消耗。 -- **记忆系统.** 通过 RAG + Agent 文件系统 + 蒸馏,从你与 CraftBot 的交互中构建本地知识库。CraftBot 会在午夜「做梦」,整合一整天发生的事件。 +- **记忆系统.** 从你与 CraftBot 的交互中构建的第二大脑。混合方案:RAG + 知识图谱 + Agent 文件系统。CraftBot 会在午夜「做梦」,整合一整天发生的事件。 - **主动型 Agent.** 学习你的偏好、习惯和人生目标,然后主动进行规划并发起任务(当然要经过你的同意),帮你在生活中变得更好。 -- **外部工具集成.** 连接你的应用,例如 Google Workspace、Slack、Notion、Zoom、LinkedIn、Discord、Telegram 等(还有更多正在路上),支持 OAuth 或使用你自己的密钥。 +- **外部工具集成.** 连接你的应用,例如 Google Workspace、Slack、Notion、Zoom、LinkedIn、Discord、Telegram 等(还有更多正在路上),支持 OAuth 或使用你自己的密钥。每个集成都可以连接多个账号。 - **Skills 与 MCP.** 已就绪 150+ MCP 与 170+ Skills,支持快速安装新的 Skills 与 MCP,也可以从已完成的任务中一键创建或改进 Skills。 - **浏览器界面与 CLI 支持.** 用最适合你的方式使用 CraftBot:日常使用走简洁的浏览器 UI,脚本和无界面环境则可以走 CLI。 --- -## 🧰 环境设置 - -### 前置要求 -- Python **3.10+** -- `git`（克隆仓库所需） -- 你所选 LLM 提供商的 API Key（OpenAI、Gemini 或 Anthropic） -- `Node.js` **18+**（可选 - 仅浏览器界面需要） -- `conda`（可选 - 如未找到，安装器会提供自动安装 Miniconda 的选项） - -### 我该选哪种方式？ - -> **不确定？选方案一。** 它会帮你搞定所有事。 - -| | 方案一 — 服务安装 | 方案二 — Conda 安装 | 方案三 — 手动安装 | -|---|---|---|---| -| **适合谁** | 大多数用户、新手、测试 | 想要独立环境的 Conda 用户 | 进阶用户、自定义 Python、完全控制 | -| **自动管理 Python 环境？** | ✅ 自动 | ✅ 自动 | ❌ 你自己管理 | -| **后台运行？** | ✅ 是，作为服务 | ❌ 否 | ❌ 否 | -| **启动方式** | `python craftbot.py install` | `python install.py --conda` | `python install.py` | - ---- - -### ⭐ 方案一 — 服务安装（推荐） - -**适合你，如果：** 你希望 CraftBot 开箱即用——后台服务、开机自启、桌面快捷方式，无需手动操作。 +## 🧰 快速开始 -`craftbot.py` 全程自动处理：Python 环境、依赖安装、后台进程管理和自启注册。 +环境要求:Python 3.10+ · 浏览器模式需要 Node.js 18+ ```bash # 1. 克隆仓库 @@ -128,87 +97,13 @@ python craftbot.py uninstall # 停止运行、移除自启动并卸载所有依 - 一套完全贴合你工作流的定制 CRM? - 一个 CraftBot 能替你读取并操作的公司仪表盘? -```bash -# 1. 克隆仓库 -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. 安装到 conda 环境 -python install.py --conda - -# 3. 运行 CraftBot -conda run -n craftbot python run.py - -# 如果 conda 不在 PATH 中（仅 Windows）： -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> 每次运行 CraftBot 时，请使用 `conda run -n craftbot python run.py`。此方式没有后台服务——由你手动启停。 - ---- - -### 方案三 — 手动安装（pip） - -**适合你，如果：** 你希望完全掌控 Python 环境，不需要任何自动服务或后台进程，自己管理 CraftBot。 - -`install.py`（不带参数）会对当前激活的 Python 环境执行标准 pip 安装。通过 `run.py` 手动启停 CraftBot。 - -```bash -# 1. 克隆仓库 -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. 在当前 Python 环境中安装依赖 -python install.py - -# 3. 运行 CraftBot -python run.py -``` - -首次运行会引导你完成 API Key 设置和偏好配置。 - -> [!NOTE] -> 如果未安装 Node.js，安装器会提供详细指引。你也可以完全跳过浏览器模式，直接使用 CLI 模式——无需 Node.js：`python run.py --cli` - -### 安装完成后你可以做什么？ -- 用自然语言与代理交流 -- 让它执行复杂的多步骤任务 -- 输入 `/help` 查看可用命令 -- 连接 Google、Slack、Notion 等服务 - -### 🖥️ 界面模式 - -
- CraftOS Banner -
- -CraftBot 支持多种 UI 模式。根据你的偏好选择： - -| 模式 | 命令 | 要求 | 最适合 | -|------|---------|--------------|----------| -| **浏览器** | `python run.py` | Node.js 18+ | 现代 Web 界面，最易使用 | -| **CLI** | `python run.py --cli` | 无 | 命令行，轻量级 | - -**浏览器模式**是默认的推荐模式。如果你没有 Node.js，安装器会提供安装指引，或者你可以使用 **CLI 模式**。 - ---- - -## 🧬 Living UI - -**Living UI 是随你需求而进化的系统/应用/仪表盘。** - -需要一个内置 AI 副驾的看板？量身定制符合你工作流程的 CRM？ -一个 CraftBot 能读取并驱动的公司仪表盘？ -将它作为 Living UI 启动——它与 CraftBot 并行运行，并随着你的需求变化而成长。 - -
- Living UI example -
+将它作为 Living UI 启动:它与 CraftBot 并行运行,并随着你的需求变化而成长。 ### 创建 Living UI 的三种方式 -1. **从零构建.** 用自然语言描述你想要的东西,CraftBot 会搭好数据模型、后端 API 和 React 前端,并通过一套结构化的设计流程与你不断迭代。 +1. **从零构建.** 用自然语言描述你想要的东西,CraftBot + 会搭好数据模型、后端 API 和 React 前端, + 并通过一套结构化的设计流程与你不断迭代。
Building a Living UI from scratch @@ -220,167 +115,47 @@ CraftBot 支持多种 UI 模式。根据你的偏好选择： Living UI marketplace
-3. **导入现有项目.** 把 Go、Node.js、Python、Rust 或者静态源码、GitHub 仓库交给 CraftBot,它会自动识别运行时、配置健康检查,并把它封装成一个 Living UI。 +3. **导入现有项目.** 把 Go、Node.js、Python、Rust + 或者静态源码、GitHub 仓库交给 CraftBot,它会自动识别运行时、配置健康检查,并把它封装成一个 Living UI。
Importing an existing project as a Living UI
-### 让 Agent 持续参与的不断演进 +### 让 CraftBot 持续参与的不断演进 -Living UI 永远没有「完成」这一说。需求一变,就让 Agent 给它加功能、改版页面或接入新数据源。 +Living UI 永远没有「完成」这一说。需求一变,就让 Agent 给它加功能、 +改版页面或接入新数据源。 -CraftBot 嵌入在每个 Living UI 之中,并且**对其状态保持感知**:它可以读取当前 DOM 和表单值、通过 REST API 查询应用数据,并代替你触发操作。 +CraftBot 嵌入在每个 Living UI 之中,并且**对其状态保持感知**: +它可以读取当前 DOM 和表单值、通过 REST API 查询应用数据, +并代替你触发操作。 ### 让 SaaS 工具保持开放与鲜活 构建、定制并不断演进属于自己的 Living UI,减少对那些从未真正为你量身定制的订阅工具的依赖。 -我们正在积极寻找愿意展示自己 Living UI 的开发者,并支持将它们导出到 **[Living UI 市场](https://craftos.net/marketplace)**。欢迎提交 PR! - --- # 三个 5 分钟内可以试玩的 Living UI -- **📋 看板** — 把所有任务、跟进事项和待办集中到一个地方,CraftBot 可以接手运营,替你完成 PM 工作。 -- **📊 习惯追踪器** — 培养并追踪自己的习惯,用类 GitHub 风格的活动日历像写代码一样维护你的习惯。 -- **🐦 Luolinglo** — 不是多邻国,但你可以学习新语言、做单词卡片,并和 CraftBot 一起练习。 - -## 🧩 架构概览 - -| 组件 | 说明 | -|-----------|-------------| -| **代理基础层 (Agent Base)** | 核心编排层，管理任务生命周期、协调各组件并处理主要的代理循环。 | -| **LLM 接口** | 统一接口，支持多个 LLM 提供商（OpenAI、Gemini、Anthropic、BytePlus、Ollama）。 | -| **上下文引擎** | 生成优化的提示词，支持 KV-cache。 | -| **动作管理器** | 从动作库中检索和执行动作。自定义动作易于扩展。 | -| **动作路由器** | 根据任务需求智能选择最佳匹配的动作，需要时通过 LLM 解析输入参数。 | -| **事件流** | 实时事件发布系统，用于任务进度跟踪、UI 更新和执行监控。 | -| **记忆管理器** | 基于 RAG 的语义记忆，使用 ChromaDB。处理记忆分块、向量化、检索和增量更新。 | -| **状态管理器** | 全局状态管理，跟踪代理执行上下文、对话历史和运行时配置。 | -| **任务管理器** | 管理任务定义，支持简单和复杂任务模式，创建待办事项，多步骤工作流跟踪。 | -| **技能管理器** | 加载并将可插拔技能注入代理上下文。 | -| **MCP 适配器** | 模型上下文协议集成，将 MCP 工具转换为原生动作。 | - ---- - -# CraftBot 与其他方案的对比 - -| | v0 / Lovable / Bolt | OpenClaw | Claude Code | **CraftBot** | -| -------------------------------- | ------------------- | -------------------- | -------------------- | --------------------------------------- | -| **构建自定义应用** | ✅ 一次性生成 | 🚫 | ✅ (手动) | ✅ 对话式持续构建 | -| **Agent 能操作应用** | 🚫 | ⚠️ 通过工具调用 | 🚫 | ✅ 内置于每个 Living UI | -| **持久化的 Agent 记忆** | 🚫 | ✅ | ✅ | ✅ RAG + Agent 文件系统 + 蒸馏 | -| **自托管** | ⚠️ 部分支持 | ✅ | 🚫 SaaS | ✅ MIT 协议,运行在你自己的机器上 | -| **模型无关** | ✅ | ✅ | ⚠️ 部分支持 | ✅ 主流厂商 + OpenRouter | - ---- - -## 🔧 故障排查与常见问题 +- **📋 看板**:把所有任务、跟进事项和待办集中到一个地方,CraftBot 可以接手运营,替你完成 PM 工作。 +- **📊 习惯追踪器**:培养并追踪自己的习惯,用类 GitHub 风格的活动日历像开发者一样维护你的习惯。 +- **🐦 Luolinglo**:不是多邻国,但你可以学习新语言、制作单词卡片,并和 CraftBot 一起练习。 -### install.py - -| 参数 | 说明 | -|------|-------------| -| `--conda` | 使用 conda 环境（可选） | - -### run.py - -| 参数 | 说明 | -|------|-------------| -| （无） | 以**浏览器**模式运行（推荐，需要 Node.js） | -| `--cli` | 以 **CLI** 模式运行（轻量级） | - -**安装示例：** -```bash -# 简单 pip 安装（不使用 conda） -python install.py - -# 使用 conda 环境（推荐 conda 用户使用） -python install.py --conda -``` - -**运行 CraftBot：** - -```powershell -# 浏览器模式（默认，需要 Node.js） -python run.py - -# CLI 模式（轻量级） -python run.py --cli - -# 使用 conda 环境 -conda run -n craftbot python run.py - -# 如果 conda 不在 PATH 中，使用完整路径 -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -**Linux/macOS (Bash):** -```bash -# 浏览器模式（默认，需要 Node.js） -python run.py - -# CLI 模式（轻量级） -python run.py --cli - -# 使用 conda 环境 -conda run -n craftbot python run.py -``` - -### 🔧 后台服务（推荐） - -将 CraftBot 作为后台服务运行，关闭终端后仍可继续运行。系统会自动创建桌面快捷方式，随时可重新打开浏览器。 - -```bash -# 安装依赖、注册开机自启、启动 CraftBot -python craftbot.py install -``` - -就这样。终端会自动关闭，CraftBot 在后台运行，浏览器自动打开。 - -```bash -# 其他服务命令： -python craftbot.py start # 在后台启动 CraftBot -python craftbot.py status # 检查是否正在运行 -python craftbot.py stop # 停止 CraftBot -python craftbot.py restart # 重启 CraftBot -python craftbot.py logs # 查看最近日志输出 -``` - -| 命令 | 说明 | -|---------|-------------| -| `python craftbot.py install` | 安装依赖、注册开机自启、启动 CraftBot、打开浏览器，并自动关闭终端 | -| `python craftbot.py start` | 在后台启动 CraftBot（若已运行则自动重启，终端自动关闭） | -| `python craftbot.py stop` | 停止 CraftBot | -| `python craftbot.py restart` | 停止并重启 CraftBot | -| `python craftbot.py status` | 检查 CraftBot 是否在运行，以及自动启动是否已启用 | -| `python craftbot.py logs` | 显示最近日志（使用 `-n 100` 查看更多行） | -| `python craftbot.py uninstall` | 停止 CraftBot、注销自启、卸载 pip 包并清理 pip 缓存 | - -> [!TIP] -> 执行 `craftbot.py start` 或 `craftbot.py install` 后，系统会自动创建 **CraftBot 桌面快捷方式**。如果不小心关闭了浏览器，双击快捷方式即可重新打开。 - -> [!NOTE] -> **安装：** 安装器会在缺少依赖时提供清晰的指引。如果未找到 Node.js，会提示你安装或切换到 CLI 模式。安装会自动检测 GPU 可用性，必要时回退到仅 CPU 模式。 - -> [!TIP] -> **首次设置：** CraftBot 会引导你完成引导流程，配置 API Key、代理名称、MCP 和技能。 - -> [!NOTE] -> **Playwright Chromium：** WhatsApp Web 集成可选。如果安装失败，代理在其他任务上仍能正常工作。可稍后手动安装：`playwright install chromium` +**[浏览 Living UI 市场并参与贡献 →](https://craftos.net/marketplace)** --- -## 🔧 故障排除与常见问题 +## 🔧 故障排查与常见问题 -### 缺少 Node.js（浏览器模式） -运行 `python run.py` 时看到 **"npm not found in PATH"**： -1. 从 [nodejs.org](https://nodejs.org/) 下载（选择 LTS 版本） +### 缺少 Node.js(浏览器模式) +运行 `python run.py` 时看到 **"npm not found in PATH"**: +1. 从 [nodejs.org](https://nodejs.org/) 下载(选择 LTS 版本) 2. 安装并重启终端 3. 再次运行 `python run.py` -**替代方案：** 使用 CLI 模式（不需要 Node.js）： +**替代方案:** 使用 CLI 模式(不需要 Node.js): ```bash python run.py --cli ``` @@ -451,7 +226,7 @@ docker run --rm -it --env-file .env craftbot ## ⭐ 致谢 -由 [CraftOS](https://craftos.net/) 及贡献者共同开发与维护。 +由 [CraftOS](https://craftos.net/) 及贡献者共同开发与维护。 如果你觉得 **CraftBot** 有帮助,欢迎给仓库点 ⭐ 并分享给身边的人! --- diff --git a/README.de.md b/README.de.md index e2a3daf4..41ba8721 100644 --- a/README.de.md +++ b/README.de.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
Die meisten Agent-Frameworks hören bei Chat und Tool-Aufrufen auf. CraftBot geht weiter: Er baut, entwickelt und betreibt seine eigenen SaaS-Tools und nutzt diese Tool-Schicht dann, um mit dir zu kommunizieren und Aufgaben für dich zu automatisieren. @@ -21,6 +21,10 @@ Darüber hinaus bringt CraftBot alle Kernfunktionen eines universellen Agent-Fra Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ Darüber hinaus bringt CraftBot alle Kernfunktionen eines universellen Agent-Fra [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 日本語 | 简体中文 | 繁體中文 | 한국어 | Español | Português | Français

-
- CraftBot Banner -
- ## ✨ Wichtigste Funktionen Über die Fähigkeit hinaus, eigene SaaS-Tools zu erstellen und zu betreiben, bringt CraftBot alle Kernfunktionen eines Agent-Frameworks mit. So kann er als universeller KI-Agent an deiner Seite über deine Aufgaben, Tools, dein Gedächtnis und deine täglichen Workflows hinweg arbeiten. @@ -50,11 +43,11 @@ Darüber hinaus bringt CraftBot alle Kernfunktionen eines universellen Agent-Fra - **Agent-Profile** Mehr als 40 Agent-Profile (CEO-Agent, Finance-Agent, Marketing-Lead-Agent, DevOps-Engineer, Video-Producer-Agent oder 37 weitere) stehen bereit, um für dich zu arbeiten. Finde die gewünschten Rollen in den **[CraftBot Agent Bundles](https://github.com/CraftOS-dev/craftbot-agent-bundles)** und importiere sie mit einem Klick. - **Playbook-Katalog** Du weißt nicht, wie du mit einem KI-Agenten automatisieren sollst? CraftBot bringt 120 sofort einsatzbereite Playbooks mit (in 19 Kategorien). Öffne den Playbook-Picker in der oberen Leiste, wähle ein Playbook aus, und es beginnt, die Aufgabe für dich auszuführen. - **Living UI.** Baue, importiere oder entwickle eigene Apps, die innerhalb von CraftBot leben. Der Agent kennt den Zustand der UI jederzeit und kann ihre Daten direkt lesen, schreiben und damit arbeiten. -- **Multitasking und Session-Routing.** Tippst du noch von Hand `/new`? CraftBot weiß selbst, wann eine neue Session sinnvoll ist und wann eine bestehende Aufgabe wieder aufgenommen werden sollte – Gespräch und Kontext bleiben dabei einheitlich. -- **Self-hosted und BYOK.** Flexibles LLM-Provider-System mit Unterstützung für OpenAI, Google Gemini, Anthropic Claude, OpenRouter und mehr. Oder hoste mit Ollama dein eigenes Modell – ganz ohne Token-Verbrauch. -- **Memory-System.** Eine lokale Wissensbasis, die aus deiner Interaktion mit CraftBot via RAG + Agent-Dateisystem + Distillation aufgebaut wird. Um Mitternacht „träumt" CraftBot und konsolidiert die Ereignisse des Tages. +- **Multitasking und Session-Routing.** Tippst du noch von Hand `/new`? CraftBot weiß selbst, wann eine neue Session sinnvoll ist und wann eine bestehende Aufgabe wieder aufgenommen werden sollte, so bleiben Gespräch und Kontext einheitlich. +- **Self-hosted und BYOK.** Flexibles LLM-Provider-System mit Unterstützung für OpenAI, Google Gemini, Anthropic Claude, OpenRouter und mehr. Oder hoste mit Ollama dein eigenes Modell, ganz ohne Token-Verbrauch. +- **Memory-System.** Ein zweites Gehirn, aufgebaut aus deinen Interaktionen mit CraftBot. Hybrider Ansatz: RAG + Wissensgraph + Agent-Dateisystem. Um Mitternacht „träumt" CraftBot und konsolidiert die Ereignisse des Tages. - **Proaktiver Agent.** Er lernt deine Vorlieben, Gewohnheiten und Lebensziele kennen, plant darauf basierend und stößt Aufgaben an (natürlich nur mit deiner Freigabe), um dich in deinem Leben weiterzubringen. -- **Integration externer Tools.** Verbinde deine Apps wie Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram und mehr (weitere folgen!) mit OAuth-Unterstützung oder deinem eigenen Schlüssel. +- **Integration externer Tools.** Verbinde deine Apps wie Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram und mehr (weitere folgen!) mit OAuth-Unterstützung oder deinem eigenen Schlüssel. Du kannst mit jeder Integration mehrere Konten verbinden. - **Skills und MCP.** Über 150 MCPs und 170 Skills sofort einsatzbereit. Neue Skills und MCPs lassen sich schnell installieren, und aus abgeschlossenen Aufgaben kannst du mit einem Klick neue Skills erstellen oder verbessern. - **Browser-Oberfläche und CLI.** Nutze CraftBot so, wie es zu dir passt: über eine einfache Browser-UI für die tägliche Arbeit oder per CLI für Skripte und Headless-Umgebungen. @@ -94,99 +87,22 @@ python craftbot.py uninstall # Stoppen, Autostart entfernen und Pakete deinstal ## 🌱 Living UI -**Eine Living UI ist ein System / eine App / ein Dashboard, das mit deinen Anforderungen mitwächst.** +**Living UI ist ein System/App/Dashboard, das mit deinen Anforderungen wächst.**
CraftBot Banner
-- Brauchst du ein Kanban-Board mit eingebautem KI-Copiloten? -- Ein maßgeschneidertes CRM, das exakt deinem Workflow folgt? -- Ein Unternehmens-Dashboard, das CraftBot lesen und für dich bedienen kann? +- Brauchst du ein Kanban-Board mit eingebautem KI-Copiloten? +- Ein maßgeschneidertes CRM, das exakt deinem Workflow folgt? +- Ein Unternehmens-Dashboard, das CraftBot lesen und für dich bedienen kann? -```bash -# 1. Repository klonen -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. In einer conda-Umgebung installieren -python install.py --conda - -# 3. CraftBot ausführen -conda run -n craftbot python run.py - -# Falls conda nicht im PATH ist (nur Windows): -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> Jedes Mal wenn du CraftBot starten möchtest, verwende `conda run -n craftbot python run.py`. Es gibt keinen Hintergrunddienst — du startest und stoppst ihn selbst. - ---- - -### Option 3 — Manuelle Installation (pip) - -**Wähle dies, wenn:** du volle Kontrolle über deine Python-Umgebung möchtest und CraftBot lieber selbst verwaltest, ohne automatischen Dienst oder Hintergrundprozess. - -`install.py` (ohne Optionen) führt eine Standard-pip-Installation in der aktuell aktiven Python-Umgebung durch. Du startest und stoppst CraftBot manuell mit `run.py`. - -```bash -# 1. Repository klonen -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. Abhängigkeiten in der aktiven Python-Umgebung installieren -python install.py - -# 3. CraftBot starten -python run.py -``` - -Beim ersten Start wirst du durch die Einrichtung deiner API-Schlüssel und Einstellungen geführt. - -> [!NOTE] -> Wenn Node.js nicht installiert ist, führt dich das Installationsprogramm Schritt für Schritt durch die Installation. Du kannst den Browser-Modus auch vollständig überspringen und den CLI-Modus verwenden — kein Node.js nötig: `python run.py --cli` - -### Was kannst du direkt danach tun? -- Natürlich mit dem Agent sprechen -- Ihn komplexe, mehrstufige Aufgaben ausführen lassen -- `/help` eingeben, um verfügbare Befehle zu sehen -- Dich mit Google, Slack, Notion und mehr verbinden - -### 🖥️ Schnittstellenmodi - -
- CraftOS Banner -
- -CraftBot unterstützt mehrere UI-Modi. Wähle nach deinen Vorlieben: - -| Modus | Befehl | Voraussetzungen | Empfohlen für | -|------|---------|--------------|----------| -| **Browser** | `python run.py` | Node.js 18+ | Moderne Web-Oberfläche, am einfachsten | -| **CLI** | `python run.py --cli` | Keine | Kommandozeile, leichtgewichtig | - -Der **Browser-Modus** ist Standard und wird empfohlen. Ohne Node.js gibt dir das Installationsprogramm eine Anleitung – alternativ kannst du den **CLI-Modus** nutzen. - ---- - -## 🧬 Living UI - -**Living UI ist ein System/App/Dashboard, das mit deinen Anforderungen wächst.** - -Brauchst du ein Kanban-Board mit eingebautem KI-Copiloten? Ein individuelles CRM, -das exakt zu deinem Workflow passt? Ein Unternehmens-Dashboard, das CraftBot -lesen und für dich steuern kann? Bring es als Living UI an den Start — es läuft -neben CraftBot und wächst mit deinen Anforderungen. - -
- Living UI example -
+Bring es als Living UI an den Start: Es läuft neben CraftBot und wächst mit deinen Anforderungen. ### Drei Wege, eine Living UI zu erstellen 1. **Von Grund auf bauen.** Beschreibe in natürlicher Sprache, was du brauchst. CraftBot - gerüst das Datenmodell, die Backend-API und die React-UI und iteriert mit dir + erstellt das Gerüst für Datenmodell, Backend-API und React-UI und iteriert mit dir über einen strukturierten Designprozess.
@@ -206,7 +122,7 @@ neben CraftBot und wächst mit deinen Anforderungen. Importing an existing project as a Living UI
-### Entwickelt sich weiter – mit CraftBot mittendrin +### Entwickelt sich weiter, mit CraftBot mittendrin Eine Living UI ist nie „fertig". Bitte den Agent, Funktionen zu ergänzen, eine Ansicht neu zu gestalten oder sie an neue Daten anzubinden, wenn sich deine Anforderungen ändern. @@ -217,46 +133,18 @@ abfragen und in deinem Namen Aktionen auslösen. ### Hält SaaS-Tools offen und lebendig -Baue, passe an und entwickle deine eigene Living UI weiter – und reduziere deine Abhängigkeit von Abo-Tools, die nie wirklich für dich gemacht waren. - -Wir suchen aktiv nach Entwickler:innen, die ihre Living UIs zeigen und in den **[Living-UI-Marketplace](https://craftos.net/marketplace)** exportieren. PRs sind herzlich willkommen! +Baue, passe an und entwickle deine eigene Living UI weiter und reduziere deine Abhängigkeit von Abo-Tools, die nie wirklich für dich gemacht waren. --- # Drei Living UIs, die du in 5 Minuten ausprobieren kannst -- **📋 Kanban-Board** — Alle Aufgaben, Follow-ups und CTAs an einem Ort. CraftBot kann es bedienen und die PM-Arbeit für dich übernehmen. -- **📊 Habit Tracker** — Baue deine Gewohnheiten auf und verfolge sie. Ein Aktivitätskalender im GitHub-Stil hilft dir, deine Gewohnheiten wie ein:e Entwickler:in zu pflegen. -- **🐦 Luolinglo** — Kein Duolingo, aber damit kannst du neue Sprachen lernen, Karteikarten erstellen und mit CraftBot üben. - -## 🧩 Architekturüberblick - -| Komponente | Beschreibung | -|-----------|-------------| -| **Agent Base** | Zentrale Orchestrierungsschicht, die den Task-Lifecycle verwaltet, zwischen Komponenten koordiniert und die Haupt-Agenten-Schleife steuert. | -| **LLM Interface** | Einheitliche Schnittstelle mit Unterstützung mehrerer LLM-Anbieter (OpenAI, Gemini, Anthropic, BytePlus, Ollama). | -| **Context Engine** | Erzeugt optimierte Prompts mit KV-Cache-Unterstützung. | -| **Action Manager** | Ruft Aktionen aus der Bibliothek ab und führt sie aus. Eigene Aktionen lassen sich leicht erweitern. | -| **Action Router** | Wählt intelligent die am besten passende Aktion auf Basis der Task-Anforderungen und löst Eingabeparameter bei Bedarf über das LLM auf. | -| **Event Stream** | Echtzeit-Event-Publishing-System für Fortschrittsverfolgung, UI-Updates und Ausführungs-Monitoring. | -| **Memory Manager** | RAG-basiertes semantisches Gedächtnis mit ChromaDB. Übernimmt Memory-Chunking, Embedding, Retrieval und inkrementelle Updates. | -| **State Manager** | Globales State-Management zur Verfolgung von Ausführungskontext, Gesprächshistorie und Laufzeitkonfiguration. | -| **Task Manager** | Verwaltet Task-Definitionen, ermöglicht einfache und komplexe Task-Modi, erstellt To-dos und verfolgt mehrstufige Workflows. | -| **Skill Manager** | Lädt einsteckbare Skills und injiziert sie in den Agent-Kontext. | -| **MCP Adapter** | Model Context Protocol Integration, die MCP-Tools in native Aktionen umwandelt. | +- **📋 Kanban-Board:** Alle Aufgaben, Follow-ups und CTAs an einem Ort. CraftBot kann es bedienen und die PM-Arbeit für dich übernehmen. +- **📊 Habit Tracker:** Baue deine Gewohnheiten auf und verfolge sie. Ein Aktivitätskalender im GitHub-Stil hilft dir, deine Gewohnheiten wie ein:e Entwickler:in zu pflegen. +- **🐦 Luolinglo:** Kein Duolingo, aber damit kannst du neue Sprachen lernen, Karteikarten erstellen und mit CraftBot üben. + +**[Stöbere im Living-UI-Marketplace und trage etwas bei →](https://craftos.net/marketplace)** ---- - -# CraftBot im Vergleich zu den Alternativen - -| | v0 / Lovable / Bolt | OpenClaw | Claude Code | **CraftBot** | -| -------------------------------- | ------------------- | -------------------- | -------------------- | --------------------------------------- | -| **Baut individuelle Apps** | ✅ Einmal-Shot | 🚫 | ✅ (manuell) | ✅ Im Dialog | -| **Agent bedient die App** | 🚫 | ⚠️ Per Tool-Aufruf | 🚫 | ✅ In jede Living UI eingebettet | -| **Persistente Agent-Memory** | 🚫 | ✅ | ✅ | ✅ RAG + Agent-Dateisystem + Distillation | -| **Selbst hostbar** | ⚠️ Teilweise | ✅ | 🚫 SaaS | ✅ MIT, auf deiner Maschine | -| **Modell-unabhängig** | ✅ | ✅ | ⚠️ Teilweise | ✅ Große Anbieter + OpenRouter | - --- ## 🔧 Fehlerbehebung & häufige Probleme @@ -267,112 +155,6 @@ Wenn du beim Ausführen von `python run.py` **„npm not found in PATH"** siehst 2. Installiere sie und starte dein Terminal neu 3. Führe `python run.py` erneut aus -| Flag | Beschreibung | -|------|-------------| -| `--conda` | conda-Umgebung nutzen (optional) | - -### run.py - -| Flag | Beschreibung | -|------|-------------| -| (keines) | Im **Browser**-Modus ausführen (empfohlen, Node.js erforderlich) | -| `--cli` | Im **CLI**-Modus ausführen (leichtgewichtig) | - -### craftbot.py - -| Befehl | Beschreibung | -|---------|-------------| -| `install` | Abhängigkeiten installieren, Autostart registrieren und CraftBot starten | -| `start` | CraftBot im Hintergrund starten | -| `stop` | CraftBot stoppen | -| `restart` | Stoppen und neu starten | -| `status` | Laufstatus und Autostart-Status anzeigen | -| `logs [-n N]` | Die letzten N Log-Zeilen anzeigen (Standard: 50) | -| `uninstall` | Autostart-Registrierung entfernen | - -**Installationsbeispiele:** -```bash -# Einfache pip-Installation (ohne conda) -python install.py - -# Mit conda-Umgebung (empfohlen für conda-Nutzer) -python install.py --conda -``` - -**CraftBot ausführen:** - -```powershell -# Browser-Modus (Standard, Node.js erforderlich) -python run.py - -# CLI-Modus (leichtgewichtig) -python run.py --cli -``` - -**Linux/macOS (Bash):** -```bash -# Browser-Modus (Standard, Node.js erforderlich) -python run.py - -# CLI-Modus (leichtgewichtig) -python run.py --cli - -# Mit conda-Umgebung -conda run -n craftbot python run.py -``` - -### 🔧 Hintergrunddienst (empfohlen) - -Betreibe CraftBot als Hintergrunddienst, sodass er auch nach dem Schließen des Terminals weiterläuft. Eine Desktop-Verknüpfung wird automatisch erstellt, damit du den Browser jederzeit wieder öffnen kannst. - -```bash -# Abhängigkeiten installieren, Autostart bei Anmeldung registrieren und CraftBot starten -python craftbot.py install -``` - -Das war's. Das Terminal schließt sich von selbst, CraftBot läuft im Hintergrund und der Browser öffnet sich automatisch. - -```bash -# Weitere Dienstbefehle: -python craftbot.py start # CraftBot im Hintergrund starten -python craftbot.py status # Prüfen, ob er läuft -python craftbot.py stop # CraftBot stoppen -python craftbot.py restart # CraftBot neu starten -python craftbot.py logs # Aktuelle Log-Ausgabe ansehen -``` - -| Befehl | Beschreibung | -|---------|-------------| -| `python craftbot.py install` | Abhängigkeiten installieren, Autostart bei Anmeldung registrieren, CraftBot starten, Browser öffnen und Terminal automatisch schließen | -| `python craftbot.py start` | CraftBot im Hintergrund starten – startet automatisch neu, wenn er bereits läuft (Terminal schließt sich selbst) | -| `python craftbot.py stop` | CraftBot stoppen | -| `python craftbot.py restart` | CraftBot stoppen und starten | -| `python craftbot.py status` | Prüfen, ob CraftBot läuft und ob Autostart aktiviert ist | -| `python craftbot.py logs` | Aktuelle Log-Ausgabe anzeigen (`-n 100` für mehr Zeilen) | -| `python craftbot.py uninstall` | CraftBot stoppen, Autostart entfernen, pip-Pakete deinstallieren und pip-Cache leeren | - -> [!TIP] -> Nach `craftbot.py start` oder `craftbot.py install` wird automatisch eine **CraftBot-Desktop-Verknüpfung** erstellt. Hast du den Browser versehentlich geschlossen, doppelklicke die Verknüpfung, um ihn wieder zu öffnen. - -> [!NOTE] -> **Installation:** Das Installationsprogramm gibt nun klare Hinweise, falls Abhängigkeiten fehlen. Wird Node.js nicht gefunden, wirst du zur Installation aufgefordert oder kannst in den CLI-Modus wechseln. Die Installation erkennt die GPU-Verfügbarkeit automatisch und fällt bei Bedarf auf den CPU-Modus zurück. - -> [!TIP] -> **Ersteinrichtung:** CraftBot führt dich durch einen Onboarding-Ablauf, um API-Schlüssel, den Agentennamen, MCPs und Skills zu konfigurieren. - -> [!NOTE] -> **Playwright Chromium:** Optional für die WhatsApp-Web-Integration. Schlägt die Installation fehl, funktioniert der Agent weiterhin für andere Aufgaben. Manuell nachinstallieren mit: `playwright install chromium` - ---- - -## 🔧 Fehlerbehebung und häufige Probleme - -### Fehlendes Node.js (für den Browser-Modus) -Erscheint **"npm not found in PATH"** beim Ausführen von `python run.py`: -1. Von [nodejs.org](https://nodejs.org/) herunterladen (LTS-Version wählen) -2. Installieren und das Terminal neu starten -3. `python run.py` erneut ausführen - **Alternative:** CLI-Modus verwenden (kein Node.js nötig): ```bash python run.py --cli @@ -395,7 +177,7 @@ Eine ausführliche Fehlerbehebung findest du in [INSTALLATION_FIX.md](INSTALLATI --- ## 🐳 Mit Container ausführen -Im Repository-Root liegt eine Docker-Konfiguration mit Python 3.10, wichtigen System-Paketen (inklusive Tesseract für OCR) und allen Python-Abhängigkeiten aus `environment.yml`/`requirements.txt`, damit der Agent auch in isolierten Umgebungen konsistent läuft. +Im Repository-Root liegt eine Docker-Konfiguration mit Python 3.10, wichtigen System-Paketen (inklusive Tesseract für OCR) und allen Python-Abhängigkeiten aus `environment.yml`/`requirements.txt`, damit der Agent auch in isolierten Umgebungen konsistent läuft. Hier sind die Schritte, um unseren Agent im Container zu starten. @@ -429,7 +211,7 @@ Standardmäßig nutzt das Image Python 3.10 und bündelt die Python-Abhängigkei ## 🤝 Wie du beitragen kannst -PRs sind willkommen! Den Ablauf (Fork → Branch von `dev` → PR) findest du in [CONTRIBUTING.md](CONTRIBUTING.md). Alle Pull Requests durchlaufen automatisch eine Lint- und Smoke-Test-CI. +PRs sind willkommen! Den Ablauf (Fork → Branch von `dev` → PR) findest du in [CONTRIBUTING.md](CONTRIBUTING.md). Alle Pull Requests durchlaufen automatisch eine Lint- und Smoke-Test-CI. > [!IMPORTANT] > **CraftBot** wird aktiv entwickelt, mit Verbesserungen Woche für Woche. Für Fragen oder einen schnelleren Austausch komm zu uns auf [Discord](https://discord.gg/ZN9YHc37HG) oder schreib eine Mail an thamyikfoong(at)craftos.net. @@ -444,7 +226,7 @@ Dieses Projekt steht unter der [MIT-Lizenz](LICENSE). Du darfst es frei nutzen, ## ⭐ Danksagung -Entwickelt und gepflegt von [CraftOS](https://craftos.net/) und Mitwirkenden. +Entwickelt und gepflegt von [CraftOS](https://craftos.net/) und Mitwirkenden. Wenn dir **CraftBot** weiterhilft, gib dem Repository bitte einen ⭐ und teile es mit anderen! --- diff --git a/README.es.md b/README.es.md index 361bb6fb..04122f96 100644 --- a/README.es.md +++ b/README.es.md @@ -1,10 +1,10 @@
- CraftBot + CraftBot
-La mayoría de los agentes se quedan en el chat y las llamadas a herramientas. CraftBot va más allá: construye, hace evolucionar y opera sus propias herramientas SaaS, y luego usa esa capa de herramientas para comunicarse contigo y automatizar tu trabajo. +La mayoría de los agentes se quedan en el chat y las llamadas a herramientas. CraftBot va más allá. Construye, hace evolucionar y opera sus propias herramientas SaaS, y luego usa esa capa de herramientas para comunicarse contigo y automatizar tu trabajo. -Además de eso, CraftBot incluye todas las capacidades de un agente de propósito general. Ejecuta tareas como lo haría un empleado remoto, recuerda tus preferencias y objetivos, y te ayuda de forma proactiva a planificar y actuar sobre lo que más te importa. +Además de eso, CraftBot incluye todas las capacidades básicas de un agente de propósito general. Ejecuta tareas como lo haría un empleado remoto, recuerda tus preferencias y objetivos, y te ayuda de forma proactiva a planificar y actuar sobre lo que más te importa.

Windows @@ -21,6 +21,10 @@ Además de eso, CraftBot incluye todas las capacidades de un agente de propósit Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ Además de eso, CraftBot incluye todas las capacidades de un agente de propósit [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 日本語 | 简体中文 | 繁體中文 | 한국어 | Português | Français | Deutsch

-
- CraftBot Banner -
- ## ✨ Características destacadas Más allá de ser un agente de IA capaz de crear y operar sus propias herramientas SaaS, CraftBot incluye todas las capacidades básicas de un agente, lo que le permite funcionar como un agente de propósito general que te acompaña en tus tareas, herramientas, memoria y flujos de trabajo diarios. @@ -52,9 +45,9 @@ Más allá de ser un agente de IA capaz de crear y operar sus propias herramient - **Living UI.** Crea, importa o haz evolucionar aplicaciones personalizadas que viven dentro de CraftBot. El agente conoce en todo momento el estado de la UI y puede leer, escribir y actuar directamente sobre sus datos. - **Multitarea y enrutamiento de sesiones.** ¿Sigues escribiendo `/new` a mano? CraftBot decide cuándo iniciar una nueva sesión y cuándo retomar una tarea existente, manteniendo unificados la conversación y el contexto. - **Autohospedado y BYOK.** Sistema flexible de proveedores LLM compatible con OpenAI, Google Gemini, Anthropic Claude, OpenRouter y más. O aloja tu propio modelo sin gastar tokens usando Ollama. -- **Sistema de memoria.** Base de conocimiento local construida a partir de tu interacción con CraftBot mediante RAG + sistema de archivos del agente + destilación. CraftBot "sueña" a medianoche y consolida los eventos del día. +- **Sistema de memoria.** Un segundo cerebro construido a partir de tus interacciones con CraftBot. Enfoque híbrido: RAG + grafo de conocimiento + sistema de archivos del agente. CraftBot "sueña" a medianoche y consolida los eventos del día. - **Agente proactivo.** Aprende tus preferencias, hábitos y objetivos de vida. Luego planifica e inicia tareas (con tu aprobación, por supuesto) para ayudarte a mejorar. -- **Integración con herramientas externas.** Conecta tus aplicaciones como Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram y más (¡y vienen más!), con soporte para OAuth o usando tu propia clave. +- **Integración con herramientas externas.** Conecta tus aplicaciones como Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram y más (¡y vienen más!), con soporte para OAuth o usando tu propia clave. Puedes conectar varias cuentas a cada integración. - **Skills y MCP.** Más de 150 MCP y 170 Skills listos para usar. Instalación rápida de nuevas Skills y MCPs. Crea o mejora Skills a partir de tareas completadas con un solo clic. - **Interfaz de navegador y soporte de CLI.** Usa CraftBot como mejor te encaje: con una UI de navegador sencilla para el día a día, o desde la CLI para scripting y entornos headless. @@ -104,84 +97,7 @@ python craftbot.py uninstall # Detiene, quita el autoinicio y desinstala los pa - ¿Un CRM a medida que encaje exactamente con tu flujo de trabajo? - ¿Un dashboard corporativo que CraftBot pueda leer y operar por ti? -```bash -# 1. Clona el repositorio -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. Instala en un entorno conda -python install.py --conda - -# 3. Ejecuta CraftBot -conda run -n craftbot python run.py - -# Si conda no está en PATH (solo Windows): -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> Cada vez que quieras ejecutar CraftBot, usa `conda run -n craftbot python run.py`. No hay servicio en segundo plano — lo inicias y detienes tú mismo. - ---- - -### Opción 3 — Instalación manual (pip) - -**Elige esta si:** quieres control total sobre tu entorno Python y prefieres gestionar CraftBot tú mismo, sin servicio automático ni proceso en segundo plano. - -`install.py` (sin opciones) hace una instalación pip estándar en el entorno Python activo. Inicias y detienes CraftBot manualmente con `run.py`. - -```bash -# 1. Clona el repositorio -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. Instala las dependencias en tu entorno Python activo -python install.py - -# 3. Ejecuta CraftBot -python run.py -``` - -La primera ejecución te guiará para configurar tus claves API y preferencias. - -> [!NOTE] -> Si Node.js no está instalado, el instalador te ofrecerá instrucciones paso a paso. También puedes omitir completamente el modo navegador y usar el modo CLI — sin Node.js: `python run.py --cli` - -### ¿Qué puedes hacer justo después? -- Hablar con el agente de forma natural -- Pedirle que realice tareas complejas de varios pasos -- Escribir `/help` para ver los comandos disponibles -- Conectarte a Google, Slack, Notion y más - -### 🖥️ Modos de interfaz - -
- CraftOS Banner -
- -CraftBot soporta varios modos de UI. Elige según tu preferencia: - -| Modo | Comando | Requisitos | Recomendado para | -|------|---------|--------------|----------| -| **Browser** | `python run.py` | Node.js 18+ | Interfaz web moderna, la más sencilla de usar | -| **CLI** | `python run.py --cli` | Ninguno | Línea de comandos, ligero | - -El **modo navegador** es el predeterminado y recomendado. Si no tienes Node.js, el instalador te ofrecerá instrucciones de instalación o puedes usar el **modo CLI** en su lugar. - ---- - -## 🧬 Living UI - -**Living UI es un sistema/app/panel que evoluciona con tus necesidades.** - -¿Necesitas un tablero kanban con un copiloto de IA integrado? ¿Un CRM personalizado que se -ajuste exactamente a tu flujo de trabajo? ¿Un panel de empresa que CraftBot pueda leer y -manejar por ti? Pon uno en marcha como Living UI: se ejecuta junto a CraftBot y crece a -medida que cambian tus necesidades. - -
- Living UI example -
+Ponlo en marcha como una Living UI que se ejecuta junto a CraftBot y crece a medida que cambian tus necesidades. ### Tres formas de crear una Living UI @@ -219,151 +135,15 @@ API REST y disparar acciones en tu nombre. Construye, personaliza y haz evolucionar tu propia Living UI, y depende menos de herramientas por suscripción que nunca se diseñaron para encajar perfectamente con tus necesidades. -Estamos buscando activamente desarrolladores que muestren sus Living UIs y las exporten al **[marketplace de Living UI](https://craftos.net/marketplace)**. ¡Los PRs son bienvenidos! - --- # Tres Living UIs que puedes probar en 5 minutos -- **📋 Tablero Kanban** — Cada tarea, seguimiento y CTA en un solo lugar. CraftBot puede manejarlo para hacer el trabajo de PM por ti. -- **📊 Habit Tracker** — Desarrolla y mantén tus hábitos. Un calendario de actividad al estilo GitHub para seguir tus hábitos como un desarrollador. -- **🐦 Luolinglo** — No es Duolingo, pero puedes aprender nuevos idiomas, crear flashcards y practicar con CraftBot. - -## 🧩 Visión general de la arquitectura - -| Componente | Descripción | -|-----------|-------------| -| **Agent Base** | Capa de orquestación central que gestiona el ciclo de vida de las tareas, coordina los componentes y maneja el bucle agente principal. | -| **LLM Interface** | Interfaz unificada que soporta múltiples proveedores LLM (OpenAI, Gemini, Anthropic, BytePlus, Ollama). | -| **Context Engine** | Genera prompts optimizados con soporte de KV-cache. | -| **Action Manager** | Recupera y ejecuta acciones desde la biblioteca. Las acciones personalizadas son fáciles de extender. | -| **Action Router** | Selecciona inteligentemente la acción que mejor se ajusta a los requisitos de la tarea y resuelve los parámetros de entrada mediante el LLM cuando es necesario. | -| **Event Stream** | Sistema de publicación de eventos en tiempo real para seguimiento del progreso de tareas, actualizaciones de UI y monitoreo de ejecución. | -| **Memory Manager** | Memoria semántica basada en RAG con ChromaDB. Gestiona fragmentación de memoria, embeddings, recuperación y actualizaciones incrementales. | -| **State Manager** | Gestión global del estado para rastrear el contexto de ejecución del agente, el historial de conversación y la configuración en tiempo de ejecución. | -| **Task Manager** | Administra definiciones de tareas, habilita modos de tareas simples y complejas, crea todos y hace seguimiento a flujos de trabajo multietapa. | -| **Skill Manager** | Carga e inyecta skills intercambiables en el contexto del agente. | -| **MCP Adapter** | Integración con Model Context Protocol que convierte herramientas MCP en acciones nativas. | - ---- - -# CraftBot frente a las alternativas - -| | v0 / Lovable / Bolt | OpenClaw | Claude Code | **CraftBot** | -| -------------------------------- | ------------------- | -------------------- | -------------------- | --------------------------------------- | -| **Construye apps personalizadas** | ✅ De un tirón | 🚫 | ✅ (manual) | ✅ Conversacional | -| **El agente opera la app** | 🚫 | ⚠️ Llamando a herramientas | 🚫 | ✅ Embebido en cada Living UI | -| **Memoria persistente del agente** | 🚫 | ✅ | ✅ | ✅ RAG + sistema de archivos del agente + destilación | -| **Autohospedable** | ⚠️ Parcial | ✅ | 🚫 SaaS | ✅ MIT, en tu propia máquina | -| **Independiente del modelo** | ✅ | ✅ | ⚠️ Parcial | ✅ Principales proveedores + OpenRouter | - ---- - -## 📋 Referencia de comandos - -### install.py - -| Flag | Descripción | -|------|-------------| -| `--conda` | Usa entorno conda (opcional) | - -### run.py - -| Flag | Descripción | -|------|-------------| -| (ninguno) | Ejecutar en modo **Browser** (recomendado, requiere Node.js) | -| `--cli` | Ejecutar en modo **CLI** (ligero) | - -### craftbot.py - -| Comando | Descripción | -|---------|-------------| -| `install` | Instala dependencias, registra el autoarranque e inicia CraftBot | -| `start` | Inicia CraftBot en segundo plano | -| `stop` | Detiene CraftBot | -| `restart` | Detener y luego iniciar | -| `status` | Muestra el estado de ejecución y del autoarranque | -| `logs [-n N]` | Muestra las últimas N líneas de log (por defecto: 50) | -| `uninstall` | Elimina el registro de autoarranque | - -**Ejemplos de instalación:** -```bash -# Instalación simple con pip (sin conda) -python install.py - -# Con entorno conda (recomendado para usuarios de conda) -python install.py --conda -``` - -**Ejecución de CraftBot:** - -```powershell -# Modo navegador (por defecto, requiere Node.js) -python run.py - -# Modo CLI (ligero) -python run.py --cli - -# Con entorno conda -conda run -n craftbot python run.py - -# O usando la ruta completa si conda no está en PATH -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -**Linux/macOS (Bash):** -```bash -# Modo navegador (por defecto, requiere Node.js) -python run.py - -# Modo CLI (ligero) -python run.py --cli - -# Con entorno conda -conda run -n craftbot python run.py -``` - -### 🔧 Servicio en segundo plano (recomendado) - -Ejecuta CraftBot como un servicio en segundo plano para que siga funcionando incluso después de cerrar la terminal. Se crea automáticamente un acceso directo en el escritorio para reabrir el navegador cuando quieras. - -```bash -# Instala dependencias, registra autoarranque al iniciar sesión e inicia CraftBot -python craftbot.py install -``` - -Eso es todo. La terminal se cierra sola, CraftBot se ejecuta en segundo plano y el navegador se abre automáticamente. - -```bash -# Otros comandos del servicio: -python craftbot.py start # Inicia CraftBot en segundo plano -python craftbot.py status # Comprueba si está en ejecución -python craftbot.py stop # Detiene CraftBot -python craftbot.py restart # Reinicia CraftBot -python craftbot.py logs # Ver el log reciente -``` - -| Comando | Descripción | -|---------|-------------| -| `python craftbot.py install` | Instala dependencias, registra autoarranque al iniciar sesión, inicia CraftBot, abre el navegador y cierra la terminal automáticamente | -| `python craftbot.py start` | Inicia CraftBot en segundo plano — se reinicia automáticamente si ya está en ejecución (la terminal se cierra sola) | -| `python craftbot.py stop` | Detiene CraftBot | -| `python craftbot.py restart` | Detiene e inicia CraftBot | -| `python craftbot.py status` | Comprueba si CraftBot está en ejecución y si el autoarranque está habilitado | -| `python craftbot.py logs` | Muestra la salida reciente del log (`-n 100` para más líneas) | -| `python craftbot.py uninstall` | Detiene CraftBot, elimina el registro de autoarranque, desinstala paquetes pip y purga la caché de pip | - -> [!TIP] -> Tras `craftbot.py start` o `craftbot.py install`, se crea automáticamente un **acceso directo de CraftBot en el escritorio**. Si cierras el navegador por error, haz doble clic en el acceso directo para reabrirlo. - -> [!NOTE] -> **Instalación:** El instalador ahora ofrece orientación clara si faltan dependencias. Si no se encuentra Node.js, se te pedirá instalarlo o podrás cambiar al modo CLI. La instalación detecta automáticamente la disponibilidad de GPU y recurre al modo solo CPU si es necesario. - -> [!TIP] -> **Configuración inicial:** CraftBot te guiará por una secuencia de onboarding para configurar claves API, el nombre del agente, MCPs y Skills. +- **📋 Tablero Kanban**: Cada tarea, seguimiento y CTA en un solo lugar. CraftBot puede manejarlo para hacer el trabajo de PM por ti. +- **📊 Habit Tracker**: Desarrolla y mantén tus hábitos. Un calendario de actividad al estilo GitHub para seguir tus hábitos como un desarrollador. +- **🐦 Luolinglo**: No es Duolingo, pero puedes aprender nuevos idiomas, crear flashcards y practicar con CraftBot. -> [!NOTE] -> **Playwright Chromium:** Opcional para la integración con WhatsApp Web. Si falla la instalación, el agente seguirá funcionando para otras tareas. Puedes instalarlo manualmente más tarde con: `playwright install chromium` +**[Explora y contribuye al marketplace de Living UI →](https://craftos.net/marketplace)** --- @@ -446,8 +226,8 @@ Este proyecto está bajo la [Licencia MIT](LICENSE). Puedes usarlo, hospedarlo y ## ⭐ Agradecimientos -Desarrollado y mantenido por [CraftOS](https://craftos.net/) y sus colaboradores. -Si **CraftBot** te resulta útil, dale una ⭐ al repositorio y compártelo. +Desarrollado y mantenido por [CraftOS](https://craftos.net/) y sus colaboradores. +Si **CraftBot** te resulta útil, ¡dale una ⭐ al repositorio y compártelo con otros! --- diff --git a/README.fr.md b/README.fr.md index 2bbe1bbe..eac695bc 100644 --- a/README.fr.md +++ b/README.fr.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
La plupart des harnais d'agents s'arrêtent au chat et aux appels d'outils. CraftBot va plus loin : il construit, fait évoluer et opère ses propres outils SaaS, puis se sert de cette couche d'outils pour communiquer avec vous et automatiser vos tâches. @@ -21,6 +21,10 @@ Au-delà de cela, CraftBot dispose de toutes les capacités essentielles d'un ha Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ Au-delà de cela, CraftBot dispose de toutes les capacités essentielles d'un ha [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 日本語 | 简体中文 | 繁體中文 | 한국어 | Español | Português | Deutsch

-
- CraftBot Banner -
- ## ✨ Fonctionnalités phares En plus d'être un agent IA capable de créer et d'opérer ses propres outils SaaS, CraftBot embarque toutes les fonctionnalités de base d'un harnais d'agent, ce qui lui permet de fonctionner comme un agent IA généraliste qui vous accompagne au quotidien sur vos tâches, vos outils, votre mémoire et vos workflows. @@ -52,9 +45,9 @@ En plus d'être un agent IA capable de créer et d'opérer ses propres outils Sa - **Living UI.** Construisez, importez ou faites évoluer des applications personnalisées qui vivent à l'intérieur de CraftBot. L'agent est en permanence au courant de l'état de l'UI et peut lire, écrire et agir directement sur ses données. - **Multi-tâches et routage de sessions.** Vous tapez encore `/new` à la main ? CraftBot sait quand démarrer une nouvelle session et quand reprendre une tâche, en gardant la conversation et le contexte unifiés. - **Auto-hébergé et BYOK.** Système de fournisseurs LLM flexible qui prend en charge OpenAI, Google Gemini, Anthropic Claude, OpenRouter et plus encore. Ou hébergez votre propre modèle, sans dépenser un seul token, avec Ollama. -- **Système de mémoire.** Une base de connaissance locale construite à partir de vos échanges avec CraftBot via RAG + système de fichiers de l'agent + distillation. À minuit, CraftBot « rêve » et consolide les événements survenus dans la journée. +- **Système de mémoire.** Un second cerveau construit à partir de vos échanges avec CraftBot. Approche hybride : RAG + graphe de connaissances + système de fichiers de l'agent. À minuit, CraftBot « rêve » et consolide les événements survenus dans la journée. - **Agent proactif.** Il apprend vos préférences, vos habitudes et vos objectifs de vie. Puis il planifie et déclenche des tâches (avec votre accord, bien sûr) pour vous aider à progresser. -- **Intégration d'outils externes.** Connectez vos applications comme Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram et bien plus (et bien d'autres à venir !) avec la prise en charge d'OAuth ou votre propre clé. +- **Intégration d'outils externes.** Connectez vos applications comme Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram et bien plus (et bien d'autres à venir !) avec la prise en charge d'OAuth ou votre propre clé. Vous pouvez connecter plusieurs comptes à chaque intégration. - **Skills et MCP.** Plus de 150 MCP et 170 Skills disponibles. Installation rapide de nouveaux Skills et MCP. Créez ou améliorez des Skills à partir de tâches terminées en un clic. - **Interface web et CLI.** Utilisez CraftBot comme il vous convient le mieux : via une UI navigateur simple pour un usage quotidien, ou via la CLI pour le scripting et les environnements headless. @@ -63,31 +56,7 @@ En plus d'être un agent IA capable de créer et d'opérer ses propres outils Sa ## 🧰 Pour commencer -### Prérequis -- Python **3.10+** -- `git` (nécessaire pour cloner le dépôt) -- Une clé API pour le fournisseur LLM de votre choix (OpenAI, Gemini ou Anthropic) -- `Node.js` **18+** (optionnel — requis uniquement pour l'interface navigateur) -- `conda` (optionnel — s'il est introuvable, l'installateur propose d'installer Miniconda automatiquement) - -### Quelle option choisir ? - -> **Vous hésitez ? Optez pour l'Option 1.** Elle gère tout pour vous. - -| | Option 1 — Service | Option 2 — Conda | Option 3 — Manuel | -|---|---|---|---| -| **Pour qui** | La plupart des utilisateurs, débutants, tests | Utilisateurs Conda souhaitant des environnements isolés | Utilisateurs avancés, Python personnalisé, contrôle total | -| **Gère Python/l'environnement automatiquement ?** | ✅ Automatique | ✅ Automatique | ❌ Vous le gérez | -| **Tourne en arrière-plan ?** | ✅ Oui, en tant que service | ❌ Non | ❌ Non | -| **Comment démarrer** | `python craftbot.py install` | `python install.py --conda` | `python install.py` | - ---- - -### ⭐ Option 1 — Installation en service (Recommandée) - -**Choisissez cette option si :** vous voulez que CraftBot fonctionne directement — service en arrière-plan, démarrage automatique à la connexion, raccourci sur le bureau, aucune étape manuelle. - -`craftbot.py` gère tout : environnement Python, dépendances, gestion du processus en arrière-plan et enregistrement du démarrage automatique. +Prérequis : Python 3.10+ · Node.js 18+ pour le mode navigateur ```bash # 1. Cloner le dépôt @@ -98,7 +67,7 @@ cd CraftBot python craftbot.py install ``` -C'est tout. Le terminal se ferme tout seul, CraftBot tourne en arrière-plan et le navigateur s'ouvre automatiquement. Un **raccourci de bureau** est également créé pour vous permettre de rouvrir le navigateur quand vous voulez. +C'est tout. Le terminal se ferme tout seul, CraftBot tourne en arrière-plan et le navigateur s'ouvre automatiquement. Un **raccourci de bureau** est créé pour vous permettre de rouvrir le navigateur quand vous voulez. **Gérer le service après l'installation :** @@ -118,7 +87,7 @@ python craftbot.py uninstall # Arrête, supprime le démarrage auto et désinst ## 🌱 Living UI -**La Living UI est un système / une app / un tableau de bord qui évolue avec vos besoins.** +**Living UI est un système/une application/un tableau de bord qui évolue avec vos besoins.**
CraftBot Banner @@ -128,90 +97,13 @@ python craftbot.py uninstall # Arrête, supprime le démarrage auto et désinst - D'un CRM sur mesure, conçu exactement à la forme de votre workflow ? - D'un tableau de bord d'entreprise que CraftBot puisse lire et piloter pour vous ? -```bash -# 1. Clonez le dépôt -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. Installez dans un environnement conda -python install.py --conda - -# 3. Lancez CraftBot -conda run -n craftbot python run.py - -# Si conda n'est pas dans le PATH (Windows uniquement) : -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> Chaque fois que vous voulez lancer CraftBot, utilisez `conda run -n craftbot python run.py`. Il n'y a pas de service en arrière-plan — vous le démarrez et l'arrêtez vous-même. - ---- - -### Option 3 — Installation manuelle (pip) - -**Choisissez cette option si :** vous souhaitez un contrôle total sur votre environnement Python et préférez gérer CraftBot vous-même, sans service automatique ni processus en arrière-plan. - -`install.py` (sans options) effectue une installation pip standard dans l'environnement Python actif. Vous démarrez et arrêtez CraftBot manuellement avec `run.py`. - -```bash -# 1. Clonez le dépôt -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. Installez les dépendances dans votre environnement Python actif -python install.py - -# 3. Lancez CraftBot -python run.py -``` - -La première exécution vous guidera dans la configuration de vos clés API et préférences. - -> [!NOTE] -> Si Node.js n'est pas installé, l'installateur fournira des instructions étape par étape. Vous pouvez aussi ignorer complètement le mode navigateur et utiliser le mode CLI — sans Node.js : `python run.py --cli` - -### Que pouvez-vous faire tout de suite ? -- Discuter avec l'agent naturellement -- Lui demander d'exécuter des tâches complexes en plusieurs étapes -- Taper `/help` pour voir les commandes disponibles -- Vous connecter à Google, Slack, Notion et plus - -### 🖥️ Modes d'interface - -
- CraftOS Banner -
- -CraftBot propose plusieurs modes d'UI. Choisissez selon vos préférences : - -| Mode | Commande | Prérequis | Idéal pour | -|------|---------|--------------|----------| -| **Browser** | `python run.py` | Node.js 18+ | Interface web moderne, la plus simple à utiliser | -| **CLI** | `python run.py --cli` | Aucun | Ligne de commande, léger | - -Le **mode navigateur** est le mode par défaut et recommandé. Si vous n'avez pas Node.js, l'installateur vous guidera pour l'installer, ou vous pouvez utiliser le **mode CLI**. - ---- - -## 🧬 Living UI - -**Living UI est un système/une application/un tableau de bord qui évolue avec vos besoins.** - -Besoin d'un tableau kanban avec un copilote IA intégré ? D'un CRM sur mesure taillé -exactement pour votre flux de travail ? D'un tableau de bord d'entreprise que CraftBot -peut lire et piloter pour vous ? Lancez-le comme une Living UI — elle tourne aux côtés -de CraftBot et grandit au rythme de vos besoins. - -
- Living UI example -
+Lancez-le comme une Living UI : elle tourne aux côtés de CraftBot et grandit au rythme de vos besoins. ### Trois façons de créer une Living UI 1. **Construire de zéro.** Décrivez ce que vous voulez en langage naturel. CraftBot - échafaude le modèle de données, l'API back-end et l'UI React, puis itère avec vous - à travers un processus de conception structuré. + échafaude le modèle de données, l'API back-end et l'UI React, puis itère avec + vous à travers un processus de conception structuré.
Building a Living UI from scratch @@ -243,149 +135,15 @@ l'API REST et déclencher des actions en votre nom. Construisez, personnalisez et faites évoluer votre propre Living UI, et dépendez moins des outils par abonnement qui n'ont jamais été pensés pour coller parfaitement à vos besoins. -Nous cherchons activement des développeurs qui souhaitent mettre en avant leurs Living UIs et les exporter vers le **[marketplace de Living UI](https://craftos.net/marketplace)**. Les PRs sont les bienvenus ! - --- # Trois Living UIs à essayer en 5 minutes -- **📋 Tableau Kanban** — Toutes les tâches, suivis et CTA au même endroit. CraftBot peut s'en charger et faire le travail de PM pour vous. -- **📊 Habit Tracker** — Mettez en place et suivez vos habitudes. Un calendrier d'activité façon GitHub pour suivre vos habitudes comme on suit ses commits. -- **🐦 Luolinglo** — Ce n'est pas Duolingo, mais vous pouvez y apprendre de nouvelles langues, créer des flashcards et vous entraîner avec CraftBot. - -## 🧩 Aperçu de l'architecture - -| Composant | Description | -|-----------|-------------| -| **Agent Base** | Couche d'orchestration centrale qui gère le cycle de vie des tâches, coordonne les composants et pilote la boucle agentique principale. | -| **LLM Interface** | Interface unifiée prenant en charge plusieurs fournisseurs LLM (OpenAI, Gemini, Anthropic, BytePlus, Ollama). | -| **Context Engine** | Génère des prompts optimisés avec support du cache KV. | -| **Action Manager** | Récupère et exécute les actions depuis la bibliothèque. Les actions personnalisées sont faciles à étendre. | -| **Action Router** | Sélectionne intelligemment l'action la plus adaptée aux exigences de la tâche et résout les paramètres d'entrée via le LLM au besoin. | -| **Event Stream** | Système de publication d'événements en temps réel pour le suivi de la progression des tâches, les mises à jour d'UI et le monitoring d'exécution. | -| **Memory Manager** | Mémoire sémantique basée sur le RAG via ChromaDB. Gère le découpage, l'embedding, la récupération et les mises à jour incrémentales. | -| **State Manager** | Gestion globale de l'état pour suivre le contexte d'exécution de l'agent, l'historique de conversation et la configuration d'exécution. | -| **Task Manager** | Gère les définitions de tâches, permet des modes simples et complexes, crée des to-dos et suit les workflows multi-étapes. | -| **Skill Manager** | Charge et injecte des skills enfichables dans le contexte de l'agent. | -| **MCP Adapter** | Intégration Model Context Protocol qui convertit les outils MCP en actions natives. | - ---- - -## 🔜 Roadmap - -- [X] **Module de mémoire** — Terminé. -- [ ] **Intégration d'outils externes** — En cours d'ajout ! -- [X] **Couche MCP** — Terminée. -- [X] **Couche Skills** — Terminée. -- [ ] **Comportement proactif** — En cours - ---- - -## 📋 Référence des commandes - -### install.py - -| Flag | Description | -|------|-------------| -| `--conda` | Utiliser un environnement conda (optionnel) | - -### run.py - -| Flag | Description | -|------|-------------| -| (aucun) | Lancer en mode **Browser** (recommandé, nécessite Node.js) | -| `--cli` | Lancer en mode **CLI** (léger) | - -### craftbot.py - -| Commande | Description | -|---------|-------------| -| `install` | Installe les deps, enregistre le démarrage automatique et lance CraftBot | -| `start` | Démarre CraftBot en arrière-plan | -| `stop` | Arrête CraftBot | -| `restart` | Arrête puis redémarre | -| `status` | Affiche l'état d'exécution et celui du démarrage automatique | -| `logs [-n N]` | Affiche les N dernières lignes de log (par défaut : 50) | -| `uninstall` | Supprime l'enregistrement du démarrage automatique | - -**Exemples d'installation :** -```bash -# Installation simple via pip (sans conda) -python install.py - -# Avec environnement conda (recommandé pour les utilisateurs de conda) -python install.py --conda -``` - -**Exécuter CraftBot :** - -```powershell -# Mode Browser (par défaut, nécessite Node.js) -python run.py - -# Mode CLI (léger) -python run.py --cli - -# Avec environnement conda -conda run -n craftbot python run.py - -# Ou en utilisant le chemin complet si conda n'est pas dans le PATH -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -**Linux/macOS (Bash) :** -```bash -# Mode Browser (par défaut, nécessite Node.js) -python run.py - -# Mode CLI (léger) -python run.py --cli - -# Avec environnement conda -conda run -n craftbot python run.py -``` - -### 🔧 Service en arrière-plan (recommandé) - -Exécutez CraftBot en tant que service en arrière-plan pour qu'il continue de fonctionner même après la fermeture du terminal. Un raccourci de bureau est créé automatiquement pour rouvrir le navigateur à tout moment. - -```bash -# Installer les dépendances, enregistrer le démarrage automatique à la connexion et lancer CraftBot -python craftbot.py install -``` - -C'est tout. Le terminal se ferme tout seul, CraftBot tourne en arrière-plan et le navigateur s'ouvre automatiquement. - -```bash -# Autres commandes du service : -python craftbot.py start # Démarre CraftBot en arrière-plan -python craftbot.py status # Vérifie s'il tourne -python craftbot.py stop # Arrête CraftBot -python craftbot.py restart # Redémarre CraftBot -python craftbot.py logs # Affiche les logs récents -``` - -| Commande | Description | -|---------|-------------| -| `python craftbot.py install` | Installe les dépendances, enregistre le démarrage automatique à la connexion, lance CraftBot, ouvre le navigateur et ferme le terminal automatiquement | -| `python craftbot.py start` | Démarre CraftBot en arrière-plan — redémarre automatiquement s'il est déjà lancé (le terminal se ferme tout seul) | -| `python craftbot.py stop` | Arrête CraftBot | -| `python craftbot.py restart` | Arrête puis démarre CraftBot | -| `python craftbot.py status` | Vérifie si CraftBot tourne et si le démarrage automatique est activé | -| `python craftbot.py logs` | Affiche les logs récents (`-n 100` pour plus de lignes) | -| `python craftbot.py uninstall` | Arrête CraftBot, supprime le démarrage automatique, désinstalle les paquets pip et purge le cache pip | - -> [!TIP] -> Après `craftbot.py start` ou `craftbot.py install`, un **raccourci CraftBot sur le bureau** est créé automatiquement. Si vous fermez le navigateur par accident, double-cliquez sur le raccourci pour le rouvrir. - -> [!NOTE] -> **Installation :** L'installateur fournit maintenant des indications claires si des dépendances manquent. Si Node.js est introuvable, on vous proposera de l'installer ou de basculer en mode CLI. L'installation détecte automatiquement la disponibilité du GPU et bascule en mode CPU si nécessaire. - -> [!TIP] -> **Première configuration :** CraftBot vous guidera dans une séquence d'onboarding pour configurer les clés API, le nom de l'agent, les MCP et les Skills. +- **📋 Tableau Kanban** : toutes les tâches, suivis et CTA au même endroit. CraftBot peut s'en charger et faire le travail de PM pour vous. +- **📊 Habit Tracker** : mettez en place et suivez vos habitudes. Un calendrier d'activité façon GitHub pour suivre vos habitudes comme on suit ses commits. +- **🐦 Luolinglo** : ce n'est pas Duolingo, mais vous pouvez y apprendre de nouvelles langues, créer des flashcards et vous entraîner avec CraftBot. -> [!NOTE] -> **Playwright Chromium :** Optionnel pour l'intégration WhatsApp Web. Si l'installation échoue, l'agent fonctionnera toujours pour les autres tâches. Installez-le manuellement plus tard avec : `playwright install chromium` +**[Parcourez le marketplace de Living UI et contribuez-y →](https://craftos.net/marketplace)** --- @@ -468,7 +226,7 @@ Ce projet est distribué sous [Licence MIT](LICENSE). Vous êtes libre de l'util ## ⭐ Remerciements -Développé et maintenu par [CraftOS](https://craftos.net/) et ses contributeurs. +Développé et maintenu par [CraftOS](https://craftos.net/) et ses contributeurs. Si **CraftBot** vous est utile, mettez une ⭐ au dépôt et partagez-le autour de vous ! --- diff --git a/README.ja.md b/README.ja.md index 25df260b..6139a33f 100644 --- a/README.ja.md +++ b/README.ja.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
ほとんどのエージェントハーネスは、チャットとツール呼び出しで止まります。CraftBotはその先へ進みます。自分自身のSaaSツールを構築し、進化させ、運用し、そのツールレイヤーを通じてあなたとコミュニケーションし、自動化を行います。 @@ -21,6 +21,10 @@ Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 简体中文 | 繁體中文 | 한국어 | Español | Português | Français | Deutsch

-
- CraftBot Banner -
- ## ✨ 主な特徴 自前のSaaSツールを作って動かせるAIエージェントというだけでなく、CraftBotはエージェントハーネスのコア機能をひと通り備えており、あなたのタスク・ツール・記憶・日々のワークフローと一緒に動く汎用AIエージェントとして機能します。 @@ -52,9 +45,9 @@ - **Living UI.** CraftBotの中で動くカスタムアプリを構築・インポート・進化させられます。エージェントはUIの状態を常に把握し、そのデータを直接読み書き・操作できます。 - **マルチタスクとセッションルーティング.** まだ`/new`コマンドを叩いていますか？CraftBotは、いつ新しいセッションを始め、いつ既存のタスクを再開すべきかを自分で判断し、会話とコンテキストを一本化します。 - **セルフホスト & BYOK.** OpenAI、Google Gemini、Anthropic Claude、OpenRouterなどに対応する柔軟なLLMプロバイダーシステム。Ollamaを使えば、自分のモデルをトークン消費ゼロでホストすることも可能です。 -- **メモリーシステム.** CraftBotとのやり取りから、RAG + エージェントファイルシステム + 蒸留によってローカルの知識ベースを構築。CraftBotは深夜に「夢を見て」、その日の出来事を統合します。 +- **メモリーシステム.** CraftBotとのやり取りから構築されるセカンドブレイン。ハイブリッド構成:RAG + ナレッジグラフ + エージェントファイルシステム。CraftBotは深夜に「夢を見て」、その日の出来事を統合します。 - **能動的なエージェント.** あなたの好み、習慣、人生の目標を学習。そのうえで計画を立て、タスクを起動(もちろん承認付きで)し、あなたの人生をより良くする手助けをします。 -- **外部ツールとの連携.** Google Workspace、Slack、Notion、Zoom、LinkedIn、Discord、Telegramなどのアプリと接続可能(今後さらに追加予定)。OAuthまたは自分のキーでの利用に対応しています。 +- **外部ツールとの連携.** Google Workspace、Slack、Notion、Zoom、LinkedIn、Discord、Telegramなどのアプリと接続可能(今後さらに追加予定)。OAuthまたは自分のキーでの利用に対応しています。各連携には複数のアカウントを接続できます。 - **スキル & MCP.** 150以上のMCPと170以上のスキルが利用可能。新しいスキルやMCPもすぐに導入できます。完了したタスクからワンクリックでスキルを作成・改善することもできます。 - **ブラウザUIとCLIに対応.** あなたの使い方に合わせて選べます。日常使いには手軽なブラウザUIを、スクリプトやヘッドレス環境にはCLIをどうぞ。 @@ -104,87 +97,13 @@ python craftbot.py uninstall # 停止・自動起動の解除・パッケージ - 自分のワークフローにぴったり合うカスタムCRMは? - CraftBotがあなたに代わって読み取り・操作できる社内ダッシュボードは? -```bash -# 1. リポジトリをクローン -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. conda環境にインストール -python install.py --conda - -# 3. CraftBotを実行 -conda run -n craftbot python run.py - -# condaがPATHにない場合（Windowsのみ）： -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> CraftBotを実行するたびに `conda run -n craftbot python run.py` を使用してください。バックグラウンドサービスはありません — 自分で起動と停止を行います。 - ---- - -### オプション3 — 手動インストール（pip） - -**これを選ぶなら：** Python環境を完全に自分で管理したい場合、自動サービスやバックグラウンドプロセスは不要な場合。 - -`install.py`（フラグなし）は現在アクティブなPython環境に標準pip installを実行します。`run.py` を使って手動でCraftBotを起動・停止します。 - -```bash -# 1. リポジトリをクローン -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. アクティブなPython環境に依存関係をインストール -python install.py - -# 3. CraftBotを実行 -python run.py -``` - -初回実行時にAPIキーと設定のセットアップがガイドされます。 - -> [!NOTE] -> Node.jsがインストールされていない場合、インストーラーがステップバイステップの手順を提供します。ブラウザモードを完全にスキップしてCLIモードを使用することもできます — Node.js不要：`python run.py --cli` - -### インストール後にできること -- エージェントと自然言語で会話 -- 複雑なマルチステップタスクの実行を依頼 -- `/help` と入力して利用可能なコマンドを確認 -- Google、Slack、Notionなどに接続 - -### 🖥️ インターフェースモード - -
- CraftOS Banner -
- -CraftBotは複数のUIモードをサポートしています。お好みに応じて選択してください： - -| モード | コマンド | 要件 | 最適な用途 | -|------|---------|--------------|----------| -| **ブラウザ** | `python run.py` | Node.js 18+ | モダンなWebインターフェース、最も使いやすい | -| **CLI** | `python run.py --cli` | なし | コマンドライン、軽量 | - -**ブラウザモード**がデフォルトで推奨されます。Node.jsがない場合は、インストーラーがインストール手順を提供するか、代わりに**CLIモード**を使用できます。 - ---- - -## 🧬 Living UI - -**Living UIは、あなたのニーズに合わせて進化するシステム/アプリ/ダッシュボードです。** - -AIコパイロットが組み込まれたカンバンボードが必要ですか？あなたのワークフローに合わせて形作られたカスタムCRMは？ -CraftBotが読み取って操作できる会社のダッシュボードは？ Living UIとして立ち上げれば、CraftBotと並んで動作し、あなたのニーズの変化に合わせて成長します。 -
- Living UI example -
- ### Living UIを作る3つの方法 -1. **ゼロから構築.** 欲しいものを自然な言葉で説明してください。CraftBotがデータモデル、バックエンドAPI、ReactのUIを足場として組み上げ、構造化された設計プロセスを通して一緒に改善していきます。 +1. **ゼロから構築.** 欲しいものを自然な言葉で説明してください。CraftBotが + データモデル、バックエンドAPI、ReactのUIを足場として組み上げ、 + 構造化された設計プロセスを通して一緒に改善していきます。
Building a Living UI from scratch @@ -196,7 +115,8 @@ Living UIとして立ち上げれば、CraftBotと並んで動作し、あなた Living UI marketplace
-3. **既存プロジェクトをインポート.** Go、Node.js、Python、Rust、または静的なソースコードやGitHubリポジトリをCraftBotに渡してください。ランタイムを検出し、ヘルスチェックを設定し、Living UIとしてラップします。 +3. **既存プロジェクトをインポート.** Go、Node.js、Python、Rust、 + または静的なソースコードやGitHubリポジトリをCraftBotに渡してください。ランタイムを検出し、ヘルスチェックを設定し、Living UIとしてラップします。
Importing an existing project as a Living UI @@ -204,145 +124,26 @@ Living UIとして立ち上げれば、CraftBotと並んで動作し、あなた ### CraftBotを内部に組み込んだまま進化し続ける -Living UIに「完成」はありません。ニーズが変われば、機能を追加したり、ビューをリデザインしたり、新しいデータと連携させたり、エージェントに頼んでください。 +Living UIに「完成」はありません。ニーズが変われば、機能を追加したり、 +ビューをリデザインしたり、新しいデータと連携させたり、エージェントに頼んでください。 -CraftBotはすべてのLiving UIに組み込まれており、**状態を常に把握**しています。現在のDOMやフォーム値を読み取り、REST API経由でアプリのデータを参照し、あなたに代わってアクションを起こせます。 +CraftBotはすべてのLiving UIに組み込まれており、**状態を常に把握**しています。 +現在のDOMやフォーム値を読み取り、REST API経由で +アプリのデータを参照し、あなたに代わってアクションを起こせます。 ### SaaSツールをオープンに、生き続けるものへ 自分専用のLiving UIを構築・カスタマイズ・進化させ、自分の用途に完璧には合わないサブスクリプションツールへの依存を減らしていきましょう。 -私たちはLiving UIを公開してくれる開発者を積極的に探しており、**[Living UIマーケットプレイス](https://craftos.net/marketplace)**にエクスポートできます。PRも大歓迎です! - --- # 5分で試せる3つのLiving UI -- **📋 カンバンボード** — タスク、フォローアップ、CTAをすべて一か所に。CraftBotが操作してPM業務を肩代わりできます。 -- **📊 習慣トラッカー** — 習慣を作り、追跡する。開発者がコミットを刻むように、GitHub風のアクティビティカレンダーで習慣を可視化。 -- **🐦 Luolinglo** — Duolingoではないですが、新しい言語を学び、フラッシュカードを作り、CraftBotと一緒に練習できます。 - -## 🧩 アーキテクチャの概要 - -| コンポーネント | 説明 | -|-----------|-------------| -| **エージェントベース** | タスクライフサイクルを管理し、コンポーネント間を調整し、メインのエージェントループを処理するコアオーケストレーションレイヤー。 | -| **LLMインターフェース** | 複数のLLMプロバイダー（OpenAI、Gemini、Anthropic、BytePlus、Ollama）をサポートする統一インターフェース。 | -| **コンテキストエンジン** | KVキャッシュサポートで最適化されたプロンプトを生成。 | -| **アクションマネージャー** | ライブラリからアクションを取得して実行。カスタムアクションの拡張が容易。 | -| **アクションルーター** | タスク要件に基づいて最適なアクションをインテリジェントに選択し、必要に応じてLLMを介して入力パラメータを解決。 | -| **イベントストリーム** | タスク進行状況の追跡、UI更新、実行モニタリング用のリアルタイムイベント発行システム。 | -| **メモリマネージャー** | ChromaDBを使用したRAGベースのセマンティックメモリ。メモリのチャンキング、埋め込み、検索、増分更新を処理。 | -| **ステートマネージャー** | エージェント実行コンテキスト、会話履歴、ランタイム設定を追跡するグローバルステート管理。 | -| **タスクマネージャー** | タスク定義を管理し、シンプルタスクと複雑タスクモードの切り替え、TODO作成、マルチステップワークフロー追跡を可能にします。 | -| **スキルマネージャー** | エージェントコンテキストにプラグイン可能なスキルをロードして注入。 | -| **MCPアダプター** | MCPツールをネイティブアクションに変換するModel Context Protocol統合。 | - ---- - -## 🔜 ロードマップ - -- [X] **メモリモジュール** — 完了。 -- [ ] **外部ツール統合** — さらに追加中！ -- [X] **MCPレイヤー** — 完了。 -- [X] **スキルレイヤー** — 完了。 -- [ ] **プロアクティブな動作** — 実装予定 - ---- - -## 📋 コマンドリファレンス - -### install.py - -| フラグ | 説明 | -|------|-------------| -| `--conda` | conda環境を使用（オプション） | - -### run.py - -| フラグ | 説明 | -|------|-------------| -| (なし) | **ブラウザ**モードで実行（推奨、Node.jsが必要） | -| `--cli` | **CLI**モードで実行（軽量） | - -**インストール例:** -```bash -# シンプルなpipインストール（condaなし） -python install.py - -# conda環境を使用（condaユーザー向け推奨） -python install.py --conda -``` - -**CraftBotの実行:** - -```powershell -# ブラウザモード（デフォルト、Node.jsが必要） -python run.py - -# CLIモード（軽量） -python run.py --cli - -# conda環境で -conda run -n craftbot python run.py - -# condaがPATHにない場合はフルパスを使用 -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -**Linux/macOS (Bash):** -```bash -# ブラウザモード（デフォルト、Node.jsが必要） -python run.py - -# CLIモード（軽量） -python run.py --cli - -# conda環境で -conda run -n craftbot python run.py -``` - -### 🔧 バックグラウンドサービス（推奨） - -ターミナルを閉じても CraftBot が動き続けるようにバックグラウンドサービスとして実行します。デスクトップショートカットが自動作成されるので、いつでもブラウザを再度開けます。 - -```bash -# 依存関係インストール、ログイン時自動起動の登録、CraftBot の起動 -python craftbot.py install -``` - -以上です。ターミナルは自動で閉じ、CraftBot はバックグラウンドで動作し、ブラウザが自動で開きます。 - -```bash -# その他のサービスコマンド: -python craftbot.py start # CraftBot をバックグラウンドで起動 -python craftbot.py status # 実行中かどうか確認 -python craftbot.py stop # CraftBot を停止 -python craftbot.py restart # CraftBot を再起動 -python craftbot.py logs # 最近のログ出力を確認 -``` - -| コマンド | 説明 | -|---------|-------------| -| `python craftbot.py install` | 依存関係インストール、ログイン時自動起動の登録、CraftBot 起動、ブラウザを開き、ターミナルを自動で閉じる | -| `python craftbot.py start` | CraftBot をバックグラウンドで起動（すでに実行中の場合は自動再起動、ターミナルは自動で閉じる） | -| `python craftbot.py stop` | CraftBot を停止 | -| `python craftbot.py restart` | CraftBot を停止して再起動 | -| `python craftbot.py status` | CraftBot が実行中か、自動起動が有効かを確認 | -| `python craftbot.py logs` | 最近のログ出力を表示（`-n 100` でより多く表示） | -| `python craftbot.py uninstall` | CraftBot を停止、自動起動の登録解除、pip パッケージのアンインストール、pip キャッシュの削除 | - -> [!TIP] -> `craftbot.py start` または `craftbot.py install` の後、**CraftBot デスクトップショートカット**が自動作成されます。ブラウザを誤って閉じた場合は、ショートカットをダブルクリックして再度開けます。 - -> [!NOTE] -> **インストール:** インストーラーは依存関係が不足している場合、明確なガイダンスを提供します。Node.jsが見つからない場合は、インストールを促すか、CLIモードに切り替えることができます。インストールはGPUの可用性を自動検出し、必要に応じてCPU専用モードにフォールバックします。 - -> [!TIP] -> **初回セットアップ:** CraftBotはAPIキー、エージェントの名前、MCP、スキルを設定するオンボーディングシーケンスをガイドします。 +- **📋 カンバンボード**: タスク、フォローアップ、CTAをすべて一か所に。CraftBotが操作してPM業務を肩代わりできます。 +- **📊 習慣トラッカー**: 習慣を作り、追跡する。開発者がコミットを刻むように、GitHub風のアクティビティカレンダーで習慣を可視化。 +- **🐦 Luolinglo**: Duolingoではないですが、新しい言語を学び、フラッシュカードを作り、CraftBotと一緒に練習できます。 -> [!NOTE] -> **Playwright Chromium:** WhatsApp Web連携にはオプションです。インストールに失敗しても、エージェントは他のタスクでは問題なく動作します。後で手動でインストールできます: `playwright install chromium` +**[Living UIマーケットプレイスを見る・投稿する →](https://craftos.net/marketplace)** --- @@ -425,7 +226,7 @@ PR歓迎です! ワークフロー(フォーク → `dev`からブランチを ## ⭐ 謝辞 -[CraftOS](https://craftos.net/) とコントリビューターによって開発・メンテナンスされています。 +[CraftOS](https://craftos.net/) とコントリビューターによって開発・メンテナンスされています。 **CraftBot** が役に立ったら、ぜひリポジトリに⭐を付けて、他の人にもシェアしてください! --- diff --git a/README.ko.md b/README.ko.md index d797feb5..33faef7e 100644 --- a/README.ko.md +++ b/README.ko.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
대부분의 에이전트 하네스는 채팅과 도구 호출에서 멈춥니다. CraftBot은 거기서 한 발 더 나아갑니다. 자신만의 SaaS 도구를 직접 만들고, 진화시키고, 운영하며, 그 도구 계층을 통해 사용자와 소통하고 자동화를 수행합니다. @@ -21,6 +21,10 @@ Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 日本語 | 简体中文 | 繁體中文 | Español | Português | Français | Deutsch

-
- CraftBot Banner -
- ## ✨ 주요 기능 자체 SaaS 도구를 만들고 운영할 수 있는 AI 에이전트라는 점 외에도, CraftBot은 에이전트 하네스로서의 핵심 기능을 모두 갖추고 있어 작업, 도구, 메모리, 일상 워크플로 전반에서 범용 AI 에이전트로 사용자와 함께 일할 수 있습니다. @@ -52,14 +45,15 @@ - **Living UI.** CraftBot 안에서 동작하는 커스텀 앱을 만들고, 가져오고, 발전시킬 수 있습니다. 에이전트는 UI의 상태를 항상 인지하고 있으며, 그 데이터를 직접 읽고 쓰고 다룰 수 있습니다. - **멀티태스킹과 세션 라우팅.** 아직도 `/new` 명령어를 직접 입력하시나요? CraftBot은 언제 새 세션을 시작하고 언제 기존 작업을 이어갈지 스스로 판단하여 대화와 컨텍스트를 하나로 유지합니다. - **셀프 호스팅 & BYOK.** OpenAI, Google Gemini, Anthropic Claude, OpenRouter 등을 지원하는 유연한 LLM 제공자 시스템. 또는 Ollama로 토큰 소비 0으로 자신만의 모델을 호스팅할 수 있습니다. -- **메모리 시스템.** RAG + 에이전트 파일 시스템 + 디스틸레이션을 통해 CraftBot과의 상호작용으로부터 로컬 지식 베이스를 구축합니다. CraftBot은 자정에 "꿈을 꾸며" 하루 동안 일어난 이벤트를 통합합니다. +- **메모리 시스템.** CraftBot과의 상호작용으로부터 구축되는 세컨드 브레인입니다. 하이브리드 방식: RAG + 지식 그래프 + 에이전트 파일 시스템. CraftBot은 자정에 "꿈을 꾸며" 하루 동안 일어난 이벤트를 통합합니다. - **능동적 에이전트.** 당신의 선호, 습관, 인생 목표를 학습합니다. 그리고 계획을 세우고 작업을 시작(물론 승인을 받아)하여 당신이 인생에서 더 나아질 수 있도록 돕습니다. -- **외부 도구 통합.** Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram 등 당신의 앱(더 많이 추가될 예정!)과 OAuth 또는 자체 키로 연결할 수 있습니다. +- **외부 도구 통합.** Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram 등 당신의 앱(더 많이 추가될 예정!)과 OAuth 또는 자체 키로 연결할 수 있습니다. 각 통합에 여러 계정을 연결할 수 있습니다. - **Skills와 MCP.** 150개 이상의 MCP와 170개 이상의 Skills가 준비되어 있습니다. 새로운 Skills와 MCP를 빠르게 설치할 수 있고, 완료된 작업에서 한 번의 클릭으로 Skills를 만들거나 개선할 수 있습니다. - **브라우저 인터페이스와 CLI 지원.** 당신에게 맞는 방식으로 CraftBot을 사용하세요. 일상적인 사용에는 간단한 브라우저 UI를, 스크립팅과 헤드리스 환경에는 CLI를 사용할 수 있습니다. --- + ## 🧰 시작하기 요구 사항: Python 3.10+ · 브라우저 모드는 Node.js 18+ 필요 @@ -103,87 +97,13 @@ python craftbot.py uninstall # 중지, 자동 시작 해제, 패키지 제거 - 당신의 워크플로에 딱 맞춘 커스텀 CRM은요? - CraftBot이 대신 읽고 조작할 수 있는 회사 대시보드는요? -```bash -# 1. 리포지토리 클론 -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. conda 환경에 설치 -python install.py --conda - -# 3. CraftBot 실행 -conda run -n craftbot python run.py - -# conda가 PATH에 없는 경우 (Windows 전용): -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> CraftBot을 실행할 때마다 `conda run -n craftbot python run.py`를 사용하세요. 백그라운드 서비스가 없으므로 직접 시작하고 중지해야 합니다. - ---- - -### 옵션 3 — 수동 설치 (pip) - -**이것을 선택하세요:** Python 환경을 완전히 직접 관리하고 싶고, 자동 서비스나 백그라운드 프로세스 없이 CraftBot을 관리하고 싶은 경우. - -`install.py`(플래그 없음)는 현재 활성화된 Python 환경에 표준 pip 설치를 수행합니다. `run.py`로 CraftBot을 수동으로 시작하고 중지합니다. - -```bash -# 1. 리포지토리 클론 -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. 활성 Python 환경에 의존성 설치 -python install.py - -# 3. CraftBot 실행 -python run.py -``` - -첫 실행 시 API 키 설정 과정을 안내해 줍니다. - -> [!NOTE] -> Node.js가 설치되어 있지 않다면 설치 프로그램이 단계별로 안내해 줍니다. CLI 모드를 사용하면 브라우저 모드를 완전히 건너뛸 수도 있습니다 — Node.js 불필요: `python run.py --cli` - -### 바로 할 수 있는 일 -- 에이전트와 자연스럽게 대화 -- 복잡한 다단계 작업 요청 -- `/help`를 입력해 사용 가능한 명령 확인 -- Google, Slack, Notion 등과 연결 - -### 🖥️ 인터페이스 모드 - -
- CraftOS Banner -
- -CraftBot은 여러 UI 모드를 지원합니다. 선호에 따라 선택하세요. - -| 모드 | 명령어 | 요구 사항 | 적합한 용도 | -|------|---------|--------------|----------| -| **Browser** | `python run.py` | Node.js 18+ | 최신 웹 인터페이스, 가장 사용하기 쉬움 | -| **CLI** | `python run.py --cli` | 없음 | 커맨드라인, 경량 | - -**브라우저 모드**가 기본이자 권장 모드입니다. Node.js가 없는 경우 설치 프로그램이 설치 안내를 제공하거나, 대신 **CLI 모드**를 사용할 수 있습니다. - ---- - -## 🧬 Living UI - -**Living UI는 당신의 필요에 따라 진화하는 시스템/앱/대시보드입니다.** - -AI 코파일럿이 내장된 칸반 보드가 필요한가요? 당신의 워크플로에 딱 맞게 만든 맞춤형 CRM은요? -CraftBot이 읽고 조작할 수 있는 회사 대시보드는요? -Living UI로 실행하세요 — CraftBot과 함께 작동하며, 당신의 필요가 변할수록 함께 성장합니다. - -
- Living UI example -
+CraftBot과 나란히 실행되고, 필요가 변할수록 함께 성장하는 Living UI로 띄워 보세요. ### Living UI를 만드는 세 가지 방법 -1. **처음부터 빌드.** 자연어로 원하는 것을 설명하세요. CraftBot이 데이터 모델, 백엔드 API, React UI를 골조로 잡고, 구조화된 설계 프로세스를 통해 함께 다듬어 갑니다. +1. **처음부터 빌드.** 자연어로 원하는 것을 설명하세요. CraftBot이 + 데이터 모델, 백엔드 API, React UI를 골조로 잡고, 구조화된 + 설계 프로세스를 통해 함께 다듬어 갑니다.
Building a Living UI from scratch @@ -195,167 +115,35 @@ Living UI로 실행하세요 — CraftBot과 함께 작동하며, 당신의 필 Living UI marketplace
-3. **기존 프로젝트 가져오기.** Go, Node.js, Python, Rust 소스 코드나 정적 사이트, GitHub 저장소를 CraftBot에 알려주세요. 런타임을 감지하고 헬스 체크를 설정한 뒤 Living UI로 감싸줍니다. +3. **기존 프로젝트 가져오기.** Go, Node.js, Python, Rust 소스 코드나 + 정적 사이트, GitHub 저장소를 CraftBot에 알려주세요. 런타임을 감지하고 헬스 체크를 설정한 뒤 Living UI로 감싸줍니다.
Importing an existing project as a Living UI
-### 에이전트를 항상 곁에 두고 계속 진화 +### CraftBot을 루프 안에 두고 계속 진화 -Living UI는 "완성"이라는 게 없습니다. 필요가 바뀌면 에이전트에게 기능을 추가하거나, 화면을 다시 디자인하거나, 새로운 데이터를 연결하도록 요청하세요. +Living UI는 "완성"이라는 게 없습니다. 필요가 바뀌면 에이전트에게 기능을 +추가하거나, 화면을 다시 디자인하거나, 새로운 데이터를 연결하도록 요청하세요. -CraftBot은 모든 Living UI에 내장되어 있으며 그 **상태를 항상 인지**합니다. 현재 DOM과 폼 값을 읽고, REST API로 앱 데이터를 조회하며, 사용자를 대신해 액션을 트리거할 수 있습니다. +CraftBot은 모든 Living UI에 내장되어 있으며 그 **상태를 항상 인지**합니다. +현재 DOM과 폼 값을 읽고, REST API로 앱 데이터를 조회하며, +사용자를 대신해 액션을 트리거할 수 있습니다. ### SaaS 도구를 열린 상태로, 살아 있는 채로 자기 자신만의 Living UI를 만들고, 커스터마이즈하고, 진화시키며, 결코 당신의 필요에 완벽히 맞춰지지 않은 구독형 도구에 대한 의존을 줄여보세요. -우리는 자신만의 Living UI를 선보일 개발자를 적극적으로 찾고 있으며, **[Living UI 마켓플레이스](https://craftos.net/marketplace)**로 내보낼 수 있도록 지원합니다. PR 환영합니다! - --- # 5분 안에 체험해 볼 수 있는 Living UI 3종 -- **📋 칸반 보드** — 모든 작업, 후속 조치, CTA를 한 곳에. CraftBot이 직접 운영하며 PM 업무를 대신 처리할 수 있습니다. -- **📊 습관 트래커** — 습관을 만들고 추적하세요. GitHub 스타일의 활동 캘린더로 개발자처럼 습관을 관리할 수 있습니다. -- **🐦 Luolinglo** — 듀오링고는 아니지만, 새로운 언어를 배우고 플래시카드를 만들며 CraftBot과 함께 연습할 수 있습니다. - -## 🧩 아키텍처 개요 - -| 구성 요소 | 설명 | -|-----------|-------------| -| **Agent Base** | 작업 라이프사이클을 관리하고 구성 요소 간 조정을 담당하며 주요 에이전틱 루프를 처리하는 핵심 오케스트레이션 계층. | -| **LLM Interface** | 여러 LLM 제공자(OpenAI, Gemini, Anthropic, BytePlus, Ollama)를 지원하는 통합 인터페이스. | -| **Context Engine** | KV 캐시를 지원하는 최적화된 프롬프트를 생성합니다. | -| **Action Manager** | 라이브러리에서 액션을 가져와 실행합니다. 커스텀 액션을 쉽게 확장할 수 있습니다. | -| **Action Router** | 작업 요구 사항에 가장 잘 맞는 액션을 지능적으로 선택하고, 필요 시 LLM을 통해 입력 매개변수를 해결합니다. | -| **Event Stream** | 작업 진행 추적, UI 업데이트, 실행 모니터링을 위한 실시간 이벤트 게시 시스템. | -| **Memory Manager** | ChromaDB 기반의 RAG 시맨틱 메모리. 메모리 청킹, 임베딩, 검색, 점진적 업데이트를 처리합니다. | -| **State Manager** | 에이전트 실행 컨텍스트, 대화 이력, 런타임 구성을 추적하는 전역 상태 관리. | -| **Task Manager** | 작업 정의를 관리하며 단순/복잡 작업 모드, 할 일 생성, 다단계 워크플로우 추적을 가능하게 합니다. | -| **Skill Manager** | 플러그형 스킬을 로드하여 에이전트 컨텍스트에 주입합니다. | -| **MCP Adapter** | MCP 도구를 네이티브 액션으로 변환하는 Model Context Protocol 통합. | - ---- - -# CraftBot vs. 대안들 - -| | v0 / Lovable / Bolt | OpenClaw | Claude Code | **CraftBot** | -| -------------------------------- | ------------------- | -------------------- | -------------------- | --------------------------------------- | -| **커스텀 앱 빌드** | ✅ 일회성 | 🚫 | ✅ (수동) | ✅ 대화형 | -| **에이전트가 앱을 직접 조작** | 🚫 | ⚠️ 도구 호출 방식 | 🚫 | ✅ 모든 Living UI에 내장 | -| **영속적인 에이전트 메모리** | 🚫 | ✅ | ✅ | ✅ RAG + 에이전트 파일 시스템 + 디스틸레이션 | -| **셀프 호스트** | ⚠️ 부분 지원 | ✅ | 🚫 SaaS | ✅ MIT, 내 컴퓨터에서 | -| **모델 비의존** | ✅ | ✅ | ⚠️ 부분 지원 | ✅ 주요 프로바이더 + OpenRouter | - ---- - -## 🔧 트러블슈팅과 자주 묻는 문제 - -### install.py - -| 플래그 | 설명 | -|------|-------------| -| `--conda` | conda 환경 사용 (선택 사항) | - -### run.py - -| 플래그 | 설명 | -|------|-------------| -| (없음) | **Browser** 모드로 실행 (권장, Node.js 필요) | -| `--cli` | **CLI** 모드로 실행 (경량) | - -### craftbot.py - -| 명령 | 설명 | -|---------|-------------| -| `install` | 의존성 설치, 자동 시작 등록, CraftBot 실행 | -| `start` | CraftBot을 백그라운드에서 실행 | -| `stop` | CraftBot 중지 | -| `restart` | 중지 후 다시 시작 | -| `status` | 실행 상태 및 자동 시작 상태 표시 | -| `logs [-n N]` | 마지막 N개의 로그 라인 표시 (기본값: 50) | -| `uninstall` | 자동 시작 등록 해제 | - -**설치 예시:** -```bash -# 간단한 pip 설치 (conda 미사용) -python install.py - -# conda 환경 사용 (conda 사용자에게 권장) -python install.py --conda -``` - -**CraftBot 실행:** - -```powershell -# Browser 모드 (기본, Node.js 필요) -python run.py - -# CLI 모드 (경량) -python run.py --cli - -# conda 환경에서 실행 -conda run -n craftbot python run.py - -# conda가 PATH에 없는 경우 전체 경로 사용 -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -**Linux/macOS (Bash):** -```bash -# Browser 모드 (기본, Node.js 필요) -python run.py - -# CLI 모드 (경량) -python run.py --cli - -# conda 환경에서 실행 -conda run -n craftbot python run.py -``` - -### 🔧 백그라운드 서비스 (권장) - -터미널을 닫아도 CraftBot이 계속 실행되도록 백그라운드 서비스로 실행합니다. 데스크톱 바로가기가 자동으로 생성되므로 언제든지 브라우저를 다시 열 수 있습니다. - -```bash -# 의존성 설치, 로그인 시 자동 시작 등록, CraftBot 실행 -python craftbot.py install -``` - -이게 전부입니다. 터미널은 자동으로 닫히고, CraftBot은 백그라운드에서 실행되며, 브라우저가 자동으로 열립니다. - -```bash -# 기타 서비스 명령: -python craftbot.py start # CraftBot을 백그라운드에서 시작 -python craftbot.py status # 실행 여부 확인 -python craftbot.py stop # CraftBot 중지 -python craftbot.py restart # CraftBot 재시작 -python craftbot.py logs # 최근 로그 출력 확인 -``` - -| 명령 | 설명 | -|---------|-------------| -| `python craftbot.py install` | 의존성 설치, 로그인 시 자동 시작 등록, CraftBot 실행, 브라우저 열기 후 터미널 자동 종료 | -| `python craftbot.py start` | CraftBot을 백그라운드에서 시작 — 이미 실행 중이면 자동 재시작 (터미널 자동 종료) | -| `python craftbot.py stop` | CraftBot 중지 | -| `python craftbot.py restart` | CraftBot 중지 후 재시작 | -| `python craftbot.py status` | CraftBot 실행 여부와 자동 시작 활성화 여부 확인 | -| `python craftbot.py logs` | 최근 로그 출력 표시 (`-n 100`으로 더 많은 줄 표시) | -| `python craftbot.py uninstall` | CraftBot 중지, 자동 시작 등록 해제, pip 패키지 제거 및 pip 캐시 정리 | - -> [!TIP] -> `craftbot.py start` 또는 `craftbot.py install` 실행 후 **CraftBot 데스크톱 바로가기**가 자동으로 생성됩니다. 브라우저를 실수로 닫았다면 바로가기를 더블클릭해 다시 열 수 있습니다. - -> [!NOTE] -> **설치:** 의존성이 누락된 경우 설치 프로그램이 명확한 안내를 제공합니다. Node.js가 없으면 설치 여부를 묻거나 CLI 모드로 전환할 수 있습니다. GPU 가용성을 자동으로 감지하고 필요한 경우 CPU 전용 모드로 대체합니다. - -> [!TIP] -> **첫 실행 설정:** CraftBot은 API 키, 에이전트 이름, MCP, 스킬 설정을 위한 온보딩 과정을 안내합니다. +- **📋 칸반 보드**: 모든 작업, 후속 조치, CTA를 한 곳에. CraftBot이 직접 운영하며 PM 업무를 대신 처리할 수 있습니다. +- **📊 습관 트래커**: 습관을 만들고 추적하세요. GitHub 스타일의 활동 캘린더로 개발자처럼 습관을 관리할 수 있습니다. +- **🐦 Luolinglo**: 듀오링고는 아니지만, 새로운 언어를 배우고 플래시카드를 만들며 CraftBot과 함께 연습할 수 있습니다. -> [!NOTE] -> **Playwright Chromium:** WhatsApp Web 통합에 필요한 선택 사항입니다. 설치에 실패해도 다른 작업에서는 에이전트가 정상 작동합니다. 나중에 `playwright install chromium`으로 수동 설치할 수 있습니다. +**[Living UI 마켓플레이스 둘러보고 기여하기 →](https://craftos.net/marketplace)** --- @@ -389,7 +177,7 @@ Playwright Chromium 설치는 선택 사항입니다. 실패하더라도: --- ## 🐳 컨테이너로 실행 -저장소 루트에는 Python 3.10, 주요 시스템 패키지(OCR을 위한 Tesseract 포함), 그리고 `environment.yml`/`requirements.txt`에 정의된 모든 Python 의존성을 포함하는 Docker 구성이 들어 있어, 격리된 환경에서도 에이전트를 일관되게 실행할 수 있습니다. +저장소 루트에는 Python 3.10, 주요 시스템 패키지(OCR을 위한 Tesseract 포함), 그리고 `environment.yml`/`requirements.txt`에 정의된 모든 Python 의존성을 포함하는 Docker 구성이 들어 있어, 격리된 환경에서도 에이전트를 일관되게 실행할 수 있습니다. 다음은 컨테이너로 에이전트를 실행하는 방법입니다. @@ -423,7 +211,7 @@ docker run --rm -it --env-file .env craftbot ## 🤝 기여 방법 -PR 환영합니다! 워크플로(fork → `dev`에서 브랜치 → PR)는 [CONTRIBUTING.md](CONTRIBUTING.md)를 참고하세요. 모든 PR은 자동으로 lint + 스모크 테스트 CI를 통과해야 합니다. +PR 환영합니다! 워크플로(fork → `dev`에서 브랜치 → PR)는 [CONTRIBUTING.md](CONTRIBUTING.md)를 참고하세요. 모든 PR은 자동으로 lint + 스모크 테스트 CI를 통과해야 합니다. > [!IMPORTANT] > **CraftBot**은 매주 개선이 이루어지는, 활발히 개발 중인 프로젝트입니다. 질문이 있거나 더 빠른 대화를 원한다면 [Discord](https://discord.gg/ZN9YHc37HG)에 참여하시거나, thamyikfoong(at)craftos.net 로 이메일을 보내주세요. @@ -438,7 +226,7 @@ PR 환영합니다! 워크플로(fork → `dev`에서 브랜치 → PR)는 [CONT ## ⭐ 감사의 말 -[CraftOS](https://craftos.net/)와 기여자들이 함께 개발하고 유지보수합니다. +[CraftOS](https://craftos.net/)와 기여자들이 함께 개발하고 유지보수합니다. **CraftBot**이 도움이 되었다면 저장소에 ⭐를 눌러주시고 주변에 공유해 주세요! --- diff --git a/README.md b/README.md index 54654dc8..82d5fc4b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
Most agent harnesses stop at chat and tool calls. CraftBot goes further than that. It builds, evolves, and operates its own SaaS tools, then uses that tool layer to communicate and automate with you. @@ -32,21 +32,10 @@ Beyond that, CraftBot has all the core capabilities of a general-purpose agent h [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

日本語 | 简体中文 | 繁體中文 | 한국어 | Español | Português | Français | Deutsch

-
- CraftBot Banner -
- ## ✨ Highlighted Features Aside from being an AI agent that can create and operate its own SaaS tools, CraftBot includes all the core features of an agent harness, enabling it to work as a general AI agent alongside you across your tasks, tools, memory, and daily workflows. @@ -56,9 +45,9 @@ Aside from being an AI agent that can create and operate its own SaaS tools, Cra - **Living UI.** Build, import, or evolve custom apps that live inside CraftBot. The agent stays aware of the UI's state and can read, write, and act on its data directly. - **Multi-tasking and session routing.** Still using `/new` command? CraftBot knows when to start a new session and when to resume a task, keeping conversation and context unified. - **Self-hosted and BYOK.** Flexible LLM provider system supporting OpenAI, Google Gemini, Anthropic Claude, OpenRoute, and more. Or host your own model with 0 tokens spent using Ollama. -- **Memory System.** Local knowledge base built from your interaction with CraftBot via RAG + Agent File System + distillation. CraftBot dreams and consolidates events that happened throughout the day at midnight. +- **Memory System.** A second brain built from your interactions with CraftBot. Hybrid approach: RAG + knowledge graph + Agent File System. CraftBot dreams and consolidates events that happened throughout the day at midnight. - **Proactive Agent.** Learn your preferences, habits, and life goals. Then, perform planning and initiate tasks (with approval, of course) to help you improve in life. -- **External Tools Integration.** Connect to your apps like Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram and more (more to come!) with OAuth support or your own key. +- **External Tools Integration.** Connect to your apps like Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram and more (more to come!) with OAuth support or your own key. You can connect multiple accounts to each integration. - **Skills and MCP.** 150+ MCP and 170+ Skills ready. Quick installation of new Skills and MCPs. Create/improve Skills from completed tasks with one click. - **Browser interface and CLI support.** Use CraftBot the way it fits: through a simple browser UI for everyday interaction, or via the CLI for scripting and headless environments. @@ -158,22 +147,6 @@ Build, customize, and evolve your own Living UI, and rely less on subscription t --- -## 📋 Command Reference - -### craftbot.py — Automatic Setup (Recommended) - -| Command | Description | -|---------|-------------| -| `python craftbot.py install` | Install dependencies, register auto-start on login, start CraftBot, open browser, and close the terminal automatically | -| `python craftbot.py start` | Start CraftBot in the background — auto-restarts if already running (terminal closes automatically) | -| `python craftbot.py stop` | Stop CraftBot | -| `python craftbot.py restart` | Stop and start CraftBot | -| `python craftbot.py status` | Check if CraftBot is running and if auto-start is enabled | -| `python craftbot.py logs` | Show recent log output (`-n 100` for more lines) | -| `python craftbot.py uninstall` | Stop CraftBot, remove auto-start registration, uninstall pip packages, and purge pip cache | - ---- - ## 🔧 Troubleshooting & Common Issues ### Missing Node.js (for Browser Mode) diff --git a/README.pt-BR.md b/README.pt-BR.md index b4c65c3f..7e67de47 100644 --- a/README.pt-BR.md +++ b/README.pt-BR.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
A maioria dos frameworks de agentes para por aí: chat e chamadas de ferramenta. O CraftBot vai além: ele constrói, evolui e opera suas próprias ferramentas SaaS, e usa essa camada de ferramentas para se comunicar com você e automatizar tarefas. @@ -21,6 +21,10 @@ Além disso, o CraftBot tem todas as capacidades essenciais de um framework de a Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ Além disso, o CraftBot tem todas as capacidades essenciais de um framework de a [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 日本語 | 简体中文 | 繁體中文 | 한국어 | Español | Français | Deutsch

-
- CraftBot Banner -
- ## ✨ Principais recursos Além de ser um agente de IA capaz de criar e operar suas próprias ferramentas SaaS, o CraftBot conta com todas as capacidades essenciais de um framework de agente, podendo atuar como um agente de IA de uso geral que te acompanha em suas tarefas, ferramentas, memória e fluxos de trabalho do dia a dia. @@ -52,9 +45,9 @@ Além de ser um agente de IA capaz de criar e operar suas próprias ferramentas - **Living UI.** Construa, importe ou evolua aplicações personalizadas que vivem dentro do CraftBot. O agente conhece o estado atual da UI o tempo todo e pode ler, escrever e agir sobre seus dados diretamente. - **Multitarefa e roteamento de sessões.** Ainda digitando `/new` manualmente? O CraftBot decide quando abrir uma nova sessão e quando retomar uma tarefa, mantendo conversa e contexto unificados. - **Self-hosted e BYOK.** Sistema flexível de provedores de LLM com suporte a OpenAI, Google Gemini, Anthropic Claude, OpenRouter e mais. Ou hospede seu próprio modelo gastando 0 tokens com o Ollama. -- **Sistema de memória.** Uma base de conhecimento local construída a partir da sua interação com o CraftBot via RAG + sistema de arquivos do agente + destilação. À meia-noite, o CraftBot "sonha" e consolida os eventos do dia. +- **Sistema de memória.** Um segundo cérebro construído a partir das suas interações com o CraftBot. Abordagem híbrida: RAG + grafo de conhecimento + sistema de arquivos do agente. À meia-noite, o CraftBot "sonha" e consolida os eventos do dia. - **Agente proativo.** Aprende suas preferências, hábitos e objetivos de vida. Em seguida, planeja e inicia tarefas (com sua aprovação, claro) para te ajudar a evoluir. -- **Integração com ferramentas externas.** Conecte-se aos seus apps como Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram e mais (e muito mais por vir!), com suporte a OAuth ou usando sua própria chave. +- **Integração com ferramentas externas.** Conecte-se aos seus apps como Google Workspace, Slack, Notion, Zoom, LinkedIn, Discord, Telegram e mais (e muito mais por vir!), com suporte a OAuth ou usando sua própria chave. Você pode conectar várias contas a cada integração. - **Skills e MCP.** Mais de 150 MCPs e 170 Skills prontos para uso. Instalação rápida de novos Skills e MCPs. Crie ou melhore Skills a partir de tarefas concluídas com um clique. - **Interface de navegador e suporte a CLI.** Use o CraftBot do jeito que melhor te servir: pela UI simples no navegador para o dia a dia, ou via CLI para scripts e ambientes headless. @@ -63,31 +56,7 @@ Além de ser um agente de IA capaz de criar e operar suas próprias ferramentas ## 🧰 Começando -### Pré-requisitos -- Python **3.10+** -- `git` (necessário para clonar o repositório) -- Uma chave de API do provedor LLM escolhido (OpenAI, Gemini ou Anthropic) -- `Node.js` **18+** (opcional — necessário apenas para a interface no navegador) -- `conda` (opcional — se não for encontrado, o instalador pode instalar o Miniconda automaticamente) - -### Qual opção devo usar? - -> **Não sabe qual escolher? Use a Opção 1.** Ela cuida de tudo por você. - -| | Opção 1 — Serviço | Opção 2 — Conda | Opção 3 — Manual | -|---|---|---|---| -| **Para quem** | A maioria dos usuários, iniciantes, testes | Usuários de Conda que querem ambientes isolados | Usuários avançados, Python personalizado, controle total | -| **Gerencia Python/ambiente automaticamente?** | ✅ Automático | ✅ Automático | ❌ Você gerencia | -| **Roda em segundo plano?** | ✅ Sim, como serviço | ❌ Não | ❌ Não | -| **Como começar** | `python craftbot.py install` | `python install.py --conda` | `python install.py` | - ---- - -### ⭐ Opção 1 — Instalação como serviço (Recomendada) - -**Use esta se:** você quer que o CraftBot simplesmente funcione — serviço em segundo plano, início automático no login, atalho na área de trabalho, sem passos manuais. - -O `craftbot.py` cuida de tudo: ambiente Python, dependências, gerenciamento de processos em segundo plano e registro de início automático. +Pré-requisitos: Python 3.10+ · Node.js 18+ para o modo navegador ```bash # 1. Clone o repositório @@ -98,7 +67,7 @@ cd CraftBot python craftbot.py install ``` -Pronto. O terminal se fecha sozinho, o CraftBot roda em segundo plano e o navegador abre automaticamente. Um **atalho na área de trabalho** também é criado para que você possa reabrir o navegador quando quiser. +Pronto. O terminal se fecha sozinho, o CraftBot roda em segundo plano e o navegador abre automaticamente. Um **atalho na área de trabalho** é criado para que você possa reabrir o navegador quando quiser. **Gerenciando o serviço após a instalação:** @@ -118,100 +87,23 @@ python craftbot.py uninstall # Para o serviço, remove o autoinício e desinsta ## 🌱 Living UI -**Living UI é um sistema/app/dashboard que evolui junto com suas necessidades.** +**Living UI é um sistema/app/dashboard que evolui com suas necessidades.**
CraftBot Banner
-- Precisa de um quadro kanban com um copiloto de IA embutido? -- Um CRM sob medida, exatamente no formato do seu fluxo de trabalho? -- Um dashboard corporativo que o CraftBot consegue ler e operar por você? +- Precisa de um quadro kanban com um copiloto de IA embutido? +- Um CRM sob medida, exatamente no formato do seu fluxo de trabalho? +- Um dashboard corporativo que o CraftBot consegue ler e operar por você? -```bash -# 1. Clone o repositório -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. Instale em um ambiente conda -python install.py --conda - -# 3. Execute o CraftBot -conda run -n craftbot python run.py - -# Se o conda não estiver no PATH (somente Windows): -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> Sempre que quiser rodar o CraftBot, use `conda run -n craftbot python run.py`. Não há serviço em segundo plano — você inicia e para manualmente. - ---- - -### Opção 3 — Instalação manual (pip) - -**Use esta se:** você quer controle total sobre seu ambiente Python e prefere gerenciar o CraftBot por conta própria, sem serviço automático ou processo em segundo plano. - -O `install.py` (sem flags) faz uma instalação pip padrão no ambiente Python ativo. Você inicia e para o CraftBot manualmente com `run.py`. - -```bash -# 1. Clone o repositório -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. Instale as dependências no seu ambiente Python ativo -python install.py - -# 3. Execute o CraftBot -python run.py -``` - -Na primeira execução, você será guiado para configurar suas chaves de API e preferências. - -> [!NOTE] -> Se o Node.js não estiver instalado, o instalador fornecerá instruções passo a passo. Você também pode pular completamente o modo navegador e usar o modo CLI — sem Node.js: `python run.py --cli` - -### O que você pode fazer logo de cara? -- Conversar com o agente de forma natural -- Pedir que ele execute tarefas complexas de várias etapas -- Digitar `/help` para ver os comandos disponíveis -- Conectar-se ao Google, Slack, Notion e muito mais - -### 🖥️ Modos de interface - -
- CraftOS Banner -
- -O CraftBot oferece vários modos de UI. Escolha conforme sua preferência: - -| Modo | Comando | Requisitos | Indicado para | -|------|---------|--------------|----------| -| **Browser** | `python run.py` | Node.js 18+ | Interface web moderna, a mais fácil de usar | -| **CLI** | `python run.py --cli` | Nenhum | Linha de comando, leve | - -O **modo Browser** é o padrão e recomendado. Se não tiver o Node.js, o instalador fornecerá instruções de instalação, ou você pode usar o **modo CLI**. - ---- - -## 🧬 Living UI - -**Living UI é um sistema/app/dashboard que evolui com suas necessidades.** - -Precisa de um quadro kanban com um copiloto de IA embutido? Um CRM personalizado -moldado exatamente para o seu fluxo de trabalho? Um dashboard corporativo que o -CraftBot possa ler e operar por você? Coloque-o no ar como uma Living UI — ela -roda junto ao CraftBot e cresce conforme suas necessidades mudam. - -
- Living UI example -
+Coloque-o no ar como uma Living UI que roda junto ao CraftBot e cresce conforme suas necessidades mudam. ### Três jeitos de criar uma Living UI 1. **Construir do zero.** Descreva em linguagem natural o que você quer. O CraftBot - monta o modelo de dados, a API de back-end e a UI em React, e itera com você - por um processo de design estruturado. + monta o modelo de dados, a API de back-end e a UI em React, e itera com + você por um processo de design estruturado.
Building a Living UI from scratch @@ -243,149 +135,15 @@ app via API REST e disparar ações em seu nome. Construa, personalize e evolua sua própria Living UI, e dependa menos de ferramentas por assinatura que nunca foram feitas para encaixar perfeitamente nas suas necessidades. -Estamos ativamente procurando desenvolvedores que queiram mostrar suas Living UIs e exportá-las para o **[marketplace de Living UI](https://craftos.net/marketplace)**. PRs são bem-vindos! - --- # Três Living UIs para experimentar em 5 minutos -- **📋 Quadro Kanban** — Toda tarefa, follow-up e CTA em um único lugar. O CraftBot pode operá-lo e fazer o trabalho de PM por você. -- **📊 Habit Tracker** — Crie e acompanhe seus hábitos. Calendário de atividades no estilo do GitHub para acompanhar seus hábitos como um(a) dev. -- **🐦 Luolinglo** — Não é o Duolingo, mas você pode aprender novos idiomas, criar flashcards e praticar com o CraftBot. - -## 🧩 Visão geral da arquitetura - -| Componente | Descrição | -|-----------|-------------| -| **Agent Base** | Camada central de orquestração que gerencia o ciclo de vida das tarefas, coordena os componentes e cuida do loop principal do agente. | -| **LLM Interface** | Interface unificada com suporte a vários provedores de LLM (OpenAI, Gemini, Anthropic, BytePlus, Ollama). | -| **Context Engine** | Gera prompts otimizados com suporte a KV-cache. | -| **Action Manager** | Recupera e executa ações da biblioteca. Ações personalizadas são fáceis de estender. | -| **Action Router** | Seleciona de forma inteligente a ação que melhor corresponde aos requisitos da tarefa e resolve parâmetros de entrada via LLM quando necessário. | -| **Event Stream** | Sistema de publicação de eventos em tempo real para acompanhar o progresso das tarefas, atualizar a UI e monitorar a execução. | -| **Memory Manager** | Memória semântica baseada em RAG usando o ChromaDB. Lida com chunking, embeddings, recuperação e atualizações incrementais. | -| **State Manager** | Gerenciamento global de estado para rastrear contexto de execução do agente, histórico de conversas e configurações de runtime. | -| **Task Manager** | Gerencia definições de tarefas, habilita modos simples e complexos, cria to-dos e rastreia workflows multi-etapa. | -| **Skill Manager** | Carrega e injeta skills plugáveis no contexto do agente. | -| **MCP Adapter** | Integração com o Model Context Protocol que converte ferramentas MCP em ações nativas. | - ---- - -## 🔜 Roadmap - -- [X] **Módulo de memória** — Concluído. -- [ ] **Integração com ferramentas externas** — Ainda adicionando mais! -- [X] **Camada MCP** — Concluída. -- [X] **Camada de Skills** — Concluída. -- [ ] **Comportamento proativo** — Em andamento - ---- - -## 📋 Referência de comandos - -### install.py - -| Flag | Descrição | -|------|-------------| -| `--conda` | Usa ambiente conda (opcional) | - -### run.py - -| Flag | Descrição | -|------|-------------| -| (nenhum) | Executa no modo **Browser** (recomendado, requer Node.js) | -| `--cli` | Executa no modo **CLI** (leve) | - -### craftbot.py - -| Comando | Descrição | -|---------|-------------| -| `install` | Instala deps, registra auto-start e inicia o CraftBot | -| `start` | Inicia o CraftBot em segundo plano | -| `stop` | Para o CraftBot | -| `restart` | Para e inicia novamente | -| `status` | Mostra o status de execução e do auto-start | -| `logs [-n N]` | Mostra as últimas N linhas do log (padrão: 50) | -| `uninstall` | Remove o registro do auto-start | - -**Exemplos de instalação:** -```bash -# Instalação simples via pip (sem conda) -python install.py - -# Com ambiente conda (recomendado para usuários de conda) -python install.py --conda -``` - -**Executando o CraftBot:** - -```powershell -# Modo Browser (padrão, requer Node.js) -python run.py - -# Modo CLI (leve) -python run.py --cli - -# Com ambiente conda -conda run -n craftbot python run.py - -# Ou usando caminho completo se o conda não estiver no PATH -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -**Linux/macOS (Bash):** -```bash -# Modo Browser (padrão, requer Node.js) -python run.py - -# Modo CLI (leve) -python run.py --cli - -# Com ambiente conda -conda run -n craftbot python run.py -``` - -### 🔧 Serviço em segundo plano (recomendado) - -Execute o CraftBot como um serviço em segundo plano para que ele continue rodando mesmo após fechar o terminal. Um atalho na área de trabalho é criado automaticamente, permitindo reabrir o navegador a qualquer momento. - -```bash -# Instala dependências, registra auto-start no login e inicia o CraftBot -python craftbot.py install -``` - -É isso. O terminal se fecha sozinho, o CraftBot roda em segundo plano e o navegador abre automaticamente. - -```bash -# Outros comandos do serviço: -python craftbot.py start # Inicia o CraftBot em segundo plano -python craftbot.py status # Verifica se está em execução -python craftbot.py stop # Para o CraftBot -python craftbot.py restart # Reinicia o CraftBot -python craftbot.py logs # Mostra logs recentes -``` - -| Comando | Descrição | -|---------|-------------| -| `python craftbot.py install` | Instala dependências, registra auto-start no login, inicia o CraftBot, abre o navegador e fecha o terminal automaticamente | -| `python craftbot.py start` | Inicia o CraftBot em segundo plano — reinicia automaticamente se já estiver rodando (o terminal se fecha sozinho) | -| `python craftbot.py stop` | Para o CraftBot | -| `python craftbot.py restart` | Para e inicia o CraftBot | -| `python craftbot.py status` | Verifica se o CraftBot está rodando e se o auto-start está habilitado | -| `python craftbot.py logs` | Mostra a saída recente do log (`-n 100` para mais linhas) | -| `python craftbot.py uninstall` | Para o CraftBot, remove o registro de auto-start, desinstala pacotes pip e limpa o cache do pip | - -> [!TIP] -> Após `craftbot.py start` ou `craftbot.py install`, um **atalho do CraftBot na área de trabalho** é criado automaticamente. Se você fechar o navegador por acidente, basta clicar duas vezes no atalho para reabri-lo. - -> [!NOTE] -> **Instalação:** O instalador agora fornece orientações claras se faltarem dependências. Se o Node.js não for encontrado, você será orientado a instalá-lo ou poderá alternar para o modo CLI. A instalação detecta automaticamente a disponibilidade de GPU e recorre ao modo somente CPU quando necessário. - -> [!TIP] -> **Configuração inicial:** O CraftBot vai guiá-lo por um onboarding para configurar chaves de API, o nome do agente, MCPs e Skills. +- **📋 Quadro Kanban**: toda tarefa, follow-up e CTA em um único lugar. O CraftBot pode operá-lo e fazer o trabalho de PM por você. +- **📊 Habit Tracker**: crie e acompanhe seus hábitos. Calendário de atividades no estilo do GitHub para acompanhar seus hábitos como um(a) dev. +- **🐦 Luolinglo**: não é o Duolingo, mas você pode aprender novos idiomas, criar flashcards e praticar com o CraftBot. -> [!NOTE] -> **Playwright Chromium:** Opcional para a integração com o WhatsApp Web. Se a instalação falhar, o agente continuará funcionando normalmente para outras tarefas. Instale manualmente depois com: `playwright install chromium` +**[Explore e contribua com o marketplace de Living UI →](https://craftos.net/marketplace)** --- @@ -419,7 +177,7 @@ Para uma solução de problemas mais detalhada, veja [INSTALLATION_FIX.md](INSTA --- ## 🐳 Rodar com container -A raiz do repositório inclui uma configuração Docker com Python 3.10, pacotes de sistema essenciais (incluindo Tesseract para OCR) e todas as dependências Python definidas em `environment.yml`/`requirements.txt`, para que o agente rode de forma consistente em ambientes isolados. +A raiz do repositório inclui uma configuração Docker com Python 3.10, pacotes de sistema essenciais (incluindo Tesseract para OCR) e todas as dependências Python definidas em `environment.yml`/`requirements.txt`, para que o agente rode de forma consistente em ambientes isolados. Abaixo estão as instruções para rodar nosso agente em container. @@ -453,7 +211,7 @@ Por padrão, a imagem usa Python 3.10 e empacota as dependências Python de `env ## 🤝 Como contribuir -PRs são bem-vindos! Confira o fluxo (fork → branch a partir de `dev` → PR) em [CONTRIBUTING.md](CONTRIBUTING.md). Todos os pull requests passam automaticamente por CI de lint + smoke test. +PRs são bem-vindos! Confira o fluxo (fork → branch a partir de `dev` → PR) em [CONTRIBUTING.md](CONTRIBUTING.md). Todos os pull requests passam automaticamente por CI de lint + smoke test. > [!IMPORTANT] > O **CraftBot** está em desenvolvimento ativo, com melhorias toda semana. Se tiver dúvidas ou quiser uma conversa mais rápida, entre no nosso [Discord](https://discord.gg/ZN9YHc37HG) ou escreva para thamyikfoong(at)craftos.net. @@ -468,7 +226,7 @@ Este projeto está sob a [Licença MIT](LICENSE). Você é livre para usar, hosp ## ⭐ Agradecimentos -Desenvolvido e mantido por [CraftOS](https://craftos.net/) e contribuidores. +Desenvolvido e mantido por [CraftOS](https://craftos.net/) e contribuidores. Se o **CraftBot** te for útil, dê uma ⭐ no repositório e compartilhe com outras pessoas! --- diff --git a/README.zh-TW.md b/README.zh-TW.md index be5c7d3e..de64b78d 100644 --- a/README.zh-TW.md +++ b/README.zh-TW.md @@ -1,5 +1,5 @@
- CraftBot + CraftBot
大多數 Agent 框架止步於對話和工具呼叫,CraftBot 走得更遠。它會自己建立、演進並運行 SaaS 工具,然後透過這套工具層與你溝通,並替你完成自動化工作。 @@ -21,6 +21,10 @@ Discord + + + Ask DeepWiki +

@@ -28,21 +32,10 @@ [![SPONSORED BY E2B FOR STARTUPS](https://img.shields.io/badge/SPONSORED%20BY-E2B%20FOR%20STARTUPS-ff8800?style=for-the-badge)](https://e2b.dev/startups)
-

- - CraftBot - Self-hosted proactive AI assistant that lives locally | Product Hunt - - -

-

English | 日本語 | 简体中文 | 한국어 | Español | Português | Français | Deutsch

-
- CraftBot Banner -
- ## ✨ 核心特色 除了能夠建立並運行自有的 SaaS 工具,CraftBot 還具備 Agent 框架的全部核心能力,可以作為通用 AI Agent 陪你處理任務、工具、記憶與日常工作流程。 @@ -52,9 +45,9 @@ - **Living UI.** 在 CraftBot 內建立、匯入或演進自訂應用程式。Agent 隨時掌握 UI 的狀態,並能直接讀取、寫入並操作其中的資料。 - **多工與工作階段路由.** 還在手動輸入 `/new` 指令嗎?CraftBot 能自己判斷何時該開啟新會話、何時要繼續舊任務,讓對話與上下文保持一致。 - **自架與 BYOK.** 彈性的 LLM 供應商系統,支援 OpenAI、Google Gemini、Anthropic Claude、OpenRouter 等。也可以用 Ollama 自架模型,完全不耗 Token。 -- **記憶系統.** 透過 RAG + Agent 檔案系統 + 蒸餾,從你與 CraftBot 的互動中建立本地知識庫。CraftBot 會在午夜「做夢」,整合一整天發生的事件。 +- **記憶系統.** 從你與 CraftBot 的互動中建立的第二大腦。混合方案:RAG + 知識圖譜 + Agent 檔案系統。CraftBot 會在午夜「做夢」,整合一整天發生的事件。 - **主動型 Agent.** 學習你的偏好、習慣與人生目標,然後主動規劃並發起任務(當然會徵求你的同意),協助你在生活中變得更好。 -- **外部工具整合.** 連接你的應用,例如 Google Workspace、Slack、Notion、Zoom、LinkedIn、Discord、Telegram 等(更多正在路上),支援 OAuth 或使用你自己的金鑰。 +- **外部工具整合.** 連接你的應用,例如 Google Workspace、Slack、Notion、Zoom、LinkedIn、Discord、Telegram 等(更多正在路上),支援 OAuth 或使用你自己的金鑰。每個整合都可以連接多個帳號。 - **Skills 與 MCP.** 已備好 150+ MCP 與 170+ Skills,支援快速安裝新的 Skills 與 MCP,也能從已完成的任務一鍵建立或改進 Skills。 - **瀏覽器介面與 CLI 支援.** 選擇最適合你的方式使用 CraftBot:日常使用走簡潔的瀏覽器 UI,腳本與無介面環境則走 CLI。 @@ -104,87 +97,13 @@ python craftbot.py uninstall # 停止執行、移除自動啟動並解除安裝 - 一套完全貼合你工作流程的客製化 CRM? - 一個 CraftBot 可以代替你讀取並操作的公司儀表板? -```bash -# 1. 複製儲存庫 -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. 安裝到 conda 環境 -python install.py --conda - -# 3. 執行 CraftBot -conda run -n craftbot python run.py - -# 若 conda 不在 PATH（僅 Windows）： -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -> [!NOTE] -> 每次要執行 CraftBot 時，請使用 `conda run -n craftbot python run.py`。此方式沒有背景服務——由你手動啟停。 - ---- - -### 方案三 — 手動安裝（pip） - -**適合你，如果：** 你想完全掌控 Python 環境，不需要任何自動服務或背景程序，自己管理 CraftBot。 - -`install.py`（不帶旗標）會對目前啟用的 Python 環境執行標準 pip 安裝。透過 `run.py` 手動啟停 CraftBot。 - -```bash -# 1. 複製儲存庫 -git clone https://github.com/CraftOS-dev/CraftBot.git -cd CraftBot - -# 2. 在目前 Python 環境中安裝相依套件 -python install.py - -# 3. 執行 CraftBot -python run.py -``` - -首次執行時會引導你完成 API 金鑰設定與偏好設定。 - -> [!NOTE] -> 若尚未安裝 Node.js，安裝程式會提供逐步指引。你也可以完全略過瀏覽器模式，直接使用 CLI 模式——無需 Node.js：`python run.py --cli` - -### 立即能做什麼？ -- 用自然語言與代理人對話 -- 請它執行複雜的多步驟任務 -- 輸入 `/help` 查看可用指令 -- 連接 Google、Slack、Notion 等服務 - -### 🖥️ 介面模式 - -
- CraftOS Banner -
- -CraftBot 支援多種 UI 模式，可依個人偏好選擇： - -| 模式 | 指令 | 需求 | 適用情境 | -|------|---------|--------------|----------| -| **Browser** | `python run.py` | Node.js 18+ | 現代化網頁介面，最易使用 | -| **CLI** | `python run.py --cli` | 無 | 命令列，輕量化 | - -**Browser 模式**為預設與建議選項。若沒有 Node.js，安裝程式會提供安裝指引，或你可改用 **CLI 模式**。 - ---- - -## 🧬 Living UI - -**Living UI 是隨你需求演進的系統／應用／儀表板。** - -需要一個內建 AI 副駕駛的看板？量身打造符合你工作流程的 CRM？ -一個 CraftBot 能讀取並驅動的公司儀表板？ -將它作為 Living UI 啟動——它與 CraftBot 並行運作，並隨著你的需求變化而成長。 - -
- Living UI example -
+將它作為 Living UI 啟動:它會與 CraftBot 並行運作,並隨著你的需求變化而成長。 ### 建立 Living UI 的三種方式 -1. **從零開始建立.** 用自然語言描述你想要的東西,CraftBot 會幫你搭好資料模型、後端 API 與 React 前端,並透過一套結構化的設計流程與你不斷迭代。 +1. **從零開始建立.** 用自然語言描述你想要的東西,CraftBot + 會幫你搭好資料模型、後端 API 與 React 前端, + 並透過一套結構化的設計流程與你不斷迭代。
Building a Living UI from scratch @@ -196,165 +115,35 @@ CraftBot 支援多種 UI 模式，可依個人偏好選擇： Living UI marketplace
-3. **匯入既有專案.** 把 Go、Node.js、Python、Rust,或是靜態原始碼或 GitHub 儲存庫交給 CraftBot,它會自動偵測執行環境、設定健康檢查,並包裝成一個 Living UI。 +3. **匯入既有專案.** 把 Go、Node.js、Python、Rust, + 或是靜態原始碼或 GitHub 儲存庫交給 CraftBot,它會自動偵測執行環境、設定健康檢查,並包裝成一個 Living UI。
Importing an existing project as a Living UI
-### 讓 Agent 始終參與其中,持續演進 +### 讓 CraftBot 始終參與其中,持續演進 -Living UI 永遠沒有「完成」這回事。需求一變,就讓 Agent 為它加上新功能、重新設計頁面或接上新的資料源。 +Living UI 永遠沒有「完成」這回事。需求一變, +就讓 Agent 為它加上新功能、重新設計頁面或接上新的資料源。 -CraftBot 嵌入在每一個 Living UI 中,並且**對其狀態保持感知**:它可以讀取目前的 DOM 與表單值、透過 REST API 查詢應用資料,並代你觸發操作。 +CraftBot 嵌入在每一個 Living UI 中,並且**對其狀態保持感知**: +它可以讀取目前的 DOM 與表單值、透過 REST API 查詢應用資料, +並代你觸發操作。 ### 讓 SaaS 工具保持開放且不停演進 打造、自訂並不斷演進屬於你自己的 Living UI,降低對那些根本沒為你量身打造的訂閱工具的依賴。 -我們正在積極尋找願意展示自家 Living UI 的開發者,並支援將它們匯出到 **[Living UI 市集](https://craftos.net/marketplace)**。歡迎送 PR! - --- # 三個 5 分鐘內就能試玩的 Living UI -- **📋 Kanban 看板** — 把任務、後續追蹤與待辦集中到一個地方,CraftBot 可以接手日常運營,替你完成 PM 工作。 -- **📊 習慣追蹤器** — 培養並追蹤自己的習慣,用類 GitHub 風格的活動日曆像寫程式一樣維護你的習慣。 -- **🐦 Luolinglo** — 不是 Duolingo,但你可以學新語言、做單字卡片,並和 CraftBot 一起練習。 - -## 🧩 架構概覽 - -| 元件 | 說明 | -|-----------|-------------| -| **Agent Base** | 負責管理任務生命週期、協調各元件並處理主要代理人迴圈的核心編排層。 | -| **LLM Interface** | 支援多家 LLM 供應商（OpenAI、Gemini、Anthropic、BytePlus、Ollama）的統一介面。 | -| **Context Engine** | 產生最佳化的 Prompt，支援 KV-Cache。 | -| **Action Manager** | 從動作庫中擷取並執行動作，方便擴充自訂動作。 | -| **Action Router** | 依任務需求智慧挑選最合適的動作，並在需要時透過 LLM 解析輸入參數。 | -| **Event Stream** | 即時事件發佈系統，用於任務進度追蹤、UI 更新與執行監控。 | -| **Memory Manager** | 以 ChromaDB 為基礎的 RAG 語意記憶，處理記憶分塊、嵌入、檢索與增量更新。 | -| **State Manager** | 全域狀態管理，追蹤代理人執行脈絡、對話歷史與執行期設定。 | -| **Task Manager** | 管理任務定義，支援簡單與複雜任務模式、待辦清單建立，以及多步驟流程追蹤。 | -| **Skill Manager** | 載入並將可插拔技能注入到代理人情境中。 | -| **MCP Adapter** | Model Context Protocol 整合，將 MCP 工具轉換為原生動作。 | - ---- - -## 🔜 藍圖 - -- [X] **記憶模組** — 完成。 -- [ ] **外部工具整合** — 仍在持續新增！ -- [X] **MCP 層** — 完成。 -- [X] **技能層** — 完成。 -- [ ] **主動式行為** — 進行中 - ---- - -## 📋 指令參考 - -### install.py - -| 旗標 | 說明 | -|------|-------------| -| `--conda` | 使用 conda 環境（選用） | - -### run.py - -| 旗標 | 說明 | -|------|-------------| -| （無） | 以 **Browser** 模式執行（建議，需 Node.js） | -| `--cli` | 以 **CLI** 模式執行（輕量） | - -### craftbot.py - -| 指令 | 說明 | -|---------|-------------| -| `install` | 安裝相依套件、註冊開機自動啟動，並啟動 CraftBot | -| `start` | 在背景啟動 CraftBot | -| `stop` | 停止 CraftBot | -| `restart` | 停止後重新啟動 | -| `status` | 顯示執行狀態與自動啟動狀態 | -| `logs [-n N]` | 顯示最後 N 行記錄（預設 50） | -| `uninstall` | 移除自動啟動註冊 | - -**安裝範例：** -```bash -# 單純使用 pip 安裝（不使用 conda） -python install.py - -# 使用 conda 環境（建議給 conda 使用者） -python install.py --conda -``` - -**執行 CraftBot：** - -```powershell -# Browser 模式（預設，需 Node.js） -python run.py - -# CLI 模式（輕量） -python run.py --cli - -# 使用 conda 環境 -conda run -n craftbot python run.py - -# 若 conda 不在 PATH，使用完整路徑 -&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py -``` - -**Linux/macOS（Bash）：** -```bash -# Browser 模式（預設，需 Node.js） -python run.py - -# CLI 模式（輕量） -python run.py --cli - -# 使用 conda 環境 -conda run -n craftbot python run.py -``` - -### 🔧 背景服務（建議） - -將 CraftBot 當成背景服務執行，即使關閉終端機仍能持續運作。系統會自動建立桌面捷徑，讓你隨時可重新開啟瀏覽器。 - -```bash -# 安裝相依套件、註冊登入時自動啟動並啟動 CraftBot -python craftbot.py install -``` - -這樣就完成了。終端機會自動關閉，CraftBot 在背景執行，瀏覽器也會自動開啟。 - -```bash -# 其他服務指令： -python craftbot.py start # 在背景啟動 CraftBot -python craftbot.py status # 檢查是否正在執行 -python craftbot.py stop # 停止 CraftBot -python craftbot.py restart # 重新啟動 CraftBot -python craftbot.py logs # 檢視最近的記錄 -``` - -| 指令 | 說明 | -|---------|-------------| -| `python craftbot.py install` | 安裝相依套件、註冊登入時自動啟動、啟動 CraftBot、開啟瀏覽器並自動關閉終端機 | -| `python craftbot.py start` | 在背景啟動 CraftBot——若已在執行，會自動重啟（終端機自動關閉） | -| `python craftbot.py stop` | 停止 CraftBot | -| `python craftbot.py restart` | 停止並重新啟動 CraftBot | -| `python craftbot.py status` | 檢查 CraftBot 是否執行中，以及自動啟動是否啟用 | -| `python craftbot.py logs` | 顯示最近的記錄（使用 `-n 100` 顯示更多行） | -| `python craftbot.py uninstall` | 停止 CraftBot、移除自動啟動註冊、解除 pip 套件並清除 pip 快取 | - -> [!TIP] -> 執行 `craftbot.py start` 或 `craftbot.py install` 後，會自動建立 **CraftBot 桌面捷徑**。若不小心關閉了瀏覽器，雙擊捷徑即可重新開啟。 - -> [!NOTE] -> **安裝：** 若相依套件缺失，安裝程式會提供清楚的指引。若找不到 Node.js，會提示你安裝或切換至 CLI 模式。安裝程式會自動偵測 GPU 是否可用，必要時會自動回退至 CPU 模式。 - -> [!TIP] -> **首次設定：** CraftBot 會引導你完成初始化流程，包含設定 API 金鑰、代理人名稱、MCP 與技能。 +- **📋 Kanban 看板**:把任務、後續追蹤與待辦集中到一個地方,CraftBot 可以接手操作,替你完成 PM 工作。 +- **📊 習慣追蹤器**:培養並追蹤自己的習慣,用類 GitHub 風格的活動日曆像寫程式一樣維護你的習慣。 +- **🐦 Luolinglo**:不是 Duolingo,但你可以學新語言、做單字卡片,並和 CraftBot 一起練習。 -> [!NOTE] -> **Playwright Chromium：** 整合 WhatsApp Web 時選用。若安裝失敗，代理人仍可正常執行其他任務。稍後可以手動安裝：`playwright install chromium`。 +**[瀏覽 Living UI 市集並貢獻你的作品 →](https://craftos.net/marketplace)** --- @@ -362,11 +151,11 @@ python craftbot.py logs # 檢視最近的記錄 ### 缺少 Node.js (瀏覽器模式) 如果執行 `python run.py` 時看到 **「npm not found in PATH」**: -1. 從 [nodejs.org](https://nodejs.org/) 下載 LTS 版本 +1. 從 [nodejs.org](https://nodejs.org/) 下載(選擇 LTS 版本) 2. 安裝完成後重啟終端機 3. 再次執行 `python run.py` -**替代方案：** 改用 CLI 模式（不需 Node.js）： +**替代方案:** 改用 CLI 模式(不需 Node.js): ```bash python run.py --cli ``` @@ -377,7 +166,7 @@ python run.py --cli - **檢查網路連線:** 安裝過程需要下載相依套件 - **清除 pip 快取:** 執行 `pip install --upgrade pip` 之後再試一次 -### Playwright 安裝失敗 +### Playwright 安裝問題 Playwright Chromium 的安裝為選用項目。即使失敗: - Agent 在其他任務上**仍可正常運作** - 可以先略過,稍後再用 `playwright install chromium` 安裝 @@ -408,7 +197,7 @@ docker build -t craftbot . docker run --rm -it craftbot ``` -需要傳入環境變數時,可以掛載一個 env 檔案(例如以 `.env.example` 為基礎): +需要傳入環境變數時,可以指定一個 env 檔案(例如以 `.env.example` 為基礎): ```bash docker run --rm -it --env-file .env craftbot @@ -437,7 +226,7 @@ docker run --rm -it --env-file .env craftbot ## ⭐ 致謝 -由 [CraftOS](https://craftos.net/) 與貢獻者共同開發與維護。 +由 [CraftOS](https://craftos.net/) 與貢獻者共同開發與維護。 如果你覺得 **CraftBot** 有用,歡迎給儲存庫一顆 ⭐ 並分享給更多人! --- diff --git a/assets/README_banner.png b/assets/README_banner.png deleted file mode 100644 index 5b741533..00000000 Binary files a/assets/README_banner.png and /dev/null differ diff --git a/assets/README_cover.png b/assets/README_cover.png new file mode 100644 index 00000000..a84d0d61 Binary files /dev/null and b/assets/README_cover.png differ diff --git a/assets/ascii-art-small.html b/assets/ascii-art-small.html deleted file mode 100644 index f55b461b..00000000 --- a/assets/ascii-art-small.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - -████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
████████████████████
- - \ No newline at end of file diff --git a/assets/craftbot_features_custom.png b/assets/craftbot_features_custom.png deleted file mode 100644 index b014c9f9..00000000 Binary files a/assets/craftbot_features_custom.png and /dev/null differ diff --git a/assets/craftbot_logo_text_small.png b/assets/craftbot_logo_text_small.png deleted file mode 100644 index 2722be19..00000000 Binary files a/assets/craftbot_logo_text_small.png and /dev/null differ diff --git a/assets/craftbot_overview.png b/assets/craftbot_overview.png deleted file mode 100644 index 9be667ac..00000000 Binary files a/assets/craftbot_overview.png and /dev/null differ diff --git a/assets/craftbot_readme_banner.png b/assets/craftbot_readme_banner.png deleted file mode 100644 index 9de68a09..00000000 Binary files a/assets/craftbot_readme_banner.png and /dev/null differ diff --git a/assets/craftbot_readme_features.png b/assets/craftbot_readme_features.png deleted file mode 100644 index 5cf11eeb..00000000 Binary files a/assets/craftbot_readme_features.png and /dev/null differ diff --git a/assets/logo-text-white.png b/assets/logo-text-white.png deleted file mode 100644 index cd9431aa..00000000 Binary files a/assets/logo-text-white.png and /dev/null differ