maphew
89 lines
2.5 KiB
Markdown
89 lines
2.5 KiB
Markdown
# Contributing to Kilo CLI
|
|
|
|
See [the Documentation for details on contributing](https://kilo.ai/docs/contributing).
|
|
|
|
## TL;DR
|
|
|
|
There are lots of ways to contribute to the project:
|
|
|
|
- **Code Contributions:** Implement new features or fix bugs
|
|
- **Documentation:** Improve existing docs or create new guides
|
|
- **Bug Reports:** Report issues you encounter
|
|
- **Feature Requests:** Suggest new features or improvements
|
|
- **Community Support:** Help other users in the community
|
|
|
|
The Kilo Community is [on Discord](https://kilo.ai/discord).
|
|
|
|
## Developing Kilo CLI
|
|
|
|
- **Requirements:** Bun 1.3+
|
|
- Install dependencies and start the dev server from the repo root:
|
|
|
|
```bash
|
|
bun install
|
|
bun dev
|
|
```
|
|
|
|
### Running against a different directory
|
|
|
|
By default, `bun dev` runs Kilo CLI in the `packages/kilo-cli` directory. To run it against a different directory or repository:
|
|
|
|
```bash
|
|
bun dev <directory>
|
|
```
|
|
|
|
To run Kilo CLI in the root of the repo itself:
|
|
|
|
```bash
|
|
bun dev .
|
|
```
|
|
|
|
### Building a "local" binary
|
|
|
|
To compile a standalone executable:
|
|
|
|
```bash
|
|
./packages/kilo-cli/script/build.ts --single
|
|
```
|
|
|
|
Then run it with:
|
|
|
|
```bash
|
|
./packages/kilo-cli/dist/kilo-cli-<platform>/bin/kilo
|
|
```
|
|
|
|
Replace `<platform>` with your platform (e.g., `darwin-arm64`, `linux-x64`).
|
|
|
|
### Understanding bun dev vs kilo
|
|
|
|
During development, `bun dev` is the local equivalent of the built `kilo` command. Both run the same CLI interface:
|
|
|
|
```bash
|
|
# Development (from project root)
|
|
bun dev --help # Show all available commands
|
|
bun dev serve # Start headless API server
|
|
bun dev web # Start server + open web interface
|
|
|
|
# Production
|
|
kilo --help # Show all available commands
|
|
kilo serve # Start headless API server
|
|
kilo web # Start server + open web interface
|
|
```
|
|
|
|
### Pull Request Expectations
|
|
|
|
- **Issue First Policy:** All PRs must reference an existing issue.
|
|
- **UI Changes:** Include screenshots or videos (before/after).
|
|
- **Logic Changes:** Explain how you verified it works.
|
|
- **PR Titles:** Follow conventional commit standards (`feat:`, `fix:`, `docs:`, etc.).
|
|
|
|
### Style Preferences
|
|
|
|
- **Functions:** Keep logic within a single function unless breaking it out adds clear reuse.
|
|
- **Destructuring:** Avoid unnecessary destructuring.
|
|
- **Control flow:** Avoid `else` statements; prefer early returns.
|
|
- **Types:** Avoid `any`.
|
|
- **Variables:** Prefer `const`.
|
|
- **Naming:** Concise single-word identifiers when descriptive.
|
|
- **Runtime APIs:** Use Bun helpers (e.g., `Bun.file()`).
|