Skip to main content

# kater vscode install

Installs Kater's extension in each code editor that it finds on your PATH: VS Code, Cursor and Windsurf.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

It runs each editor's own command to install the extension.

The extension is `kater.kater`. VS Code installs it from the Visual Studio Marketplace, and Cursor and Windsurf install it from Open VSX.

## Examples

```bash
# Install Kater's extension in VS Code, Cursor and Windsurf, where you have them
kater vscode install
# Install the extension in VS Code with VS Code's own command
code --install-extension kater.kater
# Install the extension from a .vsix file that you have
kater vscode install --vsix ~/Downloads/kater-0.2.250.vsix
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--vsix <vsix>` | Install the extension from this .vsix file. |

</div>

It also takes `--help`.

## What it installs

- With `--vsix`, it installs that file.
- In a checkout of the Kater repository, it packages the extension from `apps/vscode-extension` and installs that `.vsix` file. This can take a minute.
- Otherwise, it installs `kater.kater` from the editor's registry: the Visual Studio Marketplace for VS Code, Open VSX for Cursor and Windsurf. When no editor can install it, the command stops and says so.

## How it finds your editors

It looks for the commands `code`, `cursor` and `windsurf` on your `PATH`. It installs the extension with each one that it finds. When it finds none, it stops. Install an editor, then run `kater vscode install` again.

## See also

- [`kater vscode`](https://kater.ai/docs/cli-reference/vscode/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Options
What it installs
How it finds your editors
See also

Kater CLI Your terminal vscode

kater vscode install

Installs Kater's extension in each code editor that it finds on your PATH: VS Code, Cursor and Windsurf.

It runs each editor’s own command to install the extension.

The extension is kater.kater. VS Code installs it from the Visual Studio Marketplace, and Cursor and Windsurf install it from Open VSX.

Examples

# Install Kater's extension in VS Code, Cursor and Windsurf, where you have them
kater vscode install
# Install the extension in VS Code with VS Code's own command
code --install-extension kater.kater
# Install the extension from a .vsix file that you have
kater vscode install --vsix ~/Downloads/kater-0.2.250.vsix

Options

Option	Description
`--vsix <vsix>`	Install the extension from this .vsix file.

It also takes --help.

What it installs

With --vsix, it installs that file.
In a checkout of the Kater repository, it packages the extension from apps/vscode-extension and installs that .vsix file. This can take a minute.
Otherwise, it installs kater.kater from the editor’s registry: the Visual Studio Marketplace for VS Code, Open VSX for Cursor and Windsurf. When no editor can install it, the command stops and says so.

How it finds your editors

It looks for the commands code, cursor and windsurf on your PATH. It installs the extension with each one that it finds. When it finds none, it stops. Install an editor, then run kater vscode install again.

See also