Skip to main content

Angel Claw personal AI agent framework

Project description

Angel Claw

A personal AI agent framework based on OpenClaw, using angel-recall for memory and litellm for LLM interactions.

Features

  • FastAPI Gateway: HTTP interface for interacting with the agent.
  • Multi-Channel Bridge: Connect and pair your agent with Telegram for mobile access.
  • Agent-Native Memory: Powered by angel-recall, providing long-term, evolvable memory for each session.
  • Proactive Tasks: Built-in background worker for at, every, and cron schedules.
  • Multi-Model Support: Uses litellm to connect to various providers (OpenAI, Anthropic, Ollama, etc.).

Setup

  1. Install dependencies:

    pip install angel-claw
    
  2. Configure environment: Copy .env.example to .env and fill in your API keys.

    • MODEL_KEY: Your LLM API key.
    • TELEGRAM_TOKEN: (Optional) Your bot token from @BotFather.
    cp .env.example .env
    
  3. Run the gateway:

    angel-claw
    

Usage

For detailed instructions on how to use Angel Claw and its skills system, see the Documentation.

Out-of-the-Box Capabilities

Angel Claw comes pre-loaded with several powerful features. Here are some examples of what you can do:

1. Long-Term Memory

The agent automatically stores and retrieves facts about you.

  • Prompt: "Remember that I'm allergic to peanuts."
  • Prompt (Later): "What should I avoid at the Thai restaurant?"
  • Result: Angel Claw will retrieve your allergy fact and advise you accordingly.

2. Proactive Messaging & Scheduling

Schedule tasks or reminders that the agent will trigger on its own.

  • Prompt: "Remind me to check the oven in 20 minutes."
  • Prompt: "Every day at 9 AM, check the weather in London and message me if it's raining."
  • Prompt: "Schedule a task named 'daily-report' to run 0 18 * * * that summarizes my day."

3. Web Search & Browser Automation

The agent can browse the web to find information or interact with sites.

  • Prompt: "Search for the latest news about SpaceX and summarize it."
  • Prompt: "Go to https://news.ycombinator.com and tell me the top story."

4. Custom Skill Generation

If Angel Claw doesn't have a tool, it can write one for itself.

  • Prompt: "Create a skill called 'currency_converter' that uses an API to convert USD to EUR."

Telegram Bridge

You can interact with Angel Claw from your phone using Telegram:

  1. Get a Bot Token: Create a bot using @BotFather and add TELEGRAM_TOKEN to your .env.
  2. Start your bot on Telegram and press "Start".
  3. Pair your chat: Use the /pair command with your session ID (e.g., /pair cli-default).
  4. Angel Claw will now respond to your Telegram messages using that session's memory and skills.

WhatsApp Bridge

Angel Claw supports WhatsApp via a "Link Device" (QR code) method:

  1. Enable WhatsApp: Add WHATSAPP_ENABLED=True to your .env.
  2. Link Your Device: Run the dedicated login command:
    angel-claw login-whatsapp
    
  3. Scan QR Code: Scan the QR code that appears in your terminal using your phone (WhatsApp > Linked Devices).
  4. Start Angel Claw: Once linked, you can run angel-claw chat as normal.
  5. Pair your chat: On WhatsApp, send /pair <session-id> (e.g., /pair cli-default) to yourself or the bot's number.
  6. Angel Claw is now connected to your WhatsApp!

Basic Chat

Send a POST request to /chat:

curl -X POST http://localhost:8000/chat \
     -H "Content-Type: application/json" \
     -d '{"session_id": "user-123", "message": "Hi, I am Alex. Remember that I like Python.", "user_id": "alex"}'

Testing

pytest

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

angel_claw-0.4.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

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

angel_claw-0.4.0-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file angel_claw-0.4.0.tar.gz.

File metadata

  • Download URL: angel_claw-0.4.0.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.1","id":"xia","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for angel_claw-0.4.0.tar.gz
Algorithm Hash digest
SHA256 8add9db4fb1d1a9c825b49be6bfa4c93384635f4b9e8fdc0091c4f3c401ca765
MD5 d6fd3c5c863205fd0a17dfccfac5e579
BLAKE2b-256 6302be1135df129b5a7cd6ca96bd2043912498a6af0bdd4164131734c44a7912

See more details on using hashes here.

File details

Details for the file angel_claw-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: angel_claw-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.1","id":"xia","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for angel_claw-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3694f6f6343faa9de64c37a12489cbfe4130d97033f590db2ef527852eb97485
MD5 da6839bba31fe2d4b875b243a6126d34
BLAKE2b-256 bed10a2d80574718968d83454b9512f0dc10b2967bd56ebf9b6bac6c58f46b70

See more details on using hashes here.

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