875c7f9b91
- Add full Telegram bot functionality with Z.AI API integration
- Implement 4 tools: Bash, FileEdit, WebSearch, Git
- Add 3 agents: Code Reviewer, Architect, DevOps Engineer
- Add 6 skills for common coding tasks
- Add systemd service file for 24/7 operation
- Add nginx configuration for HTTPS webhook
- Add comprehensive documentation
- Implement WebSocket server for real-time updates
- Add logging system with Winston
- Add environment validation
🤖 zCode CLI X - Agentic coder with Z.AI + Telegram integration
160 lines
3.7 KiB
Markdown
160 lines
3.7 KiB
Markdown
# zCode CLI X
|
|
|
|
Agentic coder with **Z.AI + Telegram integration** — Claude Code + Hermes in one beast.
|
|
|
|
## 🚀 Features
|
|
|
|
- **🤖 AI-Powered Code Generation**: Powered by Z.AI GLM-5.1 (Coding Plan)
|
|
- **📱 Telegram Bot**: 24/7 live interaction via Telegram
|
|
- **🛠️ Full Engineering Access**: Bash, FileEdit, WebSearch, Git tools
|
|
- **🧠 Agent System**: Code reviewer, architect, DevOps engineer
|
|
- **📚 Skills System**: Pre-built skills for common tasks
|
|
- **⚡ Real-time Updates**: WebSocket-based live communication
|
|
|
|
## 📦 Installation
|
|
|
|
```bash
|
|
cd zcode-cli-x
|
|
npm install
|
|
```
|
|
|
|
## ⚙️ Configuration
|
|
|
|
Copy `.env.example` to `.env` and configure:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
### Required Environment Variables
|
|
|
|
```env
|
|
# Z.AI Configuration (Coding Plan)
|
|
GLM_BASE_URL=https://api.z.ai/api/coding/paas/v4
|
|
ZAI_API_KEY=your_zai_api_key_here
|
|
|
|
# Telegram Bot Configuration
|
|
TELEGRAM_BOT_TOKEN=your_bot_token_here
|
|
TELEGRAM_ALLOWED_USERS=your_telegram_id
|
|
ZCODE_WEBHOOK_URL=https://your-domain.com/telegram/webhook
|
|
```
|
|
|
|
## 🎮 Usage
|
|
|
|
### Run as CLI
|
|
|
|
```bash
|
|
node bin/zcode.js
|
|
```
|
|
|
|
### Run as Telegram Bot (24/7)
|
|
|
|
```bash
|
|
node bin/zcode.js --bot
|
|
```
|
|
|
|
### Run in Development Mode
|
|
|
|
```bash
|
|
node bin/zcode.js --dev
|
|
```
|
|
|
|
### Run Only CLI (No Bot)
|
|
|
|
```bash
|
|
node bin/zcode.js --no-bot
|
|
```
|
|
|
|
## 🤖 Telegram Bot
|
|
|
|
Once running, you can interact with zCode CLI X via Telegram:
|
|
|
|
1. Start the bot: `/start`
|
|
2. Send your code requests or questions
|
|
3. Receive AI-powered responses in real-time
|
|
|
|
## 🛠️ Tools Available
|
|
|
|
- **Bash**: Execute shell commands
|
|
- **FileEdit**: Edit files with diff-aware operations
|
|
- **WebSearch**: Search the web for information
|
|
- **Git**: Git operations (status, log, branch)
|
|
|
|
## 🧠 Agents
|
|
|
|
- **Code Reviewer**: Review code for bugs and improvements
|
|
- **System Architect**: Design system architecture and patterns
|
|
- **DevOps Engineer**: Handle deployment, CI/CD, and infrastructure
|
|
|
|
## 📚 Skills
|
|
|
|
- **code_review**: Review code for bugs, security issues, and improvements
|
|
- **bug_fix**: Fix identified bugs in code
|
|
- **refactor**: Refactor code for better quality
|
|
- **documentation**: Generate and update documentation
|
|
- **testing**: Write tests for code
|
|
|
|
## 🏗️ Architecture
|
|
|
|
```
|
|
zcode-cli-x/
|
|
├── bin/
|
|
│ └── zcode.js # CLI entry point
|
|
├── src/
|
|
│ ├── api/
|
|
│ │ └── index.js # Z.AI API adapter
|
|
│ ├── bot/
|
|
│ │ └── index.js # Telegram bot integration
|
|
│ ├── tools/
|
|
│ │ ├── BashTool.js # Shell command executor
|
|
│ │ ├── FileEditTool.js # File operations
|
|
│ │ ├── WebSearchTool.js # Web search
|
|
│ │ └── GitTool.js # Git operations
|
|
│ ├── skills/
|
|
│ │ └── index.js # Skills system
|
|
│ ├── agents/
|
|
│ │ └── index.js # Agent orchestration
|
|
│ └── utils/
|
|
│ ├── logger.js # Winston logger
|
|
│ └── env.js # Environment validation
|
|
├── .env # Configuration
|
|
└── package.json
|
|
```
|
|
|
|
## 🔗 Integrations
|
|
|
|
- **Z.AI API**: GLM-5.1 model with Coding Plan
|
|
- **Telegram Bot API**: Webhook + WebSocket
|
|
- **Express.js**: HTTP server
|
|
- **Winston**: Logging
|
|
|
|
## 🚀 Getting Started
|
|
|
|
1. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
2. Configure `.env` with your credentials
|
|
|
|
3. Run the bot:
|
|
```bash
|
|
node bin/zcode.js --bot
|
|
```
|
|
|
|
4. Open Telegram and start chatting!
|
|
|
|
## 📝 License
|
|
|
|
MIT
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions welcome! This is based on:
|
|
- [better-clawd](https://github.com/x1xhlol/better-clawd.git) - Claude Code clone
|
|
- [Hermes Agent](https://hermes-agent.nousresearch.com) - Our AI assistant
|
|
|
|
---
|
|
|
|
Built with ❤️ by zCode CLI X
|