Skip to main content

The AI agent that runs on your laptop, not a datacenter. OpenClaw alternative with one-command install.

Project description

PocketPaw

🐾 PocketPaw

An AI agent that runs on your machine, not someone else's.

PyPI version License: MIT Python 3.11+ Downloads GitHub Stars

Download for Windows Download for macOS Download for Linux

Self-hosted AI agent with a native desktop app and web dashboard. Talks to you over Discord, Slack, WhatsApp, Telegram, or the browser.
No subscription. No cloud lock-in. Your data stays on your machine.

⚠️ Beta: This project is under active development. Expect breaking changes between versions.


Quick Start

Desktop App (Recommended)

Download the native desktop app. It bundles the backend installer and provides a full-featured UI with system tray, global shortcuts, side panel, and multi-window support.

Platform Download
Windows PocketPaw-Setup.exe
macOS PocketPaw.dmg
Linux PocketPaw.AppImage

Install via Terminal

macOS / Linux

Prerequisites:

  • Python 3.11 or higher (download here)
  • pip package manager (included with Python)

Quick install:

pip install pocketpaw && pocketpaw

Recommended install (with virtual environment):

# 1. Verify Python version (must be 3.11+)
python3 --version

# 2. Upgrade pip to latest version
python3 -m pip install --upgrade pip

# 3. Create and activate virtual environment (optional but recommended)
python3 -m venv pocketpaw-env
source pocketpaw-env/bin/activate

# 4. Install PocketPaw
pip install pocketpaw

# 5. Run PocketPaw
pocketpaw

Or use the automated install script:

curl -fsSL https://pocketpaw.xyz/install.sh | sh
Windows (PowerShell)

Windows Installation (Step-by-Step)

Prerequisites:

  • Python 3.11 or higherDownload Python. During setup, check "Add Python to PATH".
  • pip (included with Python)

Option A — Automated installer (recommended for beginners):

powershell -NoExit -Command "iwr -useb https://pocketpaw.xyz/install.ps1 | iex"

Option B — Manual install:

  1. Open PowerShell and verify Python version (must be 3.11+):

    python --version
    
  2. Upgrade pip:

    python -m pip install --upgrade pip
    
  3. (Optional but recommended) Create and activate a virtual environment:

    python -m venv pocketpaw-env
    .\pocketpaw-env\Scripts\Activate.ps1
    
  4. Install PocketPaw:

    pip install pocketpaw
    
  5. Verify the installation by running:

    pocketpaw --help
    

    Or start the dashboard:

    pocketpaw
    

Windows Troubleshooting

If you installed PocketPaw with pip install pocketpaw and the pocketpaw command is not recognized:

'pocketpaw' is not recognized as an internal or external command

This usually means your Python Scripts directory is not on your PATH. By default it is at:

C:\Users\<your-username>\AppData\Local\Python\Python3.XX\Scripts

Find your exact Scripts path:

python -c "import sysconfig; print(sysconfig.get_path('scripts'))"

How to fix:

  1. Open Start → Search "Environment Variables"
  2. Click "Edit the system environment variables"
  3. Click "Environment Variables"
  4. Under User variables → Select Path → Click Edit
  5. Add the Scripts directory path
  6. Restart your terminal

Alternatively, run PocketPaw without adding Scripts to PATH:

python -m pocketpaw

[!TIP] First Run: After opening the dashboard, the system health may show UNHEALTHY — this is expected if no API key is configured. The app itself is running correctly; only AI features are disabled. Go to Settings > API Keys to add your key, or use Ollama for free local inference.

Note: Some features (browser automation, shell tools) work best under WSL2. Native Windows support covers the web dashboard and all LLM chat features.

Other methods
pipx install pocketpaw && pocketpaw    # Isolated install
uvx pocketpaw                           # Run without installing

# From source
git clone https://github.com/pocketpaw/pocketpaw.git
cd pocketpaw && uv run pocketpaw
Docker
git clone https://github.com/pocketpaw/pocketpaw.git && cd pocketpaw
cp .env.example .env
docker compose up -d

Dashboard at http://localhost:8888. Get the access token:

docker exec pocketpaw cat /home/pocketpaw/.pocketpaw/access_token

