ariadne-extension-vscode

VS Code extension for Ariadne — inline security diagnostics, vulnerability panels, session metrics, and an optional “Ask Ariadne” feedback panel powered by GitHub Copilot.

This extension ships Linux x64 and Windows x64 scanner binaries under bin/ and selects the matching one when it activates. You do not need a separate scanner install.

Install

Supported hosts are Linux x64 and Windows x64.

For the data-collection release, install the packaged .vsix with Extensions: Install from VSIX.... Leave ariadne.executable at its default so the extension uses the scanner binary inside the package.

Prerequisites

Install dependencies

Open a terminal in ariadne-extension-vscode (this folder):

cd path\to\ariadne\ariadne-extension-vscode
npm install

This installs TypeScript, esbuild, ESLint, and other dev dependencies listed in package.json.

Compile the extension

npm run compile

This runs, in order:

1. npm run check-types — TypeScript type-check (tsc --noEmit)
2. npm run lint — ESLint on src/
3. node esbuild.js — bundles src/extension.ts to dist/extension.js

You must compile (or run watch mode) before launching the extension. VS Code loads ./dist/extension.js as the extension entry point.

Watch mode (optional, while developing)

Recompiles automatically when you save files:

npm run watch

This runs esbuild and TypeScript in parallel. The default Run Extension launch config uses the watch task as its pre-launch build.

Run and debug in VS Code

1. Open the ariadne-extension-vscode folder in VS Code (File → Open Folder).

2. Ensure dependencies are installed and the project has been compiled at least once (npm install, npm run compile).

3. Confirm ariadne is available:

   ariadne --help
   

4. Press F5 or go to Run and Debug → select Run Extension → click the green play button.

VS Code opens a second window titled Extension Development Host. That window loads this extension from your workspace.

5. In the Extension Development Host, open a folder containing Java source files (File → Open Folder). The extension activates on Java files and starts ariadne session in the background.

Launch configuration

The repo includes .vscode/launch.json:

• Configuration: Run Extension
• Type: extensionHost
• Pre-launch task: default build task (watch — runs esbuild + TypeScript watchers)

If F5 fails with a missing build, run npm run compile once manually, then try again.

Recommended VS Code extensions

See .vscode/extensions.json for suggested extensions (ESLint, esbuild problem matchers, etc.). VS Code may prompt you to install them when you open the folder.

Using the extension

Commands (Command Palette: Ctrl+Shift+P)

Panels

Open the Ariadne panel area in the bottom panel bar:

• ARIADNE (ACTIVE VULNERABILITIES) — current findings
• SESSION METRICS — counts and session stats

Inline squiggles and hovers appear on vulnerable lines after analysis.

Settings

Open File → Preferences → Settings and search for Ariadne, or edit settings.json:

GitHub sign-in is required to use the extension (scanning, rule scripts, and AI explanations). Explanations always use Gemini Flash via the user's Copilot allowance.

npm scripts (reference)

Troubleshooting

Check View → Output or the Debug Console in the host that runs the extension for [Ariadne Core] stderr from the Rust process.

Project structure

ariadne-extension-vscode/
├── bin/                          ← packaged scanner binaries (linux-x64, win32-x64)
├── src/
│   ├── extension.ts              ← activation entry point
│   └── modules/
│       ├── core/                 ← binary resolution
│       ├── detection/bridge/     ← IPC with scanner (spawn, messages, convert)
│       ├── presentation/         ← diagnostics, webviews, panels
│       ├── feedback/             ← Copilot "Ask Ariadne", auth, settings
│       ├── tracker/              ← status bar, session metrics, storage
│       └── rules/                ← .ariadne rule file support
├── scripts/                      ← workflow CLI tooling
├── docs/                         ← specs, plans, architecture, agent docs
├── dist/extension.js             ← built output (after compile)
├── package.json
└── .vscode/launch.json           ← F5 “Run Extension”

License

Proprietary. Users may install and run it during data collection. See LICENSE.

See also

• Full-stack quick start — see the parent repository README
• Scanner core — see the scanner core documentation for building and installing the ariadne CLI