How to Get Support for VulnClaw: Official Channels and Troubleshooting Guide
VulnClaw offers GitHub Issues, QQ community groups, and extensive documentation in the docs/ folder for troubleshooting, bug reports, and feature requests.
When using the open-source vulnerability scanning framework from Unclecheng-li/VulnClaw, users may encounter configuration challenges or unexpected behavior during scans. The project provides multiple official channels to get support for VulnClaw, ranging from structured bug reporting on GitHub to real-time community chat. Understanding how to leverage these resources ensures you can resolve issues quickly and contribute effectively to the project.
Official Support Channels for VulnClaw
GitHub Issues for Bug Reports and Features
The primary channel for formal support is the GitHub Issues tracker. This is the appropriate venue for reporting reproducible bugs, requesting new features, or discussing architectural changes as implemented in the repository. When submitting an issue, include the output of vulnclaw doctor, your exact command syntax, and a minimal reproducible example to expedite triage.
Community QQ Groups for Real-Time Help
For informal, fast-paced assistance, VulnClaw maintains two QQ community groups as documented in the Community section of README.md:
- QQ Group 954402631: General community discussion and user support
- QQ Group 1065858551: Developer-focused channel for technical implementation questions
These groups are ideal for asking configuration questions such as "How do I configure a specific provider?" or troubleshooting why a scan appears to hang.
Documentation and Self-Service Resources
The repository contains extensive documentation covering installation, Docker deployment, and MCP toolchain configuration. Key resources include:
README.mdandREADME_EN.md: High-level overview, quick-start guides, and community contact informationCONTRIBUTING.md: Guidelines for developers building from source or submitting pull requestsdocs/DOCKER.md: Container-specific installation and troubleshooting stepsdocs/mcp-deployment.md: Instructions for deploying MCP services including fetch, memory, Chrome DevTools, and Burp integration
Step-by-Step Support Workflow
Follow this systematic approach to resolve issues efficiently when you need to get support for VulnClaw:
- Run Diagnostics: Execute
vulnclaw doctorto generate a comprehensive environment report covering Python version, required tools like nmap, LLM configuration, and MCP status. - Check Documentation: Review the relevant
docs/*.mdfile for your specific use case (e.g., Docker deployment inDOCKER.md). - Search Existing Issues: Use the GitHub issue tracker search to find similar reported problems before opening a duplicate.
- Open a New Issue: If no solution exists, create a GitHub issue including your diagnostic output and minimal reproduction steps.
- Engage the Community: For urgent issues or quick questions, post in the appropriate QQ group.
Diagnostic Commands for Faster Resolution
Use these commands to gather essential information before contacting support:
# Generate full environment report for issue triage
vulnclaw doctor
# Run scan with verbose logging to capture detailed error information
vulnclaw scan https://example.com --ports 80,443 --log-level debug
# Export current configuration for sharing with maintainers
vulnclaw config export > my_vulnclaw_cfg.yaml
# Launch web UI when CLI hangs or becomes unresponsive
vulnclaw web --port 8080
# Test with alternative provider to isolate LLM-related issues
vulnclaw config provider openai
vulnclaw config set llm.model gpt-4o-mini
When opening a GitHub issue, format your diagnostic information as follows:
### Environment
- Python: 3.12.4
- nmap: 7.94
- LLM provider: openai (model=gpt-4o-mini)
- MCP fetch: enabled
### Command that failed
vulnclaw scan https://target.example --ports 80,443
### Full traceback
<paste relevant logs here>
Key Source Files for Advanced Troubleshooting
Understanding the codebase structure helps when debugging complex issues:
vulnclaw/cli/main.py: Entry point for CLI commands; examine this when debugging command-line parsing errors or flag handling issues.vulnclaw/agent/solver.py: Core solving engine; critical when investigating "solve"-related errors or agent behavior problems.CONTRIBUTING.md: Essential for developers needing to build from source or submit pull requests.
Summary
- GitHub Issues provide the official channel for bug reports and feature requests in the Unclecheng-li/VulnClaw repository.
- QQ Groups 954402631 and 1065858551 offer real-time community support for users and developers respectively.
vulnclaw doctorgenerates essential diagnostic data that should accompany all bug reports.- Documentation in
README.md,README_EN.md, and thedocs/directory covers installation, Docker deployment, and MCP toolchain configuration. - Key source files like
vulnclaw/cli/main.pyandvulnclaw/agent/solver.pyhelp identify the root cause of CLI parsing and solving errors.
Frequently Asked Questions
Where can I report bugs in VulnClaw?
Report bugs through the GitHub Issues tracker at https://github.com/Unclecheng-li/VulnClaw/issues. Include the output of vulnclaw doctor, your exact command, and steps to reproduce the issue. This structured approach allows maintainers to triage problems efficiently using the diagnostic information from your environment.
How do I access the VulnClaw community chat?
Join one of the two QQ groups listed in the Community section of README.md: 954402631 for general user discussion or 1065858551 for developer-focused technical questions. These groups provide immediate help for configuration issues and urgent troubleshooting scenarios.
What diagnostic information should I include in a bug report?
Always include the output of vulnclaw doctor, which reports your Python version, nmap installation, LLM provider settings, and MCP status. Additionally, provide the exact command you ran, any relevant configuration exports, and debug logs generated with --log-level debug when applicable.
Where can I find Docker deployment troubleshooting steps?
Docker-specific documentation is located in docs/DOCKER.md (also accessible as DOCKER.md in the repository root). This file contains installation instructions, container configuration options, and solutions to common deployment issues. For MCP-related problems, consult docs/mcp-deployment.md.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →