Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tysmith committed Dec 21, 2023
1 parent 144b2ea commit 151a593
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,41 @@ However not all features may be available.
For additional information please check out the [wiki](https://github.com/MozillaSecurity/grizzly/wiki) or the [announcement](https://blog.mozilla.org/security/2019/07/10/grizzly/).

Quick Start
------------
-----------
Install the latest version from PyPI. For more details see [getting started](https://github.com/MozillaSecurity/grizzly/wiki/Getting-Started) on the wiki.

```python3 -m pip install grizzly-framework```
```
python3 -m pip install grizzly-framework --upgrade
```

**Fuzz** - Run the `no-op` test adapter to check everything is working.
**Fuzzing** - Run the `no-op` test adapter to check everything is working.

```python3 -m grizzly <browser-binary> no-op```
```
python3 -m grizzly <browser-binary> no-op
```

**Reduce** - [Grizzly Reduce](https://github.com/MozillaSecurity/grizzly/wiki/Grizzly-Reduce) can reduce a test case.

```python3 -m grizzly.reduce <browser-binary> <testcase>```
```
python3 -m grizzly.reduce <browser-binary> <testcase>
```

**Replay** - [Grizzly Replay](https://github.com/MozillaSecurity/grizzly/wiki/Grizzly-Replay) can replay a test case with different builds and debuggers.

```python3 -m grizzly.replay <browser-binary> <testcase>```
```
python3 -m grizzly.replay <browser-binary> <testcase>
```

[Bugzilla](https://bugzilla.mozilla.org/) is also supported by Grizzly Replay. Bugs can be replayed via a bug ID:

```
python3 -m grizzly.replay.bugzilla <browser-binary> <bug_id>
```

Questions
---------

Common questions can be found on the [Q&A](https://github.com/MozillaSecurity/grizzly/wiki/Q&A) page.
Questions can also be asked in the [#fuzzing](https://riot.im/app/#/room/#fuzzing:mozilla.org) channel.

Please be sure you are using the latest version Grizzly before reporting issues.

0 comments on commit 151a593

Please sign in to comment.