Skip to content

Latest commit

 

History

History
 
 

docs

README.md

Kuucode Documentation

Welcome to the Kuucode documentation! This directory contains comprehensive guides for developers working with Kuucode.

📚 Documentation Index

Getting Started

SDK Development

Project Structure

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

🚀 Quick Start

For Developers

  1. Setup: Follow the Development Guide
  2. Make Changes: Edit code in packages/kuucode/src/
  3. Generate SDKs: Run ./scripts/generate-sdks --dev
  4. Test: Use the TUI or API directly

For SDK Users

  1. TypeScript: npm install @kuucode-ai/sdk
  2. Go: go get github.com/moikas-code/kuucode-sdk-go
  3. Python: pip install kuucode-ai

See API Documentation for usage examples.

🔧 Key Concepts

Architecture

Kuucode uses a client/server architecture:

  • Server (TypeScript): API and business logic
  • TUI (Go): Terminal user interface
  • SDKs: Generated client libraries

SDK Generation

  • Uses OpenAPI Generator (free, open source)
  • Generates TypeScript, Go, and Python SDKs
  • Fully automated with ./scripts/generate-sdks
  • Replaces previous Stainless dependency

Development Workflow

  1. Edit server code in packages/kuucode/src/
  2. Regenerate SDKs with ./scripts/generate-sdks --dev
  3. Test changes locally
  4. Commit Go SDK changes (others are gitignored)

📖 Detailed Guides

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

🛠️ Common Tasks

Generate SDKs

./scripts/generate-sdks --dev

Start Development

bun install
bun run dev

Test API Changes

# Terminal 1: Start server
bun run dev

# Terminal 2: Test TUI
cd packages/tui && go run .

Update Documentation

cd packages/web
bun run dev

🆘 Getting Help

  1. Check the guides in this directory
  2. Review troubleshooting in SDK_GENERATION.md
  3. Open an issue at moikas-code/kuucode/issues
  4. Check OpenAPI Generator docs at openapi-generator.tech

🔄 Recent Changes

Migration from Stainless ✅

  • Replaced $99/month Stainless with free OpenAPI Generator
  • Added full local control over SDK generation
  • Maintained backward compatibility (./scripts/stainless still works)
  • Improved customization and template control

SDK Support

  • 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!