Files
ajarbot/WINDOWS_QUICK_REFERENCE.md
Jordan Ramos ab3a5afd59 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>
2026-02-13 21:06:15 -07:00

173 lines
3.5 KiB
Markdown

# Windows 11 Quick Reference
Quick command reference for testing and running Ajarbot on Windows 11.
## First Time Setup (5 Minutes)
```powershell
# Step 1: Navigate to project
cd c:\Users\fam1n\projects\ajarbot
# Step 2: Run automated setup
quick_start.bat
# Step 3: Set API key (if prompted)
# Get your key from: https://console.anthropic.com/
# Step 4: Verify installation
python test_installation.py
```
## Test Examples (Choose One)
### Option 1: Basic Agent Test
```powershell
python example_usage.py
```
**What it does:** Tests basic chat and memory
### Option 2: Pulse & Brain Monitoring
```powershell
python example_bot_with_pulse_brain.py
```
**What it does:** Runs cost-effective monitoring
**To stop:** Press `Ctrl+C`
### Option 3: Task Scheduler
```powershell
python example_bot_with_scheduler.py
```
**What it does:** Shows scheduled task execution
**To stop:** Press `Ctrl+C`
### Option 4: Multi-Platform Bot
```powershell
# Generate config file
python bot_runner.py --init
# Edit config (add Slack/Telegram tokens)
notepad config\adapters.local.yaml
# Run bot
python bot_runner.py
```
**To stop:** Press `Ctrl+C`
## Daily Commands
### Activate Virtual Environment
```powershell
cd c:\Users\fam1n\projects\ajarbot
.\venv\Scripts\activate
```
### Start Bot
```powershell
python bot_runner.py
```
### Check Health
```powershell
python bot_runner.py --health
```
### View Logs
```powershell
type logs\bot.log
```
### Update Dependencies
```powershell
pip install -r requirements.txt --upgrade
```
## API Key Management
### Set for Current Session
```powershell
$env:ANTHROPIC_API_KEY = "sk-ant-your-key-here"
```
### Set Permanently (System)
1. Press `Win + X`
2. Click "System"
3. Click "Advanced system settings"
4. Click "Environment Variables"
5. Under "User variables", click "New"
6. Variable: `ANTHROPIC_API_KEY`
7. Value: `sk-ant-your-key-here`
### Check if Set
```powershell
$env:ANTHROPIC_API_KEY
```
## Running as Service
### Quick Background Run
```powershell
Start-Process python -ArgumentList "bot_runner.py" -WindowStyle Hidden
```
### Stop Background Process
```powershell
# Find process
Get-Process python | Where-Object {$_.CommandLine -like "*bot_runner*"}
# Stop it (replace <PID> with actual process ID)
Stop-Process -Id <PID>
```
## Troubleshooting
### "Python not recognized"
```powershell
# Add to PATH
# Win + X -> System -> Advanced -> Environment Variables
# Edit PATH, add: C:\Users\fam1n\AppData\Local\Programs\Python\Python3XX
```
### "Module not found"
```powershell
.\venv\Scripts\activate
pip install -r requirements.txt --force-reinstall
```
### "API key not found"
```powershell
$env:ANTHROPIC_API_KEY = "sk-ant-your-key-here"
```
### Reset Memory
```powershell
Remove-Item -Recurse -Force memory_workspace
python example_usage.py
```
## Project Files Quick Reference
| File/Folder | Purpose |
|-------------|---------|
| `agent.py` | Main agent logic |
| `bot_runner.py` | Multi-platform bot launcher |
| `pulse_brain.py` | Monitoring system |
| `example_*.py` | Example scripts to test |
| `test_*.py` | Test scripts |
| `config/` | Configuration files |
| `docs/` | Full documentation |
| `adapters/` | Platform integrations |
| `memory_workspace/` | Memory database |
## Model Switching
Tell your bot via chat:
- `/haiku` - Fast, cheap (default)
- `/sonnet` - Smart, caching enabled
- `/status` - Check current model
## Need More Help?
- **Complete Setup Guide:** [SETUP.md](SETUP.md)
- **Full Windows Guide:** [docs/WINDOWS_DEPLOYMENT.md](docs/WINDOWS_DEPLOYMENT.md)
- **Main Documentation:** [docs/README.md](docs/README.md)