Kuma Claw

English | 简体中文 | 日本語

🦞 AI Office Assistant built on Google ADK

---

👥 Recruiting Developers

We're looking for developers to join our open-source AI assistant project!

🎯 Project Vision

Enable every small business and indie developer to deploy an AI office assistant at zero cost with one-click deployment to GCP free tier.

🔧 Tech Stack

Area	Technology
Backend	Python 3.11+, Google ADK, FastAPI
Deployment	GCP Cloud Run, Docker, Cloud Build
Channels	Telegram Bot API, Slack API
AI	Google Generative AI (Gemini)
Tools	Git, pytest, GitHub Actions

🙋 Roles We Need

• Backend Developers - Python/API development experience
• Frontend Developers - Web UI/Admin panel (planned)
• Skills Developers - Build new skill modules
• Documentation/Translation - Chinese/Japanese/English support
• Testers - Unit/Integration testing

🎁 What You Get

• 📈 Open-source project experience (great for resume)
• 🤝 Meet talented developers
• 💡 Learn AI Agent/GCP deployment hands-on
• 🌟 GitHub contribution record
• ☕ Online tech sharing sessions

📮 How to Join

1. Fork the repo and start contributing
2. Join discussions - Participate in Issues
3. Contact us - tianxiao1430@gmail.com or comment on Issues

New? Start with good first issue tasks!

---

🚀 One-Click Deployment

Deploy to GCP free tier in 5 minutes!

• 📖 GCP Deployment Guide - Detailed steps
• 

📚 Documentation

Full documentation in docs/ directory:

• 📦 Deployment Guide - GCP one-click deployment (NEW)
• Delivery Report - Project delivery summary
• Quick Reference - Commands and API cheat sheet
• Integration Guide - How to integrate Kuma Claw
• Skills System - Skills system documentation
• Security Policy - Security best practices

🚀 Quick Start

1. Install Dependencies

pip install -r requirements.txt

2. Configure Environment

cp .env.example .env
# Edit .env file with your API keys

3. Run

# CLI mode
python -m kuma_claw.main

# Or run as service
python -m kuma_claw.gateway

🎯 Core Features

• Multi-Channel: Telegram, Slack, Web (Discord, WhatsApp planned)
• Skills System: Modular skill extension mechanism
• Memory System: Long-term memory and context management
• Google Workspace: Gmail, Calendar, Sheets, Docs integration
• Web Search: DuckDuckGo real-time search

📁 Project Structure

.
├── kuma_claw/              # Core code
│   ├── agent.py           # Agent definition
│   ├── channels/          # Channel implementations
│   ├── tools/             # Toolset
│   ├── skills/            # Skills system
│   └── prompts/           # Prompt templates
├── tests/                  # Test suite
├── docs/                   # Documentation
├── .github/workflows/     # CI/CD
├── requirements.txt        # Dependencies
└── pytest.ini             # Test configuration

🧪 Testing

# Run all tests
pytest

# Run tests with coverage report
pytest --cov=kuma_claw --cov-report=html

🤝 Contributing

Contributions welcome:

• New Skills
• Bug fixes
• Documentation improvements
• Feature requests

See CONTRIBUTING.md for detailed guidelines.

📄 License

Apache License 2.0

🔗 Links

• GitHub Repo
• Issue Tracker
• Documentation

---

Version: v0.1.1 Status: 🚀 In Development