VS Code Plugin

Manage your project tasks natively without ever leaving your editor.

←Back to VS Code Plugin feature page

The Kanbus VS Code extension brings the powerful Kanban board directly into your editor as a webview tab. This allows you to view and interact with your tasks completely in context with the code you are writing.

Installation

You can install the extension directly from the VS Code Marketplace. Search for "Kanbus Board" (publisher: "kanbus").

The extension comes bundled with the kbsc background server binary, so there is no separate server installation required.

Usage

To start using the extension, your workspace must already contain an initialized Kanbus project (i.e. a .kanbus.yml file). Once initialized:

  1. Open the workspace containing your Kanbus project in VS Code.
  2. Open the Command Palette (Cmd+Shift+P on Mac, Ctrl+Shift+P on Windows/Linux).
  3. Search for and run: Kanbus: Open Board.
  4. A new VS Code tab will open showing your Kanban board, which updates in real-time if you use the Kanbus CLI externally.

Configuration

The extension handles most things automatically, but you can configure the internal port used by the bundled server if you have conflicts.

  • kanbus.port: Sets the internal server port. The default is 0, which tells the extension to automatically select a free port.