Skip to content

Commit 0dbd64f

Browse files
authored
Update README.md
Fix README.md
1 parent 72efe11 commit 0dbd64f

1 file changed

Lines changed: 4 additions & 153 deletions

File tree

README.md

Lines changed: 4 additions & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -100,85 +100,11 @@ python craftbot.py uninstall # Stop, remove auto-start, and uninstall packages
100100
<img src="assets/living_ui_banner.gif" alt="CraftBot Banner" width="1280"/>
101101
</div>
102102

103-
- Need a kanban board with an AI co-pilot built in?
104-
- A custom CRM shaped exactly like your workflow?
105-
- A company dashboard that CraftBot can read and drive on your behalf?
103+
- Need a kanban board with an AI co-pilot built in?
104+
- A custom CRM shaped exactly like your workflow?
105+
- A company dashboard that CraftBot can read and drive on your behalf?
106106

107-
```bash
108-
# 1. Clone the repository
109-
git clone https://github.com/CraftOS-dev/CraftBot.git
110-
cd CraftBot
111-
112-
# 2. Install into a conda environment
113-
python install.py --conda
114-
115-
# 3. Run CraftBot
116-
conda run -n craftbot python run.py
117-
118-
# If conda is not in PATH (Windows only):
119-
&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py
120-
```
121-
122-
> [!NOTE]
123-
> Each time you want to run CraftBot, use `conda run -n craftbot python run.py`. There is no background service — you start and stop it yourself.
124-
125-
---
126-
127-
### Option 3 — Manual Install (pip)
128-
129-
**Use this if:** you want full control over your Python environment and prefer managing CraftBot yourself with no automatic service or background process.
130-
131-
`install.py` (no flags) does a standard pip install into whichever Python environment is currently active. You start and stop CraftBot manually using `run.py`.
132-
133-
```bash
134-
# 1. Clone the repository
135-
git clone https://github.com/CraftOS-dev/CraftBot.git
136-
cd CraftBot
137-
138-
# 2. Install dependencies into your active Python environment
139-
python install.py
140-
141-
# 3. Run CraftBot
142-
python run.py
143-
```
144-
145-
The first run will guide you through setting up your API keys and preferences.
146-
147-
> [!NOTE]
148-
> If Node.js is not installed, the installer will provide step-by-step instructions. You can also skip browser mode entirely and use CLI mode — no Node.js required: `python run.py --cli`
149-
150-
---
151-
152-
### What you can do right after?
153-
- Talk to the agent naturally
154-
- Ask it to perform complex multi-step tasks
155-
- Type `/help` to see available commands
156-
- Connect to Google, Slack, Notion, and more
157-
158-
### 🖥️ Interface Modes
159-
160-
CraftBot supports multiple UI modes. Choose based on your preference:
161-
162-
| Mode | Command | Requirements | Best For |
163-
|------|---------|--------------|----------|
164-
| **Browser** | `python run.py` | Node.js 18+ | Modern web interface, easiest to use |
165-
| **CLI** | `python run.py --cli` | None | Command-line, lightweight |
166-
167-
**Browser mode** is the default and recommended. If you don't have Node.js, the installer will provide installation instructions or you can use **CLI mode** instead.
168-
169-
---
170-
171-
## 🧬 Living UI
172-
173-
**Living UI is a system/app/dashboard that evolve with your needs.**
174-
175-
Need a kanban board with an AI co-pilot built in? A custom CRM shaped exactly
176-
like your workflow? A company dashboard that CraftBot can read and drive on
177-
your behalf? Spin it up as a Living UI that runs alongside CraftBot and grows as your needs change.
178-
179-
<div align="center">
180-
<img src="assets/living-ui-example.png" alt="Living UI example" width="1280"/>
181-
</div>
107+
Spin it up as a Living UI that runs alongside CraftBot and grows as your needs change.
182108

183109
### Three ways to create a Living UI
184110

@@ -216,20 +142,6 @@ REST API, and trigger actions on your behalf.
216142

