Skip to main content

Getting Started

This is the documentation for the Visual Studio Code Extension for Splunk SOAR. It is designed for Splunk SOAR App Developers that want to improve their development workflow. It is built based on our experience, building and modifying many SOAR apps.

The VS Code Extension for SOAR has several key features that help with App Development:

  • Configure connections to multiple SOAR environments from your local development environment
  • Quickly browse SOAR objects such as Containers, Assets, Apps, Action Runs, Playbook Runs from within the VS Code editing environment.
  • Upload an App in seconds from the local workstation to the connected SOAR environment using a custom build task or custom command.
  • Trigger individual App Actions and entire Playbooks and retrieve their logs and results within the VS Code Terminal windows, allowing for a tight feedback loop during development
  • Ability to bootstrap new Apps using an integrated App Wizard (experimental)

Installation​

This section will guide you on getting the extension setup in your VS Code.

Prerequisites​

The VS Code Extension for Splunk SOAR can be installed as any other extension, from the Extensions panel. You can navigate to it from your editors sidebar. Please review the Extension Marketplace Docs in case of any difficulties.

On the Extensions panel, enter "Splunk SOAR" in the search bar and press the button for installation. After installation, your editor will ask you to reload the editor window. Once the reload completes, a new Splunk SOAR extension icon should be added to your sidebar.

From Azure Marketplace​

It is also possible to trigger the installation from the Extension Listing on the Azure VS Code Marketplace. Pressing the installation button should open your VS Code editor and begin the installation process.

From Github Releases​

We publish .vsix files for pre-release versions on Github Releases. They can also be installed via a context menu on the Extensions panel. Review Install from VSIX in case of any difficulties.

What's next?​

Once you have the extension installed in your VS Code editor, it would be a great time to learn what features are available. Please start with our Basics.