barian0517/Kode-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Kode-cli/docs/PROJECT_STRUCTURE.md
CrazyBoyM 7a3c4a7baa Refactor project structure and update documentation 
- 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
2025-08-11 21:31:18 +08:00

2.3 KiB
Raw Blame History

Kode Project Structure

Overview

Clean, modern TypeScript CLI project using Bun for development and building.

Build System

  • Runtime: Bun (preferred) with Node.js fallback
  • Build Tool: Custom build.ts using Bun
  • Package Manager: Bun (with npm publish compatibility)
  • TypeScript Execution: Direct source execution (no bundling)

Key Files

.
├── cli.js                 # Smart CLI wrapper (generated)
├── build.ts              # Build script
├── package.json          # Package configuration
├── tsconfig.json         # TypeScript configuration
├── yoga.wasm            # Required WASM file for Ink
├── .npmrc               # NPM configuration (generated)
├── .gitignore           # Git ignore rules
├── .prettierrc          # Code formatting config
│
├── src/                 # Source code
│   ├── entrypoints/
│   │   ├── cli.tsx      # Main CLI entry point
│   │   └── mcp.ts       # MCP server entry
│   ├── commands/        # Command implementations
│   ├── components/      # React/Ink components
│   ├── tools/           # AI tool implementations
│   ├── services/        # Core services
│   ├── hooks/           # React hooks
│   ├── utils/           # Utility functions
│   └── constants/       # Constants and configurations
│
├── docs/                # Documentation
│   └── custom-commands.md
│
├── scripts/             # Build and utility scripts
│   └── prepublish-check.js
│
├── test/                # Test files
│   └── customCommands.test.ts
│
├── README.md            # English documentation
├── README.zh-CN.md      # Chinese documentation
├── PUBLISH.md           # Publishing guide
├── KODE.md           # Project context (generated)
└── system-design.md     # System architecture doc (Chinese)

Build & Run

Development

bun run dev

Build

bun run build

Test CLI

./cli.js --help

Publish

npm publish --access public

Clean Architecture

  • No build artifacts in source control
  • Single lock file (bun.lock)
  • Generated files properly ignored
  • Clear separation of concerns
  • Minimal dependencies bundled