Agent-created files appear in ./workspace/ on the host. Optional profiles: --profile ollama (local LLMs), --profile qdrant (vector memory). Using Ollama on the host? Set POCKETPAW_OLLAMA_HOST=http://host.docker.internal:11434 in .env.

The web dashboard opens at http://localhost:8888. From there you can connect Discord, Slack, WhatsApp, or Telegram.


Features

📡 9+ Channels Web Dashboard, Discord, Slack, WhatsApp, Telegram, Signal, Matrix, Teams, Google Chat
🧠 6 Agent Backends Claude Agent SDK, OpenAI Agents, Google ADK, Codex CLI, OpenCode, Copilot SDK
🛠️ 50+ Tools Browser, web search, image gen, voice/TTS/STT, OCR, research, delegation, skills
🔌 Integrations Gmail, Calendar, Google Drive & Docs, Spotify, Reddit, MCP servers
💾 Memory Long-term facts, session history, smart compaction, Mem0 semantic search
🔒 Security Guardian AI, injection scanner, tool policy, plan mode, audit log, self-audit daemon
🏠 Local-First Runs on your machine. Ollama for fully offline operation. macOS / Windows / Linux.

Examples

You:  "Every Sunday evening, remind me which recycling bins to put out"
Paw:  Done. I'll check the recycling calendar and message you every Sunday at 6pm.

You:  "Find that memory leak, the app crashes after 2 hours"
Paw:  Found it. The WebSocket handler never closes connections. Here's the fix.

You:  "I need a competitor analysis report for our product launch"
Paw:  3 agents working on it. I'll ping you when it's ready.

Architecture

PocketPaw System Architecture

Everything goes through an event-driven message bus. Channels publish messages, the AgentLoop picks them up and routes to whichever backend you've configured. All six backends implement the same AgentBackend protocol, so swapping one for another doesn't touch the rest of the system.

The desktop client (client/) is a Tauri 2.0 + SvelteKit app that connects to the Python backend over REST and WebSocket. It provides system tray integration, global hotkeys, multi-window support (side panel, quick ask), and an onboarding wizard that handles backend installation.

Agent Backends

Backend Key Providers MCP
Claude Agent SDK (Default) claude_agent_sdk Anthropic, Ollama Yes
OpenAI Agents SDK openai_agents OpenAI, Ollama No
Google ADK google_adk Google (Gemini) Yes
Codex CLI codex_cli OpenAI Yes
OpenCode opencode External server No
Copilot SDK copilot_sdk Copilot, OpenAI, Azure, Anthropic No

Security

PocketPaw 7-Layer Security Stack

A secondary LLM (Guardian AI) reviews every tool call before it runs. On top of that: injection scanning, configurable tool policies, plan mode for human approval, --security-audit CLI, a self-audit daemon, and an append-only audit log. Details in the docs.

Detailed security architecture

PocketPaw Security Architecture (Defense-in-Depth)


Configuration

Settings live in ~/.pocketpaw/config.json. You can also use POCKETPAW_-prefixed env vars or the dashboard Settings panel. API keys are encrypted at rest.

Environment Variables (.env file)

PocketPaw ships with a .env.example file that lists every supported environment variable with inline comments. Before running PocketPaw (especially when cloning from source or using Docker), copy it to .env and fill in the values you need:

# macOS / Linux
cp .env.example .env

# Windows (PowerShell)
Copy-Item .env.example .env

Then open .env in your editor and uncomment / set the variables relevant to your setup. For example:

# LLM provider
POCKETPAW_ANTHROPIC_API_KEY=sk-ant-...
POCKETPAW_AGENT_BACKEND=claude_agent_sdk   # or openai_agents, google_adk, etc.

# Optional: Telegram bot
POCKETPAW_TELEGRAM_BOT_TOKEN=...
POCKETPAW_ALLOWED_USER_ID=...

Tip: Variables set in .env are loaded automatically at startup. You can also export them directly in your shell or set them via the dashboard Settings panel — all three methods work interchangeably.

Alternatively, export variables directly in your shell:

