CONTRIBUTING.md

Contributing to @shareai-lab/kode

Development Setup

1. Install Bun

   curl -fsSL https://bun.sh/install | bash

2. Clone and Install

   git clone https://github.com/shareAI-lab/kode.git
   cd kode
   bun install

3. Run in Development

   bun run dev

Project Structure

.
├── src/                    # Source code
│   ├── entrypoints/       # CLI and MCP entry points
│   ├── commands/          # Command implementations
│   ├── components/        # React/Ink UI components
│   ├── tools/            # AI tool implementations
│   ├── services/         # Core services
│   ├── hooks/            # React hooks
│   └── utils/            # Utilities
├── scripts/              # Build and utility scripts
├── docs/                 # Documentation
├── test/                 # Test files
└── cli.js               # Generated CLI wrapper

Building

bun run build

This runs scripts/build.ts which creates:

• cli.js - Smart runtime wrapper
• .npmrc - NPM configuration

Testing

# Run tests
bun test

# Test CLI
./cli.js --help
./cli.js -p "test prompt"

Code Style

• Run bun run format before committing
• TypeScript/TSX for all source files
• No Chinese in code or comments
• Follow existing patterns

Publishing

See docs/PUBLISH.md for publishing instructions.