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
- Navigate to
http://localhost:8080 - Click "Register"
- Create your account (first user is automatically admin)
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file youclaw-4.6.1.tar.gz.
File metadata
- Download URL: youclaw-4.6.1.tar.gz
- Upload date:
- Size: 51.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13d4bfc499ac4e60cf1bbe2803b65f63611fef53b710fc0994f49754817feb47
|
|
| MD5 |
eefb14debcc33486ae7929023ff1d6bb
|
|
| BLAKE2b-256 |
87be43c710a453ed6fdfd731b798baee5e7d34476415c2a68f2fb4e0c7dcd519
|
File details
Details for the file youclaw-4.6.1-py3-none-any.whl.
File metadata
- Download URL: youclaw-4.6.1-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dbc61dcdc8613ccd0f6edac1b3886913cccc769da5e6571af6c2ebe5921f56af
|
|
| MD5 |
6b8483c535d4ccd936dd425075efb8d7
|
|
| BLAKE2b-256 |
0df7985ec6f9d7f0543faca999d8db0dd96806db5869a5db96f6d8e862919cd8
|