Skip to content

Commit 1f2aeb9

Browse files
committed
fix(docs): align engine guidance
Document the actual CLI and Jest engine defaults and the LibAFL options we support so users do not configure the wrong backend by following stale docs.
1 parent 1cac0b8 commit 1f2aeb9

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ To use Jazzer.js in your own project follow these few simple steps:
4848
npx jazzer FuzzTarget
4949
```
5050

51-
To run with the LibAFL backend instead of the default libFuzzer backend, add
52-
`--engine=afl`.
51+
CLI fuzzing uses the LibAFL backend by default. To run with libFuzzer
52+
instead, add `--engine=libfuzzer`.
5353

5454
4. Enjoy fuzzing!
5555

docs/fuzz-settings.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,7 @@ Instead use the native Jest flag `--testNamePattern` as described above.
591591

592592
### `engine` : [string]
593593

594-
Default: "libfuzzer"
594+
Default: `"libafl"` in CLI mode, `"libfuzzer"` in Jest mode
595595

596596
Select the native fuzzing backend.
597597

@@ -612,7 +612,7 @@ npx jazzer my-fuzz-file --engine=afl
612612
}
613613
```
614614

615-
_Note:_ The LibAFL backend currently supports _fuzzing_ mode only.
615+
LibAFL supports both `fuzzing` and `regression` mode.
616616

617617
### `fuzzerOptions` : [array\<string\>]
618618

@@ -630,6 +630,7 @@ For `engine=afl`/`engine=libafl`, Jazzer.js currently supports these options:
630630
- `-max_len=<N>`
631631
- `-max_total_time=<seconds>`
632632
- `-artifact_prefix=<path-prefix>`
633+
- `-dict=<path>`
633634
- non-flag entries interpreted as corpus directories
634635

635636
Unsupported engine-specific flags are rejected with an explicit error.

0 commit comments

Comments
 (0)