CONTRIBUTING.md

Contributing to @shareai-lab/kode

Development Setup

1. Install Node.js (>= 20.18.1)

   • Download from nodejs.org or use a version manager like nvm/volta.

2. Clone and Install

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

3. Run in Development

   npm 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

npm run build

This runs scripts/build.mjs which creates:

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

Testing

# Run tests
npm test

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

Code Style

• Run npm 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.