217143
Build, customize, and evolve your own Living UI, and rely less on subscription tools that were never built to fit your needs perfectly.
218144

219-
| Component | Description |
220-
|-----------|-------------|
221-
| **Agent Base** | Core orchestration layer that manages task lifecycle, coordinates between components, and handles the main agentic loop. |
222-
| **LLM Interface** | Unified interface supporting multiple LLM providers (OpenAI, Gemini, Anthropic, BytePlus, Ollama). |
223-
| **Context Engine** | Generates optimized prompts with KV-cache support. |
224-
| **Action Manager** | Retrieves and executes actions from the library. Custom action is easy to extend |
225-
| **Action Router** | Intelligently selects the best matching action based on task requirements and resolves input parameters via LLM when needed. |
226-
| **Event Stream** | Real-time event publishing system for task progress tracking, UI updates, and execution monitoring. |
227-
| **Memory Manager** | RAG-based semantic memory using ChromaDB. Handles memory chunking, embedding, retrieval, and incremental updates. |
228-
| **State Manager** | Global state management for tracking agent execution context, conversation history, and runtime configuration. |
229-
| **Task Manager** | Manages task definitions, enable simple and complex tasks bode, create todos, and multi-step workflow tracking. |
230-
| **Skill Manager** | Loads and injects pluggable skills into the agent context. |
231-
| **MCP Adapter** | Model Context Protocol integration that converts MCP tools into native actions. |
232-
233145
---
234146

235147
# Three Living UIs to try in 5 minutes
@@ -258,67 +170,6 @@ Build, customize, and evolve your own Living UI, and rely less on subscription t
258170

259171
---
260172

261-
### install.py — Manual Setup
262-
263-
| Flag | Description |
264-
|------|-------------|
265-
| (none) | Standard pip install — uses your active Python environment |
266-
| `--conda` | Install into a conda environment (auto-installs Miniconda if not found) |
267-
268-
```bash
269-
# Standard pip install
270-
python install.py
271-
272-
# With conda environment
273-
python install.py --conda
274-
```
275-
276-
---
277-
278-
### run.py — Running CraftBot (Manual Setup Only)
279-
280-
> If you used `craftbot.py install`, CraftBot starts automatically. Use `run.py` only when running manually.
281-
282-
| Flag | Description |
283-
|------|-------------|
284-
| (none) | Run in **Browser** mode (recommended, requires Node.js) |
285-
| `--cli` | Run in **CLI** mode (lightweight, no Node.js required) |
286-
287-
**Windows (PowerShell):**
288-
```powershell
289-
# Browser mode (default, requires Node.js)
290-
python run.py
291-
292-
# CLI mode (no Node.js required)
293-
python run.py --cli
294-
295-
# With conda environment
296-
conda run -n craftbot python run.py
297-
298-
# Or using full path if conda not in PATH
299-
&"$env:USERPROFILE\miniconda3\Scripts\conda.exe" run -n craftbot python run.py
300-
```
301-
302-
**Linux/macOS (Bash):**
303-
```bash
304-
python run.py # Browser mode
305-
python run.py --cli # CLI mode
306-
307-
# With conda environment
308-
conda run -n craftbot python run.py
309-
```
310-
311-
> [!NOTE]
312-
> **Installation:** The installer now provides clear guidance if dependencies are missing. If Node.js is not found, you'll be prompted to install it or can switch to CLI mode. Installation automatically detects GPU availability and falls back to CPU-only mode if needed.
313-
314-
> [!TIP]
315-
> **First-time setup:** CraftBot will guide you through an onboarding sequence to configure API keys, the agent's name, MCPs, and Skills.
316-
317-
> [!NOTE]
318-
> **Playwright Chromium:** Optional for WhatsApp Web integration. If installation fails, the agent will still work fine for other tasks. Install manually later with: `playwright install chromium`
319-
320-
---
321-
322173
## 🔧 Troubleshooting & Common Issues
323174

324175
### Missing Node.js (for Browser Mode)

0 commit comments

Comments
 (0)