export POCKETPAW_ANTHROPIC_API_KEY="sk-ant-..."   # Required for Claude SDK backend
export POCKETPAW_AGENT_BACKEND="claude_agent_sdk"  # or openai_agents, google_adk, etc.

Note: An Anthropic API key from console.anthropic.com is required for the Claude SDK backend. OAuth tokens from Claude Free/Pro/Max plans are not permitted for third-party use. For free local inference, use Ollama instead.

See the full configuration reference for all settings.


Development

Backend (Python)

Prerequisites:

Install uv:

[!WARNING] Windows users: You must open a new terminal window after running the install script below before uv will be recognized. The installer updates your PATH, but this change does not apply to your current terminal session — running uv immediately after install will give a CommandNotFoundException error.

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# Or via pip
pip install uv

[!TIP] Windows: To use uv immediately without opening a new terminal, run:

$env:Path = "$env:USERPROFILE\.local\bin;$env:Path"

Then verify the installation: uv --version

Setup and run:

# 1. Verify Python version
python3 --version

# 2. Clone and enter the repository
git clone https://github.com/pocketpaw/pocketpaw.git && cd pocketpaw

# 3. Install with dev dependencies
uv sync --dev

# 4. Run PocketPaw in development mode (auto-reload)
uv run pocketpaw --dev

# 5. Run tests
uv run pytest --ignore=tests/e2e    # Run tests (2900+)

# 6. Lint & format
uv run ruff check . && uv run ruff format .
Optional extras
pip install pocketpaw[openai-agents]       # OpenAI Agents backend
pip install pocketpaw[google-adk]          # Google ADK backend
pip install pocketpaw[discord]             # Discord
pip install pocketpaw[slack]               # Slack
pip install pocketpaw[memory]              # Mem0 semantic memory
pip install pocketpaw[all]                 # Everything

Desktop Client (Tauri + SvelteKit)

The native desktop app lives in client/. It connects to the Python backend via REST/WebSocket.

Prerequisites:

  • Bun (package manager)
  • Rust (for Tauri)
  • Python backend running on localhost:8888
cd client
bun install                    # Install dependencies
bun run dev                    # Vite dev server (http://localhost:1420)
bun run tauri dev              # Full desktop app (frontend + Tauri shell)
bun run check                  # Type check
bun run tauri build            # Production build

Tech stack: SvelteKit 2 + Svelte 5, Tailwind CSS 4, shadcn-svelte, Tauri 2.0 (Rust). See client/CLAUDE.md for full architecture details.


Documentation

pocketpaw.xyz covers getting started, backends, channels, tools, integrations, security, memory, and the full API reference.


Star History

Star History Chart

Contributors

Contributors

Join the Pack

PRs welcome. Come build with us.

License

MIT © PocketPaw Team

PocketPaw
Built for people who'd rather own their AI than rent it

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pocketpaw-0.4.8.tar.gz (48.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pocketpaw-0.4.8-py3-none-any.whl (731.5 kB view details)

Uploaded Python 3

File details

Details for the file pocketpaw-0.4.8.tar.gz.

File metadata

  • Download URL: pocketpaw-0.4.8.tar.gz
  • Upload date:
  • Size: 48.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pocketpaw-0.4.8.tar.gz
Algorithm Hash digest
SHA256 30a17d55ec18472273421bfada0e43f8da03de64c90ea231b086f02c101dba5e
MD5 10c90199631221caa371e106a8c3d5b4
BLAKE2b-256 548211378a78d3acd9829c4bc35e338850328d957734e67de1f209a8c305506e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pocketpaw-0.4.8.tar.gz:

Publisher: publish.yml on pocketpaw/pocketpaw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pocketpaw-0.4.8-py3-none-any.whl.

File metadata

  • Download URL: pocketpaw-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 731.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pocketpaw-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 f2b360296deaf7b7b705ee854b4ec6237cd93be8eae9fde69f06a249886b3edd
MD5 6a3473f9e2600bfd5b8e1b4af31cb0b1
BLAKE2b-256 19ae19221ceaa696fafeb2702c631a923edbb3bc2e5dbcdf682fd4980b34b11f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pocketpaw-0.4.8-py3-none-any.whl:

Publisher: publish.yml on pocketpaw/pocketpaw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page