Skip to main content

​
Usage

vulcn plugin <command> [options]

​
Commands

CommandDescription
listList configured plugins
add <name>Add a plugin to configuration
remove <name>Remove a plugin from configuration
enable <name>Enable a disabled plugin
disable <name>Disable a plugin without removing it

​
vulcn plugin list

List all plugins configured in vulcn.config.yml: 
vulcn plugin list
Output: 
📦 Configured Plugins

  ✓ @vulcn/plugin-payloads
      builtin: true
  ✓ @vulcn/plugin-detect-xss
      detectDialogs: true
      detectConsole: true
      severity: "high"
  (disabled) @vulcn/plugin-detect-reflection
      enabled: false

​
vulcn plugin add

Add a plugin to your configuration: 
vulcn plugin add <name> [options]

​
Options

OptionDescription
-c, --config <json>Plugin configuration as JSON

​
Examples

# Add a plugin with default config
vulcn plugin add @vulcn/plugin-detect-reflection

# Add with custom config
vulcn plugin add @vulcn/plugin-detect-sqli --config '{"severity":"critical"}'

​
vulcn plugin remove

Remove a plugin from your configuration: 
vulcn plugin remove <name>
Example: 
vulcn plugin remove @vulcn/plugin-detect-reflection

​
vulcn plugin enable

Re-enable a disabled plugin: 
vulcn plugin enable <name>
Example: 
vulcn plugin enable @vulcn/plugin-detect-xss

​
vulcn plugin disable

Disable a plugin without removing it: 
vulcn plugin disable <name>
Example: 
vulcn plugin disable @vulcn/plugin-detect-xss
Disabling is useful when you want to temporarily turn off a plugin without losing its configuration.

​
Configuration File

The vulcn plugin commands modify your vulcn.config.yml file: 
# 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

  - name: "@vulcn/plugin-detect-reflection"
    enabled: false # Disabled plugin

​
Official Plugins

PluginDescription
@vulcn/plugin-payloadsPayload loading (built-in, PayloadBox, custom files)
@vulcn/plugin-detect-xssExecution-based XSS detection (dialogs, console)
@vulcn/plugin-detect-reflectionPattern-based reflection detection

Learn more about plugins

See the complete plugin documentation