Skip to content

Commit debcfd8

Browse files
committed
docs: add documentation of the feature
1 parent 83ff754 commit debcfd8

File tree

4 files changed

+20
-1
lines changed

4 files changed

+20
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ helping you detect vulnerabilities and misconfigurations earlier in the developm
2222
| Build and Scan Dockerfile | Supported | [Supported](./docs/features/build_and_scan.md) (0.4.0+) |
2323
| Layered image analysis | Supported | [Supported](./docs/features/layered_analysis.md) (0.5.0+) |
2424
| Docker-compose image analysis | Supported | [Supported](./docs/features/docker_compose_image_analysis.md) (0.6.0+) |
25+
| Vulnerability explanation | Supported | [Supported](./docs/features/vulnerability_explanation.md) (0.7.0+) |
2526
| K8s Manifest image analysis | Supported | In roadmap |
2627
| Infrastructure-as-code analysis | Supported | In roadmap |
27-
| Vulnerability explanation | Supported | In roadmap |
2828

2929
## Build
3030

docs/features/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,8 @@ Sysdig LSP provides tools to integrate container security checks into your devel
2121
## [Docker-compose Image Analysis](./docker_compose_image_analysis.md)
2222
- Scans the images defined in your `docker-compose.yml` files for vulnerabilities.
2323

24+
## [Vulnerability Explanation](./vulnerability_explanation.md)
25+
- Displays a detailed summary of scan results when hovering over a scanned image name.
26+
- Provides immediate feedback on vulnerabilities, severities, and available fixes.
27+
2428
See the linked documents for more details.
38.6 MB
Loading
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Vulnerability Explanation
2+
3+
Sysdig LSP provides on-demand vulnerability explanations directly in your editor. After running a scan on an image (e.g., base image, Docker Compose service), you can hover over the image name to see a detailed summary of the scan results.
4+
5+
This feature allows you to quickly assess the security posture of an image without leaving your code, displaying information such as total vulnerabilities, severity breakdown, and fixable packages in a convenient tooltip.
6+
7+
![Sysdig LSP showing a vulnerability summary on hover](./vulnerability_explanation.gif)
8+
9+
## How It Works
10+
11+
1. **Run a Scan**: Use a code action or code lens to scan an image in your `Dockerfile` or `docker-compose.yml`.
12+
2. **Hover to View**: Move your cursor over the image name you just scanned.
13+
3. **Get Instant Feedback**: A tooltip will appear with a formatted Markdown summary of the vulnerabilities found.
14+
15+
This provides immediate context, helping you decide whether to update a base image or investigate a specific package.

0 commit comments

Comments
 (0)