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.8.0.tar.gz (52.1 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.8.0-py3-none-any.whl (58.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for youclaw-4.8.0.tar.gz
Algorithm Hash digest
SHA256 ae15cd84e3e6e7f40ce31209dd24e994da50c5048f6e027cf5f586935732a0f9
MD5 71f270b79ea95c9a3e69467b2525a9f1
BLAKE2b-256 03dcc48eb8efc1fadc02451a33140c54609ff1f8d8afabc6c29921d42c6f4b4f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: youclaw-4.8.0-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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d0ecd3a03299bfd10014be046e57bcc49d5548c39f18a8b62ca05fcd6036a8a
MD5 45621c7a81ef3c93b7a45642b716a43a
BLAKE2b-256 be63d14107867f1668ea8fc086c7352f31afc64eb693eb3c4428be53ea6bfa40

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