Skip to content

Command-Reference.md

Latest commit

 

History

History
101 lines (68 loc) · 1.89 KB

Command-Reference.md

File metadata and controls

101 lines (68 loc) · 1.89 KB

Command Reference

This document provides a comprehensive reference for all bughunter-cli commands.

Core Commands

scan

Analyzes code, dependencies, and infrastructure for security vulnerabilities.

Usage:

bughunter scan <subcommand> [options]

Subcommands:

  • code <path>: Scans a directory for code vulnerabilities.
    • --autocorrect: Automatically apply AI-generated patches.
  • dependencies <path>: Scans a dependency file (e.g., requirements.txt).
  • subdomains <domain>: Discovers subdomains for a given domain.
  • ports <ip_address>: Scans for open ports on a given IP address.

vibe

Uses a natural language interface to perform security tasks.

Usage:

bughunter vibe "<prompt>"

Examples:

bughunter vibe "Find XSS vulnerabilities in the auth module"
bughunter vibe "Explain CVE-2023-12345 in simple terms"
bughunter vibe "Generate a patch for the SQLi in userService.py"

github

Integrates with GitHub to manage security issues.

Usage:

bughunter github <subcommand> [options]

Subcommands:

  • init: Initializes the GitHub integration.
  • create-issue "<title>": Creates a new GitHub issue for a security finding.

Roadmap Commands

These commands are planned for future releases.

refactor

AI-assisted code refactoring.

Usage:

bughunter refactor <file_path> --prompt "<description>"

learn

Interactive vulnerability learning modules.

Usage:

bughunter learn "<vulnerability_name>"

forecast

Dependency impact forecasting.

Usage:

bughunter forecast <dependency_name>@<version>

config

Configuration for bughunter-cli.

Usage:

bughunter config set llm.provider <provider_name>

map

Visual vulnerability mapping.

Usage:

bughunter map vulnerabilities --output <file_path.html>