Skip to main content

Your Personal AI Assistant - Universal Neural Core

Project description

🦞 YouClaw - Your Personal AI Assistant

YouClaw is a powerful, self-hosted AI assistant that connects to Telegram, Discord, and a beautiful web dashboard. Built with privacy in mind, all your data stays on your machine.

✨ Features

  • 🤖 Multi-Platform: Telegram, Discord, and Web Dashboard
  • 🧠 Semantic Memory: Remembers context using vector embeddings
  • AI Cron Jobs: Schedule recurring AI-powered tasks
  • 🔍 Real-Time Search: Integrated web search for up-to-date information
  • 📧 Email Integration: Send and check emails via AI commands
  • 🎭 Multiple Personalities: Switch between different AI personas
  • 🛡️ Admin Controls: Full control over your personal instance
  • 📦 Self-Contained: No external API keys required (uses local Ollama)

🚀 Quick Start

Prerequisites

  • Python 3.10+
  • Ollama installed and running locally

Installation

pip install youclaw

First Run

youclaw start

This will launch the Neural Wizard - an interactive setup that guides you through:

  • Telegram bot token configuration
  • Discord bot token configuration
  • Search engine URL (optional)
  • Email credentials (optional)

You can skip any step and configure it later via the dashboard.

Access Dashboard

After setup, access your Mission Control at:

http://localhost:8080

📖 Usage

CLI Commands

youclaw start      # Start YouClaw (runs wizard if unconfigured)
youclaw check      # Health check
youclaw dashboard  # Start dashboard only

Creating Your First Admin Account

  1. Navigate to http://localhost:8080
  2. Click "Register"
  3. Create your account (first user is automatically admin)
  4. Access the ROOT PROTOCOLS panel at the bottom

🔧 Configuration

YouClaw stores configuration in .env and uses SQLite for data persistence.

Environment Variables

OLLAMA_HOST=http://localhost:11434
OLLAMA_MODEL=qwen2.5:1.5b-instruct
TELEGRAM_BOT_TOKEN=your_token_here
DISCORD_BOT_TOKEN=your_token_here
SEARCH_ENGINE_URL=http://your-search-engine/search

🛡️ Security

  • Universal Admin: Every user on your personal clone has full admin rights
  • Local-First: All data stays on your machine
  • Token-Based Auth: Secure session management for the dashboard
  • No Cloud Dependencies: Runs entirely offline (except for bot platforms)

📝 License

MIT License - See LICENSE file for details

🤝 Contributing

Contributions are welcome! This is an open-source personal AI assistant project.

🐛 Issues

Report issues on GitHub: [Your Repository URL]

💬 Community

Join the discussion: [Your Community Link]


Made with 🦞 by the YouClaw Community

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

youclaw-4.7.2.tar.gz (52.0 kB view details)

Uploaded Source

Built Distribution

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

youclaw-4.7.2-py3-none-any.whl (58.1 kB view details)

Uploaded Python 3

File details

Details for the file youclaw-4.7.2.tar.gz.

File metadata

  • Download URL: youclaw-4.7.2.tar.gz
  • Upload date:
  • Size: 52.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for youclaw-4.7.2.tar.gz
Algorithm Hash digest
SHA256 613c9b74fcf469ad6a1437d887f0e357724f17320dc089fd1f6caaf86cef75a9
MD5 e000740cb8240bebcb467d607b819853
BLAKE2b-256 c88dadecb0e61c5ffb7c3ed51b15e89f6d388825bd491a2e583000e95338218c

See more details on using hashes here.

File details

Details for the file youclaw-4.7.2-py3-none-any.whl.

File metadata

  • Download URL: youclaw-4.7.2-py3-none-any.whl
  • Upload date:
  • Size: 58.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for youclaw-4.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 80d7351d54d50f752f4e04e37321488e753f0c9a9c2f6210d7f13f25e948ac22
MD5 6fc3c6044d6eac4d85b372a8f3ef1d48
BLAKE2b-256 c07d6a3c4c3290f741afc781ec1d5eb8440320f4327aea10074e1179a7b234a2

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