Karate for VS CodeKarate is an open-source test-automation framework. This extension is brought to you by Karate Labs. Find it at the Visual Studio Marketplace or Open VSX Registry. Ready To RunNo extra installation or setup is required. Everything needed to write and run Karate scripts is included. PLUS and PROTo run tests you require at least a PLUS subscription. A PRO level gives you a lot more, including debug support. Refer to the documentation below on how to sign-in. Pricing information can be found on our website. If you need more information, please Contact us. PLUS Features
PRO Features
How to Sign InUse the "Accounts" toolbar in VS Code (usually on the bottom left, see screenshot below). If you don't see the option to
Once signed-in, you will not be prompted again for 30 days. New subscribers will be taken through a purchase flow. You can manage your subscription at studio.karatelabs.io. See a 30 second video here. Editing ClasspathTo add custom JAR files to the runtime (in default "bundled" run mode), you can follow these instructions. This is needed if you want to use Karate Robot for Windows desktop automation. Using a specific Karate versionFor convenience, the Karate Visual Studio Code extension embeds the latest version of Karate (in default "bundled" run mode). Teams maintaining large test-suites using advanced features may want to "lock-down" the version of Karate used, which is important when collaborating within a team and running tests in Continuous Integration. Refer to this wiki page for more: Run Mode - Custom. Maven or GradleYou should change extension settings to switch the run more to "maven" or "custom". Maven should just work without needing to tweak the default command-line settings. For Gradle and custom needs, refer to this wiki page for more: Run Mode - Custom. Command LineOnce you are familiar with Karate and have created a few tests, you may want to run them from the command-line. You have two options:
K-FlowK-Flow is an enterprise solution that solves for API documentation, with a focus on end-user workflows. The highlights are:
K-Flow is a separate upgrade from Karate Pro. For more details on pricing and features, refer to our website. Debug
See a 1 minute video here. If you are using Maven or Gradle, refer to the instructions here to set up your project for debugging: Debug Server.
Code Folding![]() JSON Formatting![]() Run ModeEasily switch run-mode. ![]() Run OptionsEasily edit Karate run-options. ![]() Context Menu
![]() Postman Import![]() OpenAPI Import
See video here. cURL and HAR Import
![]() Inline ReportsView summary and Feature / Scenario reports without leaving your IDE. This is especially useful when using a remote development environment such as GitHub Codespaces. ![]() Watch this video to get a feel of the enhanced Developer-Experience. You can also see all HTTP calls made during a test. ![]() Launch ConfigurationsIn "Pro" mode, the plugin supports VS Code launch configurations in the
The advantage is that you can set up any combination of Karate runtime options via
Now you can run tests from the Run and Debug view in VS Code and keyboard short-cuts such as You can have multiple configurations and easily switch between them. You can add Instead of |