Skip to content

Commit f6cdb1a

Browse files
authored
fix(docs): fixing workflow docs (#29)
1 parent 7319276 commit f6cdb1a

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

cli/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ fuzzforge workflows list
7878
fuzzforge workflows info security_assessment
7979

8080
# Submit a workflow for analysis
81-
fuzzforge workflow security_assessment /path/to/your/code
81+
fuzzforge workflow run security_assessment /path/to/your/code
8282

8383

8484
# View findings when complete
@@ -150,24 +150,24 @@ fuzzforge workflows parameters security_assessment --no-interactive
150150

151151
### Workflow Execution
152152

153-
#### `fuzzforge workflow <workflow> <target-path>`
153+
#### `fuzzforge workflow run <workflow> <target-path>`
154154
Execute a security testing workflow with **automatic file upload**.
155155

156156
```bash
157157
# Basic execution - CLI automatically detects local files and uploads them
158-
fuzzforge workflow security_assessment /path/to/code
158+
fuzzforge workflow run security_assessment /path/to/code
159159

160160
# With parameters
161-
fuzzforge workflow security_assessment /path/to/binary \
161+
fuzzforge workflow run security_assessment /path/to/binary \
162162
--param timeout=3600 \
163163
--param iterations=10000
164164

165165
# With parameter file
166-
fuzzforge workflow security_assessment /path/to/code \
166+
fuzzforge workflow run security_assessment /path/to/code \
167167
--param-file my-params.json
168168

169169
# Wait for completion
170-
fuzzforge workflow security_assessment /path/to/code --wait
170+
fuzzforge workflow run security_assessment /path/to/code --wait
171171
```
172172

173173
**Automatic File Upload Behavior:**

cli/src/fuzzforge_cli/commands/init.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ def project(
141141
fuzzforge workflows
142142
143143
# Submit a workflow for analysis
144-
fuzzforge workflow <workflow-name> /path/to/target
144+
fuzzforge workflow run <workflow-name> /path/to/target
145145
146146
# View findings
147147
fuzzforge finding <run-id>

cli/src/fuzzforge_cli/commands/workflow_exec.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ def execute_workflow(
438438

439439
# Suggest --live for fuzzing workflows
440440
if not live and not wait and "fuzzing" in workflow.lower():
441-
console.print(f"💡 Next time try: [bold cyan]fuzzforge workflow {workflow} {target_path} --live[/bold cyan] for real-time monitoring", style="dim")
441+
console.print(f"💡 Next time try: [bold cyan]fuzzforge workflow run {workflow} {target_path} --live[/bold cyan] for real-time monitoring", style="dim")
442442

443443
# Start live monitoring if requested
444444
if live:

cli/src/fuzzforge_cli/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ def workflow_main():
251251
Execute workflows and manage workflow executions
252252
253253
Examples:
254-
fuzzforge workflow security_assessment ./target # Execute workflow
254+
fuzzforge workflow run security_assessment ./target # Execute workflow
255255
fuzzforge workflow status # Check latest status
256256
fuzzforge workflow history # Show execution history
257257
"""

test_projects/rust_fuzz_test/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ FuzzForge security testing project.
99
fuzzforge workflows
1010

1111
# Submit a workflow for analysis
12-
fuzzforge workflow <workflow-name> /path/to/target
12+
fuzzforge workflow run <workflow-name> /path/to/target
1313

1414
# View findings
1515
fuzzforge finding <run-id>

0 commit comments

Comments
 (0)