7a3c4a7baa
- Update project branding from claude-cli to Kode - Reorganize documentation with new development guides - Add CONTRIBUTING.md and Chinese README - Remove worktree_merge command and relocate system-design.md - Update dependencies and package configuration - Improve custom commands service with better error handling - Clean up storage utilities and debug logging
1.5 KiB
1.5 KiB
Contributing to @shareai-lab/kode
Development Setup
-
Install Bun
curl -fsSL https://bun.sh/install | bash -
Clone and Install
git clone https://github.com/shareAI-lab/kode.git cd kode bun install -
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 formatbefore committing - TypeScript/TSX for all source files
- No Chinese in code or comments
- Follow existing patterns
Publishing
See docs/PUBLISH.md for publishing instructions.