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.1.tar.gz (52.2 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.1-py3-none-any.whl (58.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youclaw-4.8.1.tar.gz
  • Upload date:
  • Size: 52.2 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.1.tar.gz
Algorithm Hash digest
SHA256 3fd47525f27baa8e89d175dff18f842fc81054d207a1e9f7805cac7c9bf2a2f8
MD5 18801253f456cd01cd8f94e305b547a8
BLAKE2b-256 f0d8ef3bde436cd644d26e18c1d9b835ef5f38ee9107e9985547555f6a9f655c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: youclaw-4.8.1-py3-none-any.whl
  • Upload date:
  • Size: 58.3 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e115d37cd3774038bcc6d2e7d906c3c1f5e83bf62d9da7228c0266b8906f9082
MD5 7d6cc1080e26c20e54d75a3cb3c4ed7a
BLAKE2b-256 bf1affcf36a5813cff75ff475144f223795431756c32d4c17024eb9d27a85276

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