{"id":31816697,"url":"https://github.com/splunk/vscode-extension-splunk-soar","last_synced_at":"2025-10-11T09:57:48.737Z","repository":{"id":59699209,"uuid":"475373844","full_name":"splunk/vscode-extension-splunk-soar","owner":"splunk","description":"Visual Studio Code Extension for Splunk SOAR","archived":false,"fork":false,"pushed_at":"2023-09-27T09:40:25.000Z","size":29036,"stargazers_count":11,"open_issues_count":19,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-15T02:58:43.947Z","etag":null,"topics":["splunk-soar","vscode-extension"],"latest_commit_sha":null,"homepage":"https://splunk.github.io/vscode-extension-splunk-soar/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/splunk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-03-29T09:36:25.000Z","updated_at":"2024-03-22T00:31:32.000Z","dependencies_parsed_at":"2023-01-29T04:16:06.400Z","dependency_job_id":null,"html_url":"https://github.com/splunk/vscode-extension-splunk-soar","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/splunk/vscode-extension-splunk-soar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvscode-extension-splunk-soar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvscode-extension-splunk-soar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvscode-extension-splunk-soar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvscode-extension-splunk-soar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/splunk","download_url":"https://codeload.github.com/splunk/vscode-extension-splunk-soar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvscode-extension-splunk-soar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006749,"owners_count":26084185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["splunk-soar","vscode-extension"],"created_at":"2025-10-11T09:57:44.031Z","updated_at":"2025-10-11T09:57:48.732Z","avatar_url":"https://github.com/splunk.png","language":"TypeScript","readme":"# Splunk SOAR Extension for VS Code\n\n[![GitHub Workflow Status](https://github.com/splunk/vscode-extension-splunk-soar/actions/workflows/ci.yml/badge.svg)](https://github.com/splunk/vscode-extension-splunk-soar/actions/workflows/ci.yml)\n[![Slack](https://img.shields.io/badge/Slack-soar__app__dev-blue?logo=slack)](https://splunk-usergroups.slack.com/archives/C03FYT64AJZ)\n\n\nThe extension for developers building applications for Splunk SOAR. Works with SOAR hosted either on-prem or in Cloud and its goal is to make the app development experience as seamless and efficient as possible on the [VS Code](https://code.visualstudio.com/) editor platform.\n\nDuring setup, the extension is configured to connect to the SOAR platform. This allows the extension to pull information from SOAR and allows the developer to perform common operations such as browsing of remote objects, running actions and managing resulting action runs.\n\nThe screenshots below are taken from the [Visual Studio Code](https://github.com/microsoft/vscode) environment\nwhere the extension is installed successfully.\n\nBrowse the full [documentation](https://splunk.github.io/vscode-extension-splunk-soar/).\n\n## Features\n* Browse apps and assets configured on the connected SOAR instance via [Tree View](https://github.com/splunk/vscode-extension-splunk-soar/wiki/features#inspect-soar-objects)\n* [Apps Installation](#app-installation) via custom [SOAR App Build Task](https://github.com/splunk/vscode-extension-splunk-soar/wiki/features#app-build-task) to install a local SOAR app on the configured instance with a [single key combination](https://github.com/splunk/vscode-extension-splunk-soar/wiki/commands#installing-an-app-using-the-command-palette)\n* Integrated [Actions Execution](#run-actions) to run a given action on the configured instance\n* Integrated [Playbooks Execution](#run-playbooks) to run a given playbook on the configured instance\n* Built-in [App Wizard](https://github.com/splunk/vscode-extension-splunk-soar/wiki/features#app-wizard) to bootstrap a new local SOAR App project\n* Smart [Run Action CodeLens](https://github.com/splunk/vscode-extension-splunk-soar/wiki/features#run-action-codelens) to detect action handlers in connector code and provide an inline action command\n* Set of useful [SOAR commands](https://github.com/splunk/vscode-extension-splunk-soar/wiki/commands) aiming to\n  * Browse remote SOAR objects such as Containers, Assets, Apps\n  * Navigate to SOAR Web UI\n* Integrated [SOAR: Container Watcher Console](https://github.com/splunk/vscode-extension-splunk-soar/wiki/features#container-watcher-console) to watch containers for changes at either action or playbook execution\n\n:warning: All features are targeted towards speeding up SOAR apps development. Explicitly out-of-scope are features assisting with playbook development. For developing playbooks, the new Visual Playbook Editor (VPE) within SOAR is strongly recommended.\n\n## Getting Started\n### Installation\n\nDownload the extension via the Visual Studio Marketplace.\n\nAlternatively, download the VSIX file from the [Releases page](https://github.com/splunk/vscode-extension-splunk-soar/releases/) and use the *Extensions -\u003e Install from VSIX...* dialog within the VS Code extension panel.\n\n### Connect your environment\n\nAfter successful installation, open the Splunk SOAR view from the sidebar and press the **Connect Environment** button to set up the connection to your SOAR environment. Type info such as SOAR URL and credentials to the appearing step-by-step interactive dialog. Once the environment is set up, it will be activated automatically.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"media/connect_environment.png\" alt=\"Connect Environment\" /\u003e\n\u003c/p\u003e\n\nUse the available context menu to manage environment(s) and receive information about them. To open the context menu, right-click on the desired environment listed in the view.\n\n#### Multi-Environment Support\n\nYou can create multiple environments to quickly context-switch between remote SOAR instances, but **only a single environment can be active** at the same time. To connect another environment click the plus icon on the top right of the view\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"media/activate_environment.png\" alt=\"Connect Environment\" /\u003e\n\u003c/p\u003e\n\n## Usage\n### App Installation\n\nTo install your locally developed app to the configured SOAR instance, click on the upload icon on the top right of the apps view. You'll be prompted to select the folder containing your app bundle (`.tgz` file)\n\nIf you don't have a bundled app yet, automatically bundle and install it by following [these instructions](https://github.com/splunk/vscode-extension-splunk-soar/wiki/commands#installing-an-app-using-the-command-palette)\n\n\u003e NOTE: Your app code **must** be opened in a dedicated VSCode window to work\n\n### Run Actions\n\n* Select the action you want to run from the Apps View\n* Click on the play icon for that action\n* Provide action parameters as well as execution context info (e.g. asset, container) at request in the appearing interactive dialog\n\nOnce the operation has completed, results will be displayed in the OUTPUT terminal.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"media/actionrun.gif\" alt=\"Run an action\" /\u003e\n\u003c/p\u003e\n\n:warning:  If the app has no asset configured, an error could be thrown\n\nTo re-execute the action keeping the same parameters and context, simply click on the refresh icon for that specific action in Action Runs View.\n\n#### Run Actions: Details\n\nBy hovering over each run listed under the Action Runs View, additional contextual information can be displayed. Quick links for inspecting the elements can be clicked to open details for both the action run and the container.\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"media/actionrun_hover.png\" alt=\"Action Run Hover\" /\u003e\n\u003c/p\u003e\n\nBy right-clicking on each run users can:\n* Inspect the Action Run,\n* View the action in SOAR Web UI\n\n### Run Playbooks\n\n* Select the playbook you want to run from the Playbooks View\n* Click on the play icon for that playbook\n* Provide scope as well as execution context info (e.g. asset, container) at request in the appearing interactive dialog\n\nOnce the operation has completed, results will be displayed in the OUTPUT terminal.\n\nTo re-execute the playbook keeping the same parameters and context, simply click on the refresh icon for that specific action in Playbook Runs View.\n\nBy right-clicking on each playbook users can:\n* Inspect the playbook,\n* View the playbook code,\n* Download the playbook bundle (`tgz`),\n* Open the playbook in Visual Playbook Editor\n\n#### Run Playbooks: Details\n\nSimilarly to Actions, by hovering over each run listed under the Playbook Runs View, additional contextual information can be displayed. Quick links for inspecting the elements can be clicked to open details for both the playbook run and the container.\n\nExecution logs can be displayed by:\n* right-clicking on a run listed under the Playbook Runs View\n* clicking on \"Logs\"\n\n## Documentation\n\nThe documentation is located on https://splunk.github.io/vscode-extension-splunk-soar/ and hosted via Github Pages.\n\n## Contributing\n\nPlease review our [Contribution Guide](./CONTRIBUTING.md)\n\n\n## Support \u0026 License\n\nPlease refer to [License](LICENSE) with regards to licensing. This software is released as-is. Splunk provides no warranty and no support on this software. If you have any issues with the software, please file an issue on the repository.\n\n## Splunk Copyright Notice\n\nCopyright 2022 Splunk Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fvscode-extension-splunk-soar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplunk%2Fvscode-extension-splunk-soar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fvscode-extension-splunk-soar/lists"}