Documentation Grafana k6 Set up Configure your code editor

Configure your code editor

IntelliSense refers to code editing features like intelligent code completion and quick access to documentation. These features can significantly improve the developer experience and productivity when working on k6 scripts in your editor of choice. Notable features are:

• Auto-completion of k6 functions, methods, and classes.
• Auto imports of k6 modules.
• Access to k6 documentation when writing and hovering code.

Install k6 type definitions

k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.

In Visual Studio Code and IntelliJ IDEA Ultimate, you can configure IntelliSense to recognize the k6 JavaScript API by installing the k6 Types with a package manager.

bash Copy

# create a `package.json` file
$ npm init --yes

# install the k6 types as dev dependency
$ npm install --save-dev @types/k6

Code editor extensions

You can also find k6 code editor extensions for Visual Studio Code and IntelliJ IDEA:

• Visual Studio Code - k6 Extension
• IntelliJ IDEA - k6 Plugin

Next steps

Now that you have k6 configured in your code editor, you can:

• Head over to Running k6 to learn how to create and run your first test.
• Configure your editor for TypeScript support.