Get Started
One download, one command. PulseAssist installs everything it needs and starts running on your machine.
What you need
- Python 3.12+— Backend runtime
- Node.js 20+— Frontend runtime
- Redis— Task queue and caching (installer can set this up)
- Anthropic API key— Required for the AI brain
- A dedicated machine (recommended)— PulseAssist controls screen/mouse/keyboard
Four steps to a running agent
Download and extract
Download the PulseAssist package and extract it to your preferred location.
# Download the latest release
curl -L https://github.com/pulseassist/pulseassist/releases/latest/download/pulseassist.tar.gz -o pulseassist.tar.gz
tar -xzf pulseassist.tar.gz
cd pulseassistRun the installer
The setup script checks dependencies, installs packages, and walks you through configuration.
# Unix/macOS
python setup.py
# Windows PowerShell
python setup.py
# Or: .\install.ps1Configure API keys
The installer prompts for your keys. Only the Anthropic API key is required — everything else is optional.
# The installer writes .env.local for you
# You can also edit manually:
ANTHROPIC_API_KEY=sk-ant-...
TELEGRAM_BOT_TOKEN=... # optional
TELNYX_API_KEY=... # optional
ELEVENLABS_API_KEY=... # optionalStart PulseAssist
The installer starts all services automatically. Open your browser and your agent is ready.
# Services start automatically after setup:
# - FastAPI backend (port 8000)
# - Next.js frontend (port 3001)
# - Redis (port 6379)
# - Caddy reverse proxy (port 3000)
# Open in browser:
# http://localhost:3000
# Or manage manually:
pm2 start ecosystem.config.js
pm2 statusService configuration
Only the Anthropic API key is required. All other services are optional and can be added later.
How it all fits together
Python Backend
FastAPI + Uvicorn. Computer Use, task execution, phone calls, identity system, learning engine, Celery workers.
Next.js Frontend
App Router + TypeScript. Dashboard, chat, journal reader, identity display, live screen viewer, settings.
SQLite (Local)
All data stored locally. Auto-creates on first run. Sensitive fields encrypted at rest.
Redis
Task queue (Celery) and caching layer. Runs locally alongside the main services.
Caddy Reverse Proxy
Single port entry. Routes /api/v1/* to backend, everything else to frontend. Handles HTTPS automatically.