Skip to content

docs: fix development setup issues and CLI build instructions #4435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chriscool wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −4
Open

docs: fix development setup issues and CLI build instructions #4435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before you begin, choose one of the following development environment options:

1. **Git** - For version control
2. **Git LFS** - For large file storage (https://git-lfs.com/) - Required for handling GIF, MP4, and other binary assets
3. **Node.js** (version [v20.19.2](https://github.com/Kilo-Org/kilocode/blob/main/.nvmrc) recommended)
3. **Node.js** (version [v20.19.2](https://github.com/Kilo-Org/kilocode/blob/main/.nvmrc) exactly - other versions may cause issues)
4. **pnpm** - Package manager (https://pnpm.io/)
5. **Visual Studio Code** - Our recommended IDE for development

Expand All @@ -22,6 +22,8 @@ Before you begin, choose one of the following development environment options:
4. **Visual Studio Code** - Our recommended IDE for development
5. **Dev Containers extension** - VSCode extension for container development

> **Note**: The devcontainer automatically provides the correct Node.js version (20.19.2)

> **Note for Windows Contributors**: If you're having issues with WSL or want a standardized development environment, we recommend using the devcontainer option. It provides the exact same environment as our Nix flake configuration but works seamlessly on Windows without WSL.

### Option 3: Nix Flake (Recommended for NixOS/Nix users)
Expand All @@ -32,6 +34,8 @@ Before you begin, choose one of the following development environment options:
4. **direnv** - For automatic environment loading
5. **Visual Studio Code** - Our recommended IDE for development

> **Note**: The Nix flake automatically provides the correct Node.js version (20.19.2)

## Getting Started

### Installation
Expand Down Expand Up @@ -254,6 +258,8 @@ These hooks help maintain code quality and consistency. If you encounter issues
2. **Webview not updating**: Try reloading the window (Developer: Reload Window)
3. **Build errors**: Make sure all dependencies are installed with `pnpm install`
4. **Ripgrep missing**: We bundle `@vscode/ripgrep`, but if that binary is missing the extension will fall back to `rg` on your `PATH` (commonly `/opt/homebrew/bin/rg` on macOS) or the path set in `RIPGREP_PATH`.
5. **Git LFS hook conflicts**: If you see "Hook already exists: pre-push", run `git lfs update --force` to resolve conflicts with existing Git hooks.
6. **Node version issues**: Ensure you're using exactly Node.js v20.19.2. Other versions may cause build or runtime issues.

### Debugging Tips

Expand Down
19 changes: 16 additions & 3 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,13 +239,13 @@ This instructs the AI to proceed without user input.

To build and run the CLI locally off your branch:

#### Build the VS Code extension
#### Build the VSCode extension

```shell
cd src
pnpm bundle
pnpm vsix
pnpm vsix:unpackged
pnpm vsix:unpacked
cd ..
```

Expand All @@ -254,7 +254,6 @@ cd ..
```shell
cd cli
pnpm install
pnpm deps:install
```

#### Build the CLI
Expand All @@ -266,6 +265,20 @@ pnpm copy:kilocode
pnpm build
```

#### Install production dependencies

```shell
pnpm deps:install
```

#### Create required .env file

The CLI requires a `.env` file in the `dist` directory:

```shell
touch dist/.env
```

#### Configure CLI settings

```shell
Expand Down