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.6.5.tar.gz (51.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.6.5-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youclaw-4.6.5.tar.gz
  • Upload date:
  • Size: 51.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.6.5.tar.gz
Algorithm Hash digest
SHA256 928c7fc55015a152f50142ef8259e6de8595b74772f04a4bccfb788541220f6f
MD5 f25e8040c8f020fe040ec669e477392c
BLAKE2b-256 e7c0c4148b7b969c161aeeca1897d13b60c78e3a9f171fb56f870c039c4d8200

See more details on using hashes here.

File details

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

File metadata

  • Download URL: youclaw-4.6.5-py3-none-any.whl
  • Upload date:
  • Size: 57.2 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.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 72c2dd1a446d69f8de34ddde56ed094c89f020b1a72a5053d4411f081fdcec7d
MD5 364bf34339df30faf1f7e7c9844f4b77
BLAKE2b-256 62a17941a58ec9656075abfd81b929d2360bcb81ce8ad39bf149c95ca6195f14

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