https://github.com/tenable/accurics-vscode
https://github.com/tenable/accurics-vscode
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/tenable/accurics-vscode
- Owner: tenable
- Created: 2021-06-29T12:53:58.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T06:51:02.000Z (almost 2 years ago)
- Last Synced: 2024-09-07T07:55:55.054Z (almost 2 years ago)
- Language: TypeScript
- Size: 321 KB
- Stars: 1
- Watchers: 3
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Accurics for Visual Studio Code
Accurics detects and mitigates risks in Infrastructure as Code (IAC) and reduces your attack surface before infrastructure is provisioned.
This extension seamlessly enables the scanning of your IAC files and folders through [Visual Studio Code](https://code.visualstudio.com/).
## Overview
Accurics for Visual Studio Code extension supports Terraform, Kustomize, Helm & Kubernetes YAML. It uses Accurics CLI and Terrascan for scanning the IaC files and reports violations in the output window.
Accurics Extension operates in 2 modes
1. `Standalone`: Iac scans are performed locally within the VS Code environment. Results are displayed in the output window.
2. `Integrated`: Scan results are visible in [Accurics Cloud Console](https://app.accurics.com). The Accurics Console offers rich capabilities for viewing various KPIs, Policy Violations and Drifts. It also offers seamless integration with various Developer Tools like Jira and Slack.
## Installation
Launch Visual Studio Code and search for Accurics in the Extension Marketplace Workspace. Install the extension by selecting the install option.
During the installation, Accurics Extension downloads other dependent components and configures them locally.
## Usage
### Standalone Mode
- Launch the extension and select Mode as Standalone.
- Once the mode is selected, right-mouse-click on any IAC file
- Select `Accurics Scan`. Select from the list of IaC types. Options available are `Yaml`/`Helm`/`Kustomize`/`Terraform`.
- Accurics extension performs the IaC scan and reports results in the output window of VS Code.
### Integrated Mode
Launch the extension, select mode as Integrated and do the following steps
- Create an [Accurics account](https://app.accurics.com).
- Login to the Accurics Console and create an Environment by following the steps in Environment creation wizard.
- Select Environment name and download the configuration file.
- Place the configuration file in a local folder for the extension.
- Once the config file has been downloaded, Run the `Accurics Configure` command & select the downloaded file.
- right-mouse-click on any IAC file within VS Code workspace.
- Select `Accurics Scan`.
- Select desired option from the displayed scan commands.
- Specify appropriate command options in the prompted input field, if no command options are provided then the command runs without any option.
- Commands `init`, `plan`, and `workspace` take parameters equivalent to [Terraform CLI](https://www.terraform.io/docs/commands/index.html)
- Commands `tgplan`, `tgplanall`, and `plan-all` take parameters equivalent to [Terragrunt CLI](https://terragrunt.gruntwork.io/docs/reference/cli-options/)
- Command `plan cf` takes parameters equivalent to [CloudFormation CLI](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/index.html)
The extension will perform the scan and report the results in output window as well as in [Accurics Cloud Console](https://app.accurics.com)
Currently, integrated scan is supported only for terraform file.
## Uninstallation
To remove the extension, bring up the Extensions view by clicking on the Extensions icon in the Activity Bar, select Accurics and click on Uninstall.