Send Feedback
Skip to content

Install the kdb Visual Studio Code Extension

This page explains how to install the kdb VS Code Extension, and how to install a supported q runtime for local development.

Prerequisites

Before installing the extension, ensure you have:

Note

A q runtime is not required before installing the kdb VS Code extension, but executing code or connecting to local q processes requires one.

Installing the kdb VS Code Extension

  1. Open VS Code.

  2. Open the Extensions Marketplace (Ctrl+Shift+X / Cmd+Shift+X).

  3. Search for kdb or navigate directly to the extension page

  4. Click Install.

After installation, a new KX icon appears in the Activity Bar. Selecting it opens the following views:

The extension is now ready to configure and use.

Choose and install a q runtime

A q runtime is any environment that provides a q executable.

You need a q runtime to run q locally or start a REPL session. You can install a runtime such as KDB-X directly from within VS Code, or install a local q environment like kdb+ Personal Edition.

Supported q runtimes are:

Versions available

You can use both commercial and non-commercial editions with the kdb Visual Studio Code Extension. We recommend you start with the KDB-X Community Edition or kdb Insights Personal Edition.

The table below lists available editions and their functional capabilities.

Edition Write q Run q queries Explore results Shared kdb process with kdb Insights
KDB-X Community Edition yes yes yes no
kdb+ Personal Edition yes yes yes no
kdb Insights SDK Personal Edition yes yes yes no
kdb Insights Enterprise yes yes yes yes

Important

kdb Insights Enterprise requires a commercial license. Please contact licadmin@kx.com for further information.

Install KDB-X

KDB-X is the recommended local runtime for development in VS Code.

To install KDB-X through the kdb Visual Studio Code Extension, follow the instructions for installing KDB-X.

Install kdb+ Personal Edition

After registering for the kdb+ Personal Edition:

  • You will receive a download link for the installation file.
  • You will also receive a license file (k4.lic or kc.lic).
  • Follow the installation guide for Linux, macOS, or Windows to install q and a license file before proceeding.

Once installed:

  • Ensure the q executable is available on your system PATH, or
  • Configure its location in the extension settings if needed.

This enables the extension to launch local q processes.

Customized authentication

The kdb Visual Studio Code Extension supports customized authentication, allowing you to add custom logic when authenticating with kdb.

Refer to the custom authentication Wiki page for details on how to set this up.

Next steps