CalvinBackup/fuzzforge_ai
1
0
Fork 0
mirror of https://github.com/FuzzingLabs/fuzzforge_ai.git synced 2026-02-12 17:12:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): fixing workflow docs (#29)

Browse Source
This commit is contained in:
Ectario
2025-10-27 12:37:04 +01:00
committed by GitHub
parent 731927667d
commit f6cdb1ae2e
5 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
cli/README.md
View File

@@ -78,7 +78,7 @@ fuzzforge workflows list
fuzzforge workflows info security_assessment
# Submit a workflow for analysis
fuzzforge workflow security_assessment /path/to/your/code
fuzzforge workflow run security_assessment /path/to/your/code
# View findings when complete
@@ -150,24 +150,24 @@ fuzzforge workflows parameters security_assessment --no-interactive
### Workflow Execution
#### `fuzzforge workflow <workflow> <target-path>`
#### `fuzzforge workflow run <workflow> <target-path>`
Execute a security testing workflow with **automatic file upload**.
```bash
# Basic execution - CLI automatically detects local files and uploads them
fuzzforge workflow security_assessment /path/to/code
fuzzforge workflow run security_assessment /path/to/code
# With parameters
fuzzforge workflow security_assessment /path/to/binary \
fuzzforge workflow run security_assessment /path/to/binary \
--param timeout=3600 \
--param iterations=10000
# With parameter file
fuzzforge workflow security_assessment /path/to/code \
fuzzforge workflow run security_assessment /path/to/code \
--param-file my-params.json
# Wait for completion
fuzzforge workflow security_assessment /path/to/code --wait
fuzzforge workflow run security_assessment /path/to/code --wait
```
**Automatic File Upload Behavior:**

2
cli/src/fuzzforge_cli/commands/init.py
View File

@@ -141,7 +141,7 @@ FuzzForge security testing project.
fuzzforge workflows
# Submit a workflow for analysis
fuzzforge workflow <workflow-name> /path/to/target
fuzzforge workflow run <workflow-name> /path/to/target
# View findings
fuzzforge finding <run-id>

2
cli/src/fuzzforge_cli/commands/workflow_exec.py
View File

@@ -438,7 +438,7 @@ def execute_workflow(
# Suggest --live for fuzzing workflows
if not live and not wait and "fuzzing" in workflow.lower():
console.print(f"💡 Next time try: [bold cyan]fuzzforge workflow {workflow} {target_path} --live[/bold cyan] for real-time monitoring", style="dim")
console.print(f"💡 Next time try: [bold cyan]fuzzforge workflow run {workflow} {target_path} --live[/bold cyan] for real-time monitoring", style="dim")
# Start live monitoring if requested
if live:

2
cli/src/fuzzforge_cli/main.py
View File

@@ -251,7 +251,7 @@ def workflow_main():
Execute workflows and manage workflow executions
Examples:
fuzzforge workflow security_assessment ./target # Execute workflow
fuzzforge workflow run security_assessment ./target # Execute workflow
fuzzforge workflow status # Check latest status
fuzzforge workflow history # Show execution history
"""

2
test_projects/rust_fuzz_test/README.md
View File

@@ -9,7 +9,7 @@ FuzzForge security testing project.
fuzzforge workflows
# Submit a workflow for analysis
fuzzforge workflow <workflow-name> /path/to/target
fuzzforge workflow run <workflow-name> /path/to/target
# View findings
fuzzforge finding <run-id>