Welcome to the Kuucode documentation! This directory contains comprehensive guides for developers working with Kuucode.
- Development Guide - Essential setup and development workflow
- API Documentation - REST API reference and examples
- SDK Generation - Complete guide to generating client SDKs
- OpenAPI Generator Config - Configuration files for SDK generation
docs/
├── README.md # This file - documentation index
├── DEVELOPMENT.md # Development setup and workflow
├── SDK_GENERATION.md # Comprehensive SDK generation guide
└── API.md # API reference and examples
config/
├── typescript-config.json # TypeScript SDK configuration
├── go-config.json # Go SDK configuration
└── python-config.json # Python SDK configuration
scripts/
└── generate-sdks # Main SDK generation script
- Setup: Follow the Development Guide
- Make Changes: Edit code in
packages/kuucode/src/ - Generate SDKs: Run
./scripts/generate-sdks --dev - Test: Use the TUI or API directly
- TypeScript:
npm install @kuucode-ai/sdk - Go:
go get github.com/moikas-code/kuucode-sdk-go - Python:
pip install kuucode-ai
See API Documentation for usage examples.
Kuucode uses a client/server architecture:
- Server (TypeScript): API and business logic
- TUI (Go): Terminal user interface
- SDKs: Generated client libraries
- Uses OpenAPI Generator (free, open source)
- Generates TypeScript, Go, and Python SDKs
- Fully automated with
./scripts/generate-sdks - Replaces previous Stainless dependency
- Edit server code in
packages/kuucode/src/ - Regenerate SDKs with
./scripts/generate-sdks --dev - Test changes locally
- Commit Go SDK changes (others are gitignored)
Complete setup and development workflow including:
- Prerequisites and installation
- Architecture overview
- Development workflow
- Testing and debugging
- Contributing guidelines
Comprehensive SDK generation documentation including:
- OpenAPI Generator setup
- Configuration options
- Troubleshooting
- Publishing workflows
- Migration from Stainless
REST API reference including:
- Endpoint documentation
- Authentication
- SDK usage examples
- Error handling
- Streaming events
./scripts/generate-sdks --devbun install
bun run dev# Terminal 1: Start server
bun run dev
# Terminal 2: Test TUI
cd packages/tui && go run .cd packages/web
bun run dev- Check the guides in this directory
- Review troubleshooting in SDK_GENERATION.md
- Open an issue at moikas-code/kuucode/issues
- Check OpenAPI Generator docs at openapi-generator.tech
- Replaced $99/month Stainless with free OpenAPI Generator
- Added full local control over SDK generation
- Maintained backward compatibility (
./scripts/stainlessstill works) - Improved customization and template control
- TypeScript: Full ES6+ support with interfaces
- Go: Idiomatic Go with context support
- Python: Type hints and async/await support
Last updated: January 2025
Need to add something? Edit the relevant documentation file and submit a pull request!