Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #402

Merged
merged 1 commit into from
Dec 21, 2023
Merged

Update README.md #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions README.md
View file
Open in desktop
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.
Loading