Skip to content

Commit

Permalink
add BlackArch install steps into README.md (thanks to noraj)
Browse files Browse the repository at this point in the history
add BA install steps
  • Loading branch information
oppsec authored Jan 18, 2024
2 parents 9923fe3 + 01f7d22 commit 3195a4a
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ If you're using Python 3.11+ + Arch (as me) you're probably getting errors when
<br>

### 🐳 Docker

If you want to use pinkerton in a Docker container, follow this commands:

```
Expand All @@ -53,17 +54,28 @@ If you want to use pinkerton in a Docker container, follow this commands:
<br><br>

### βš™οΈ Pre-requisites

- [Python 3](https://www.python.org/downloads/) installed on your machine.
- Install the libraries with `pip3 install -r requirements.txt`

<br><br>

### πŸŽ₯ Demo
### ⚫ BlackArch

```
pacman -Syu pinkerton
```

<br><br>

## πŸŽ₯ Demo

[![asciicast](https://asciinema.org/a/SDDtLFRPcauGY1Z5WFLcsc0dI.svg)](https://asciinema.org/a/SDDtLFRPcauGY1Z5WFLcsc0dI)

<br><br>

### ✨ Features
## ✨ Features

- Works with ProxyChains
- Fast scan
- Low RAM and CPU usage
Expand All @@ -72,15 +84,16 @@ If you want to use pinkerton in a Docker container, follow this commands:

<br><br>

### πŸ“š To-Do
## πŸ“š To-Do

- [x] Add more secrets regex pattern
- [ ] Improve JavaScript file extract function
- [ ] Improve pattern match system
- [ ] Add pass list file method

<br><br>

### πŸ”¨ Contributing
## πŸ”¨ Contributing

A quick guide of how to contribute with the project.

Expand All @@ -95,12 +108,14 @@ A quick guide of how to contribute with the project.

<br><br>

### πŸ™ Credits
## πŸ™ Credits

- [m4ll0k (SecretFinder creator)](https://github.com/m4ll0k) for the regex patterns
- [h33lit (Jubaer Alnazi)](https://github.com/h33tlit) for the regex patterns
- [zricethezav (GitLeaks creator)](https://github.com/zricethezav/gitleaks) for the regex patterns

<br><br>

### ⚠️ Warning
## ⚠️ Warning

- The developer is not responsible for any malicious use of this tool.

0 comments on commit 3195a4a

Please sign in to comment.