mirror of
https://github.com/pocketpaw/pocketpaw.git
synced 2026-05-18 16:06:22 +00:00
f15e76abe7
* Fix incorrect Anthropic API key generation URL * Fix incorrect Anthropic API key generation URL all places occurence changed with right url --------- Co-authored-by: Rohit Kushwaha <rohitk290106@gmail.com>
145 lines
4.2 KiB
Plaintext
145 lines
4.2 KiB
Plaintext
---
|
|
title: "Quick Start: Your First AI Agent in 5 Minutes"
|
|
description: "Get PocketPaw running in 5 minutes: install the package, set your API key, launch the web dashboard, and send your first message to your self-hosted AI agent."
|
|
section: Getting Started
|
|
ogType: article
|
|
keywords: ["quick start", "first run", "tutorial", "beginner guide", "web dashboard"]
|
|
tags: ["tutorial", "getting-started"]
|
|
---
|
|
|
|
# Quick Start: Your First AI Agent in 5 Minutes
|
|
|
|
This guide gets you from zero to a working AI agent in under 5 minutes.
|
|
|
|
## Step 1: Install
|
|
|
|
```bash
|
|
curl -fsSL https://pocketpaw.xyz/install.sh | sh
|
|
```
|
|
On **Windows PowerShell**, use:
|
|
|
|
```powershell
|
|
powershell -NoExit -Command "iwr -useb https://pocketpaw.xyz/install.ps1 | iex"
|
|
```
|
|
|
|
**Tip:** If the install command fails, make sure Python 3.11+ is installed and available in your system PATH.
|
|
|
|
|
|
## Step 2: Set Your API Key
|
|
|
|
```bash
|
|
export POCKETPAW_ANTHROPIC_API_KEY="sk-ant-your-key-here"
|
|
```
|
|
|
|
Get your key at [console.anthropic.com/api-keys](https://console.anthropic.com/settings/keys). An API key is **required** for the Claude SDK backend — OAuth tokens from Claude Free/Pro/Max plans are [not permitted](https://code.claude.com/docs/en/legal-and-compliance#authentication-and-credential-use) for third-party use. For free local inference, use [Ollama](/backends/ollama) instead.
|
|
|
|
## Step 3: Launch
|
|
|
|
```bash
|
|
pocketpaw
|
|
```
|
|
|
|
This starts the **web dashboard** at `http://localhost:8888`. Open it in your browser.
|
|
|
|
## Step 4: Chat
|
|
|
|
Type a message in the chat input and press Enter. PocketPaw will process it through the Claude Agent SDK and stream the response back in real-time.
|
|
|
|
Try these example prompts:
|
|
|
|
- "What files are in my home directory?"
|
|
- "Write a Python script that calculates prime numbers"
|
|
- "Search the web for the latest news about AI"
|
|
|
|
## Running Headless Channels
|
|
|
|
You can also run PocketPaw as a headless bot on specific channels:
|
|
|
|
```bash
|
|
# Telegram only (legacy pairing flow)
|
|
pocketpaw --telegram
|
|
|
|
# Discord only
|
|
pocketpaw --discord
|
|
|
|
# Slack only
|
|
pocketpaw --slack
|
|
|
|
# Multiple channels
|
|
pocketpaw --discord --slack --whatsapp
|
|
|
|
# All configured channels
|
|
pocketpaw # Default web dashboard auto-starts configured adapters
|
|
```
|
|
|
|
## Configuring a Telegram Bot
|
|
|
|
<Steps>
|
|
<Step title="Create a bot with BotFather">
|
|
Open Telegram, search for `@BotFather`, send `/newbot`, and follow the prompts. Copy the token.
|
|
</Step>
|
|
<Step title="Set the token">
|
|
```bash
|
|
export POCKETPAW_TELEGRAM_TOKEN="your-bot-token"
|
|
```
|
|
</Step>
|
|
<Step title="Start in Telegram mode">
|
|
```bash
|
|
pocketpaw --telegram
|
|
```
|
|
</Step>
|
|
<Step title="Chat with your bot">
|
|
Open Telegram, find your bot, and start chatting.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Configuring Discord
|
|
|
|
<Steps>
|
|
<Step title="Create a Discord application">
|
|
Go to the [Discord Developer Portal](https://discord.com/developers/applications), create a new application, and add a bot.
|
|
</Step>
|
|
<Step title="Set the token">
|
|
```bash
|
|
export POCKETPAW_DISCORD_BOT_TOKEN="your-discord-token"
|
|
```
|
|
</Step>
|
|
<Step title="Invite the bot">
|
|
Generate an invite URL with the `bot` and `applications.commands` scopes. Add it to your server.
|
|
</Step>
|
|
<Step title="Start">
|
|
```bash
|
|
pocketpaw --discord
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Using the Web Dashboard
|
|
|
|
The web dashboard is the default mode and provides:
|
|
|
|
- **Real-time chat** with streaming responses
|
|
- **Session management** with history and search
|
|
- **Tool activity panel** showing tool calls in real-time
|
|
- **Channel management** to configure and toggle channels
|
|
- **Settings panel** for all configuration options
|
|
- **MCP server management** to add and configure MCP servers
|
|
- **Memory settings** for configuring Mem0 and session storage
|
|
|
|
## What's Next?
|
|
|
|
<CardGroup>
|
|
<Card title="Configuration" icon="lucide:settings" href="/getting-started/configuration">
|
|
Explore all configuration options and environment variables.
|
|
</Card>
|
|
<Card title="Channels" icon="lucide:radio" href="/channels">
|
|
Set up additional messaging platforms.
|
|
</Card>
|
|
<Card title="Tools" icon="lucide:wrench" href="/tools">
|
|
Discover all 50+ built-in tools.
|
|
</Card>
|
|
<Card title="Security" icon="lucide:shield" href="/security">
|
|
Learn about PocketPaw's security model.
|
|
</Card>
|
|
</CardGroup>
|