kilocode/README.md at kilo-v2

mirror of https://github.com/Kilo-Org/kilocode.git synced 2026-10-12 23:37:27 +08:00

Files

T

Fabio Pliger d744ece922 fix(kilo): satisfy Effect simplification lint

Replace Effect.catch(() => Effect.succeed(x)) with Effect.orElseSucceed and
Effect.catch(() => Effect.fail(e)) with Effect.mapError in kilo-gateway and
kilo-cli, matching the CI effect-simplification rules.

The scan runs over all packages on every PR, so any commit to this branch failed
the lint step until these ten sites were rewritten. Behavior is unchanged:
orElseSucceed and mapError are the idiomatic equivalents for constant recovery
and error transformation.

2026-09-23 14:23:12 -05:00

4.6 KiB

Raw Permalink Blame History

The open source AI coding agent — Kilo on OpenCode v2.

Kilo · Discord · X · Reddit

Important

This branch is a development preview, not the released Kilo product or an in-place v1 upgrade. It preserves the original Kilo interface while migrating the runtime to v2. The preview uses separate kilo2 storage; imports are explicit. Existing v1 data is not migrated automatically.

Installation

Use Bun 1.4 or newer. From this checkout, install dependencies, then choose the CLI or VS Code workflow below. A fresh dependency installation and all platforms have not yet completed release validation. Published npm packages and Marketplace releases do not install this branch.

bun install

CLI

Open the interactive Kilo CLI. Arguments can specify a project directory, for example bun run dev /path/to/project.

bun run dev

VS Code

Build and open the original Kilo extension in an isolated VS Code development profile. Install VS Code locally and put code on PATH, or set VSCODE_BIN. The extension starts its local server automatically. The extension port is still incomplete.

bun run extension

Agents

Code implements changes. Plan investigates, challenges assumptions, saves a plan, and offers an implementation handoff. Ask answers without editing files. Debug investigates problems. Custom agents remain configurable. Names describe behavior; available tools and permissions depend on configuration.

What it does

Implemented slices include native conversations, tools and permissions, Gateway model/account integration, settings, memory, indexing, sandbox integration, and terminal adapters. Full original VS Code parity, JetBrains, autocomplete/FIM, speech, and some cloud workflows remain unfinished. Sharing, remote-service deployment checks, signing, and cross-platform distribution still have open gates. Source presence is not end-to-end acceptance.

Documentation

Start with the migration plan and test plans for this branch's status. The general Kilo documentation describes the released product and may differ from this preview.

Developer overview — repository layout, core concepts, execution flows, builds, upstream dependencies, and CI gates.
Migration progress (#13750)
Migration tracking
- Kilo v2
- Runtime / UI
Kilo

Contributing

Contributions are welcome. Read the contributing guide and v2 fork conventions before changing shared code. Keep Kilo behavior in owned packages where possible; verify affected packages and preserve upstream attribution.

License

MIT

FAQ

Where did Kilo CLI come from?

Kilo CLI is a fork of OpenCode, enhanced to work within the Kilo agentic engineering platform.

4.6 KiB Raw Permalink Blame History