mirror of
https://github.com/FuzzingLabs/fuzzforge_ai.git
synced 2026-06-04 01:28:02 +02:00
docs: Fix workflow references and module paths for v0.7.0
Updated all documentation to reflect actual v0.7.0 workflow implementation: Workflow name changes: - Removed all references to non-existent workflows (static_analysis_scan, secret_detection_scan, infrastructure_scan, penetration_testing_scan) - Updated examples to use actual workflows (security_assessment, gitleaks_detection, trufflehog_detection, llm_secret_detection) - Deleted docs/docs/reference/workflows/static-analysis.md (described non-existent workflow) Content corrections: - Fixed workflow tool descriptions (removed incorrect Semgrep/Bandit references, documented actual SecurityAnalyzer and FileScanner modules) - Updated all workflow lists to show production-ready vs development status - Fixed all example configurations to match actual workflow parameters Module creation guide fixes: - Fixed 4 path references: backend/src/toolbox → backend/toolbox - Updated import statements in example code Files updated: - docs/index.md - workflow list, CLI example, broken tutorial links - docs/docs/tutorial/getting-started.md - workflow list, example output, tool descriptions - docs/docs/how-to/create-module.md - module paths and imports - docs/docs/how-to/mcp-integration.md - workflow examples and list - docs/docs/ai/prompts.md - workflow example - docs/docs/reference/cli-ai.md - 3 workflow references
This commit is contained in:
+14
-14
@@ -8,16 +8,13 @@ Welcome to FuzzForge, a comprehensive security analysis platform built on Tempor
|
||||
Perfect for newcomers who want to learn FuzzForge step by step.
|
||||
|
||||
- [**Getting Started**](tutorials/getting-started.md) - Complete setup from installation to first workflow
|
||||
- [**First Workflow**](tutorials/first-workflow.md) - Run your first security workflow
|
||||
- [**Building Custom Workflows**](tutorials/building-custom-workflow.md) - Create and deploy custom workflows
|
||||
|
||||
### 🛠️ **How-To Guides** - *Problem-focused solutions*
|
||||
Step-by-step guides for specific tasks and common problems.
|
||||
|
||||
- [**Installation**](how-to/installation.md) - Install FuzzForge with proper Docker setup
|
||||
- [**Docker Setup**](how-to/docker-setup.md) - Configure Docker with insecure registry (required)
|
||||
- [**Running Workflows**](how-to/running-workflows.md) - Execute different workflow types
|
||||
- [**CLI Usage**](how-to/cli-usage.md) - Command-line interface patterns
|
||||
- [**Docker Setup**](how-to/docker-setup.md) - Docker requirements and worker profiles
|
||||
- [**Create Workflow**](how-to/create-workflow.md) - Build custom security workflows
|
||||
- [**Create Module**](how-to/create-module.md) - Develop security analysis modules
|
||||
- [**API Integration**](how-to/api-integration.md) - REST API usage and integration
|
||||
- [**MCP Integration**](how-to/mcp-integration.md) - AI assistant integration setup
|
||||
- [**Troubleshooting**](how-to/troubleshooting.md) - Common issues and solutions
|
||||
@@ -59,16 +56,19 @@ Technical reference materials and specifications.
|
||||
|
||||
## 🎯 FuzzForge at a Glance
|
||||
|
||||
**6 Production Workflows:**
|
||||
- Static Analysis (Semgrep, Bandit, CodeQL)
|
||||
- Secret Detection (TruffleHog, Gitleaks, detect-secrets)
|
||||
- Infrastructure Scan (Checkov, Hadolint, Kubesec)
|
||||
- Penetration Testing (Nuclei, Nmap, SQLMap, Nikto)
|
||||
- Language Fuzzing (AFL++, libFuzzer, Cargo Fuzz)
|
||||
- Security Assessment (Comprehensive multi-tool analysis)
|
||||
**Production-Ready Workflows:**
|
||||
- Security Assessment - Regex-based analysis for secrets, SQL injection, dangerous functions
|
||||
- Gitleaks Detection - Pattern-based secret scanning
|
||||
- TruffleHog Detection - Pattern-based secret scanning
|
||||
- LLM Secret Detection - AI-powered secret detection (requires API key)
|
||||
|
||||
**Development Workflows:**
|
||||
- Atheris Fuzzing - Python fuzzing (early development)
|
||||
- Cargo Fuzzing - Rust fuzzing (early development)
|
||||
- OSS-Fuzz Campaign - OSS-Fuzz integration (heavy development)
|
||||
|
||||
**Multiple Interfaces:**
|
||||
- 💻 **CLI**: `fuzzforge runs submit static_analysis_scan /path/to/code`
|
||||
- 💻 **CLI**: `fuzzforge workflow run security_assessment /path/to/code`
|
||||
- 🐍 **Python SDK**: Programmatic workflow integration
|
||||
- 🌐 **REST API**: HTTP-based workflow management
|
||||
- 🤖 **MCP**: AI assistant integration (Claude, ChatGPT)
|
||||
|
||||
Reference in New Issue
Block a user