Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7a3c4a7

Browse files
CrazyBoyMCrazyBoyM
committed
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
1 parent 11a0e46 commit 7a3c4a7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+12993
-316
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ assignees: ''
1515
Kode Version: <!-- kode --version -->
1616
OS: <!-- macos/win -->
1717

18-
## Models <!-- get from /config or from ~/.agentkode.json -->
18+
## Models <!-- get from /config or from ~/.kode.json -->
1919
baseURL:
2020
name:
2121
maxTokens:

‎.gitignore‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ yarn-debug.log*
99
yarn-error.log*
1010
lerna-debug.log*
1111
.pnpm-debug.log*
12+
KODE.md
1213

1314
# Caches
1415

@@ -173,8 +174,21 @@ dist
173174

174175
# Finder (MacOS) folder config
175176
.DS_Store
176-
source-maps/
177+
# Build artifacts
178+
cli.js
179+
.npmrc
180+
181+
# Lock files
182+
bun.lock
183+
bun.lockb
184+
package-lock.json
185+
yarn.lock
186+
pnpm-lock.yaml
187+
188+
# Old build artifacts
177189
cli.mjs
190+
cli.mjs.map
191+
source-maps/
178192

179193
# Claude project instructions
180194
CLAUDE.md

‎CONTRIBUTING.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing to @shareai-lab/kode
2+
3+
## Development Setup
4+
5+
1. **Install Bun**
6+
```bash
7+
curl -fsSL https://bun.sh/install | bash
8+
```
9+
10+
2. **Clone and Install**
11+
```bash
12+
git clone https://github.com/shareAI-lab/kode.git
13+
cd kode
14+
bun install
15+
```
16+
17+
3. **Run in Development**
18+
```bash
19+
bun run dev
20+
```
21+
22+
## Project Structure
23+
24+
```
25+
.
26+
├── src/ # Source code
27+
│ ├── entrypoints/ # CLI and MCP entry points
28+
│ ├── commands/ # Command implementations
29+
│ ├── components/ # React/Ink UI components
30+
│ ├── tools/ # AI tool implementations
31+
│ ├── services/ # Core services
32+
│ ├── hooks/ # React hooks
33+
│ └── utils/ # Utilities
34+
├── scripts/ # Build and utility scripts
35+
├── docs/ # Documentation
36+
├── test/ # Test files
37+
└── cli.js # Generated CLI wrapper
38+
```
39+
40+
## Building
41+
42+
```bash
43+
bun run build
44+
```
45+
46+
This runs `scripts/build.ts` which creates:
47+
- `cli.js` - Smart runtime wrapper
48+
- `.npmrc` - NPM configuration
49+
50+
## Testing
51+
52+
```bash
53+
# Run tests
54+
bun test
55+
56+
# Test CLI
57+
./cli.js --help
58+
./cli.js -p "test prompt"
59+
```
60+
61+
## Code Style
62+
63+
- Run `bun run format` before committing
64+
- TypeScript/TSX for all source files
65+
- No Chinese in code or comments
66+
- Follow existing patterns
67+
68+
## Publishing
69+
70+
See [docs/PUBLISH.md](docs/PUBLISH.md) for publishing instructions.

0 commit comments

Comments
 (0)