System Requirements
- Node.js: v18.0.0 or higher - Operating System: macOS, Linux, or
Windows - Package Manager: npm, pnpm, or yarn
Install the CLI
Verify the installation:
vulcn --version
# Output: 0.2.0
Install Browsers
Vulcn uses Playwright for browser automation. Browsers are installed automatically on first use, but you can install them manually:
# Install Chromium (default)
vulcn install
# Install specific browsers
vulcn install chromium firefox webkit
# Install all browsers
vulcn install --all
Check Your Setup
Run the doctor command to verify your environment:
Output:
🔍 Checking Vulcn environment...
✓ Node.js v20.10.0
✓ Vulcn CLI v0.2.0
✓ Chromium installed
✗ Firefox not installed
✗ WebKit not installed
Run 'vulcn install --all' to install missing browsers.
Initialize Configuration
Create a vulcn.config.yml file with default settings:
This creates a configuration file with the official plugins pre-configured:
# vulcn.config.yml
version: "1"
plugins:
- name: "@vulcn/plugin-payloads"
config:
builtin: true
- name: "@vulcn/plugin-detect-xss"
config:
detectDialogs: true
detectConsole: true
severity: high
settings:
browser: chromium
headless: true
You can run vulcn init --force to overwrite an existing configuration file.
Programmatic Usage
For programmatic usage, install the engine package:
npm install @vulcn/engine
import { Recorder, Runner, parseSession, PluginManager } from "@vulcn/engine";
// Record a session
const recording = await Recorder.start("https://example.com");
// ... user interacts ...
const session = await recording.stop();
// Run with payloads
const result = await Runner.execute(session, {
headless: true,
onFinding: (finding) => console.log("Found:", finding.title),
});
console.log(`Found ${result.findings.length} vulnerabilities`);
Uninstall
To uninstall Vulcn:
To remove Playwright browsers:
rm -rf ~/.cache/ms-playwright # Linux/macOS
Next Steps
