mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-24 16:02:55 +08:00
docs(cli): deprecate Kilo Console
This commit is contained in:
Josh Lambert
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@kilocode/cli": patch
|
||||
---
|
||||
|
||||
Mark Kilo Console as deprecated and direct users to supported session and settings workflows.
|
||||
+1
-1
@@ -25,7 +25,7 @@
|
||||
| `kilo session` | manage sessions |
|
||||
| `kilo remote` | enable remote connection for real-time session relay |
|
||||
| `kilo daemon` | manage the local kilo daemon |
|
||||
| `kilo console` | open or stop the local Kilo Console |
|
||||
| `kilo console` | open or stop the deprecated local Kilo Console |
|
||||
| `kilo cloud` | run Cloud Agent tasks |
|
||||
| `kilo db` | database tools |
|
||||
| `kilo config` | configuration tools |
|
||||
|
||||
@@ -456,7 +456,7 @@ For tools that don't need the full plugin context, drop them in a `tool/` or `to
|
||||
|
||||
The CLI has built-in attention alerts for session completion, errors, and prompts that need input. You do not need a plugin or platform-specific notification command.
|
||||
|
||||
Enable notifications and sounds in `kilo console` under **Settings > CLI > Notifications**, or configure the `attention` section of `tui.json`. See [CLI Notifications and Sounds](/docs/code-with-ai/platforms/cli#cli-notifications-and-sounds) for configuration and custom sound overrides.
|
||||
Configure the `attention` section of `tui.json` or `tui.jsonc` to enable notifications and sounds. The former `kilo console` configuration interface is deprecated. See [CLI Notifications and Sounds](/docs/code-with-ai/platforms/cli#cli-notifications-and-sounds) for configuration and custom sound overrides.
|
||||
|
||||
### Block reads of `.env` files
|
||||
|
||||
|
||||
@@ -940,10 +940,10 @@ Options:
|
||||
## kilo console
|
||||
|
||||
```
|
||||
open or stop the local Kilo Console
|
||||
open or stop the deprecated local Kilo Console
|
||||
|
||||
Commands:
|
||||
kilo console open the local Kilo Console [default]
|
||||
kilo console open the local Kilo Console (deprecated) [default]
|
||||
kilo console stop stop the local kilo daemon
|
||||
|
||||
Options:
|
||||
|
||||
@@ -65,6 +65,10 @@ Or use npm:
|
||||
|
||||
For detailed help on every command and subcommand, see the [CLI Command Reference](/docs/code-with-ai/platforms/cli-reference).
|
||||
|
||||
{% callout type="warning" title="Kilo Console is deprecated" %}
|
||||
The `kilo console` command and its browser interface are deprecated and may be removed in a future release. Use the CLI TUI, VS Code extension, or JetBrains plugin to run sessions. Edit Kilo configuration files directly to manage settings.
|
||||
{% /callout %}
|
||||
|
||||
### Global Options
|
||||
|
||||
| Flag | Description |
|
||||
@@ -163,10 +167,10 @@ Configuration is managed through:
|
||||
|
||||
CLI attention alerts are disabled by default. Enable and configure them in either of these ways:
|
||||
|
||||
- Run `kilo console`, open your project, then go to **Settings > CLI > Notifications**.
|
||||
- Edit the TUI configuration directly. Use `~/.config/kilo/tui.jsonc` (or `tui.json`) for global settings, or `.kilo/tui.json` (or `tui.jsonc`) for project settings.
|
||||
- Edit `~/.config/kilo/tui.jsonc` (or `tui.json`) for global settings.
|
||||
- Edit `.kilo/tui.json` (or `tui.jsonc`) for project settings.
|
||||
|
||||
The Console exposes the attention, desktop notification, sound, and volume controls. The equivalent TUI configuration is:
|
||||
Use the following configuration for attention, desktop notification, sound, and volume controls:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -208,7 +212,7 @@ Supported sound names are `default`, `question`, `permission`, `error`, `done`,
|
||||
|
||||
The `attention.sound_pack` setting selects a sound pack registered by a TUI plugin. Setting an arbitrary pack name does not install or load a pack. Per-event file overrides remain the simplest way to customize sounds without a plugin.
|
||||
|
||||
There is no notification slash command or command-palette toggle. Use Kilo Console or `tui.json` / `tui.jsonc` so all attention behavior is controlled by the same configuration.
|
||||
There is no notification slash command or command-palette toggle. Use `tui.json` or `tui.jsonc` so all attention behavior is controlled by the same configuration.
|
||||
|
||||
## Slash Commands
|
||||
|
||||
|
||||
@@ -32,6 +32,10 @@ One `kilo serve` process can host several local runtime instances. Directory-key
|
||||
|
||||
## Command entry points
|
||||
|
||||
{% callout type="warning" title="Kilo Console is deprecated" %}
|
||||
The `kilo console` command and the browser interface described on this page are deprecated. They remain documented here while the implementation is still present.
|
||||
{% /callout %}
|
||||
|
||||
| Entry point | Command or caller | Runtime model |
|
||||
|---|---|---|
|
||||
| Interactive TUI | `kilo` | Attaches to local daemon when available; otherwise starts Bun worker and sends SDK-shaped requests over RPC |
|
||||
@@ -279,6 +283,8 @@ Both streams send initial `server.connected` event and heartbeat every 10 second
|
||||
|
||||
## Kilo Console
|
||||
|
||||
**Deprecated.** The Kilo Console browser interface and its `kilo console` launcher may be removed in a future release.
|
||||
|
||||
`kilo console` starts or reuses daemon, opens `/console`, and prints Console launch URL. Browser launch URL embeds daemon Basic credentials so initial request authenticates.
|
||||
|
||||
| Area | Behavior |
|
||||
|
||||
@@ -25,6 +25,10 @@ Choose the path closest to the change you are making:
|
||||
|
||||
## Repository boundaries
|
||||
|
||||
{% callout type="warning" title="Kilo Console is deprecated" %}
|
||||
References to Kilo Console and `kilo console` on the architecture pages describe a deprecated browser interface that remains in the repository for now.
|
||||
{% /callout %}
|
||||
|
||||
Architecture pages cross two repositories:
|
||||
|
||||
| Repository | Contents |
|
||||
@@ -163,7 +167,7 @@ These local surfaces live in [`Kilo-Org/kilocode`](https://github.com/Kilo-Org/k
|
||||
| Kilo CLI TUI | `packages/opencode/` | Interactive local client with daemon attach and worker-backed fallback paths |
|
||||
| `kilo run` | `packages/opencode/` | Headless prompt execution through explicit attach, daemon attach, or embedded fallback |
|
||||
| `kilo serve` | `packages/opencode/` | Local HTTP + SSE server for local clients |
|
||||
| Kilo Console | `packages/kilo-console/`{% linebreak /%}`packages/opencode/` | Browser UI served at `/console` by a started or reused local daemon |
|
||||
| Kilo Console (deprecated) | `packages/kilo-console/`{% linebreak /%}`packages/opencode/` | Deprecated browser UI served at `/console` by a started or reused local daemon |
|
||||
| VS Code extension | `packages/kilo-vscode/` | Extension host starts one shared editor-owned `kilo serve` server and routes webviews through HTTP + global SSE; SDK directory selects local runtime instance |
|
||||
| JetBrains plugin | `packages/kilo-jetbrains/` | Split-mode Swing plugin; backend module starts one editor-owned `kilo serve` server and caches workspace clients by directory |
|
||||
|
||||
@@ -189,7 +193,7 @@ These supporting packages also live in [`Kilo-Org/kilocode`](https://github.com/
|
||||
| `packages/kilo-indexing/` | Per-directory asynchronous codebase indexing engine behind Kilo CLI bridge |
|
||||
| `packages/sdk/js/` | Generated JavaScript client and handwritten wrapper for local server APIs |
|
||||
| `packages/kilo-gateway/` | Local Kilo Gateway client integration used by Kilo CLI runtime |
|
||||
| `packages/kilo-console/` | Browser UI served by local daemon at `/console` |
|
||||
| `packages/kilo-console/` | Deprecated browser UI served by local daemon at `/console` |
|
||||
|
||||
## Architecture pages
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ async function launch(url: string) {
|
||||
|
||||
const OpenCommand = cmd({
|
||||
command: "$0",
|
||||
describe: "open the local Kilo Console",
|
||||
describe: "open the local Kilo Console (deprecated)",
|
||||
builder: (yargs) =>
|
||||
withNetworkOptions(yargs).option("foreground", {
|
||||
alias: "f",
|
||||
@@ -85,7 +85,7 @@ const OpenCommand = cmd({
|
||||
|
||||
export const KiloConsoleCommand = cmd({
|
||||
command: "console",
|
||||
describe: "open or stop the local Kilo Console",
|
||||
describe: "open or stop the deprecated local Kilo Console",
|
||||
builder: (yargs: Argv) => yargs.command(OpenCommand).command(StopCommand).demandCommand(),
|
||||
handler: async () => {},
|
||||
})
|
||||
|
||||
@@ -318,7 +318,7 @@ Custom themes: place JSON files in `~/.config/kilo/themes/` or `.kilo/themes/`.
|
||||
|
||||
Toggle animations, Toggle diff wrapping, Toggle sidebar (`<leader>b`), Toggle thinking (`/thinking`), Toggle tool details, Toggle timestamps (`/timestamps`), Toggle scrollbar, Toggle header, Toggle code concealment (`<leader>h`).
|
||||
|
||||
Notification settings are managed through `kilo console` under **Settings > CLI > Notifications**, or through `attention` in `tui.json` / `tui.jsonc`. There is no notification slash command or command-palette toggle.
|
||||
Notification settings are managed through `attention` in `tui.json` / `tui.jsonc`. The `kilo console` configuration interface is deprecated. There is no notification slash command or command-palette toggle.
|
||||
|
||||
### System
|
||||
|
||||
|
||||
Reference in New Issue
Block a user