Documentation cleanup and consolidation
Removed redundant/outdated files: - docs/HEARTBEAT_HOOKS.md (legacy, disabled by default) - docs/QUICK_START_PULSE.md (merged into PULSE_BRAIN.md) - docs/MONITORING_COMPARISON.md (merged into PULSE_BRAIN.md) Consolidated monitoring docs: - Merged 3 monitoring files into comprehensive PULSE_BRAIN.md - Added Quick Start section to PULSE_BRAIN.md - Added "Why Pulse & Brain?" comparison section - Added deprecation notices for Heartbeat system Updated README.md: - Clarified Haiku is default model (12x cheaper) - Added prompt caching info (90% savings on Sonnet) - Removed duplicate setup instructions - Linked to SETUP.md for detailed instructions - Added model switching commands section Simplified WINDOWS_QUICK_REFERENCE.md: - Reduced from 224 lines to ~160 lines - Removed redundant development/deployment sections - Kept essential quick commands - Added model switching commands Updated docs/README.md navigation: - Removed references to deleted files - Added deprecation notice for Heartbeat - Updated learning paths - Cleaned up file organization section Result: - Removed 300+ lines of redundant documentation - Consolidated 3 monitoring files into 1 - Improved accuracy and clarity - Easier navigation and maintenance Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
82
README.md
82
README.md
@@ -15,80 +15,46 @@ A lightweight, cost-effective AI agent framework for building proactive bots wit
|
||||
|
||||
## Features
|
||||
|
||||
- **Multi-LLM Support**: Claude (Anthropic) and GLM (z.ai) with easy model switching
|
||||
- **Smart Memory System**: SQLite-based memory with automatic context retrieval
|
||||
- **Cost-Optimized AI**: Default Haiku 4.5 model (12x cheaper), auto-caching on Sonnet (90% savings), dynamic model switching
|
||||
- **Smart Memory System**: SQLite-based memory with automatic context retrieval and FTS search
|
||||
- **Multi-Platform Adapters**: Run on Slack, Telegram, and more simultaneously
|
||||
- **Pulse & Brain Monitoring**: 92% cost savings with intelligent conditional monitoring
|
||||
- **Pulse & Brain Monitoring**: 92% cost savings with intelligent conditional monitoring (recommended)
|
||||
- **Task Scheduling**: Cron-like scheduled tasks with flexible cadences
|
||||
- **Skills Integration**: Local Claude Code skills invokable from messaging platforms
|
||||
- **Heartbeat System**: Configurable health checks and proactive monitoring
|
||||
- **Tool Use System**: File operations, command execution, and autonomous task completion
|
||||
- **Multi-LLM Support**: Claude (Anthropic) primary, GLM (z.ai) optional
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Windows 11 Users (Recommended)
|
||||
**For detailed setup instructions**, see **[SETUP.md](SETUP.md)** - includes API key setup, configuration, and troubleshooting.
|
||||
|
||||
**One-click setup:**
|
||||
```powershell
|
||||
quick_start.bat
|
||||
```
|
||||
|
||||
This will:
|
||||
- Create virtual environment
|
||||
- Install dependencies
|
||||
- Check for API key
|
||||
- Guide you through setup
|
||||
|
||||
**Verify installation:**
|
||||
```powershell
|
||||
python test_installation.py
|
||||
```
|
||||
|
||||
For detailed Windows deployment (service setup, monitoring, troubleshooting), see [Windows Deployment Guide](docs/WINDOWS_DEPLOYMENT.md).
|
||||
|
||||
### Linux/macOS
|
||||
|
||||
**1. Installation**
|
||||
### 30-Second Quickstart
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourusername/ajarbot.git
|
||||
# Clone and install
|
||||
git clone https://vulcan.apophisnetworking.net/jramos/ajarbot.git
|
||||
cd ajarbot
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
**2. Set Environment Variables**
|
||||
# Configure (copy examples and add your API key)
|
||||
cp .env.example .env
|
||||
cp config/scheduled_tasks.example.yaml config/scheduled_tasks.yaml
|
||||
|
||||
```bash
|
||||
export ANTHROPIC_API_KEY="sk-ant-..." # Your Claude API key
|
||||
export GLM_API_KEY="..." # Optional: z.ai GLM key
|
||||
```
|
||||
# Add your Anthropic API key to .env
|
||||
# ANTHROPIC_API_KEY=sk-ant-...
|
||||
|
||||
**3. Run Your First Bot**
|
||||
|
||||
```python
|
||||
from agent import Agent
|
||||
|
||||
# Initialize with Claude
|
||||
agent = Agent(provider="claude")
|
||||
|
||||
# Chat with automatic memory and context loading
|
||||
response = agent.chat("What should I work on?", username="alice")
|
||||
print(response)
|
||||
```
|
||||
|
||||
**4. Try the Examples**
|
||||
|
||||
```bash
|
||||
# Basic agent with memory
|
||||
# Run
|
||||
python example_usage.py
|
||||
|
||||
# Agent with Pulse & Brain monitoring
|
||||
python example_bot_with_pulse_brain.py
|
||||
|
||||
# Multi-platform bot (Slack + Telegram)
|
||||
python bot_runner.py --init # Generate config
|
||||
python bot_runner.py # Start bot
|
||||
```
|
||||
|
||||
**Windows users**: Run `quick_start.bat` for automated setup
|
||||
|
||||
### Model Switching Commands
|
||||
|
||||
Send these to your bot:
|
||||
- `/haiku` - Fast, cheap (default)
|
||||
- `/sonnet` - Smart, caching enabled (auto 90% cost savings)
|
||||
- `/status` - Check current model and settings
|
||||
|
||||
## Core Concepts
|
||||
|
||||
### Agent
|
||||
|
||||
Reference in New Issue
Block a user