Getting Started
Installation, configuration, and setup guide. Clone, install, run dev server, CLI chat, tests, and GitHub Bot.
Related: Use Cases | Architecture | API Reference | Deployment
Complete guide to installing, configuring, and running duyetbot-agent.
Prerequisites
- Node.js 20+
- pnpm 9+
- GitHub account (for OAuth and GitHub Bot)
- Anthropic API key (or Claude-compatible: Z.AI, OpenRouter)
Installation
1. Clone Repository
2. Install Dependencies
3. Build All Packages
4. Run Tests
All 443 tests should pass.
Configuration
Environment Variables
Create a .env file in the root directory:
GitHub OAuth Setup
- Go to GitHub Developer Settings
- Create a new OAuth App
- Set callback URL:
http://localhost:3001/auth/github/callback - Copy Client ID and Client Secret to
.env
LLM Provider Configuration
The system supports Claude-compatible providers:
| Provider | Format | Example |
|---|---|---|
| Anthropic | claude:<model> | claude:claude-sonnet-4-20250514 |
| Z.AI | via base URL | Set ANTHROPIC_BASE_URL=https://api.z.ai/api/anthropic |
| OpenRouter | openrouter:<model> | openrouter:anthropic/claude-3.5-sonnet |
Model shortcuts: haiku, sonnet, opus
Development
Start Development Server
This starts all packages in watch mode.
Run Specific Package
Code Quality
Testing
Project Structure
CLI Usage
Interactive Chat
One-shot Questions
With Specific Model
Session Management
GitHub Bot Usage
Local Development
- Use smee.io for webhook forwarding:
- Start the bot:
- Configure GitHub App webhook URL to your smee.io URL
Testing Locally
- Create a test issue in your repository
- Comment:
@duyetbot hello - Bot should respond within seconds
Git Hooks
The project includes automatic quality checks before git push:
- Runs linting and auto-fixes
- Runs TypeScript type checking
- Runs all tests
- Prevents push if checks fail
Hooks are automatically installed via pnpm install. To bypass:
Troubleshooting
Build Failures
Test Failures
TypeScript Errors
Dependency Issues
Next Steps
- Use Cases - See what you can do with @duyetbot
- Architecture - Understand the system design
- Deployment - Deploy to production
- API Reference - Explore the API endpoints
- Contributing - Contribute to the project