Skip to content

Commit

Permalink
Update README.md installation/execution instructions (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
verovaleros authored Feb 23, 2024
1 parent e0a9199 commit fc182b4
Showing 1 changed file with 36 additions and 7 deletions.
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,44 @@


HermeneisGPT is a framework to translate hacking messages from Russian to English using LLM models.
![image](https://github.com/stratosphereips/hermeneisGPT/assets/2458879/c1eac777-f760-4523-b7df-9860b62a0b07)
<img width="2379" alt="image" src="https://github.com/stratosphereips/hermeneisGPT/assets/2458879/f2d22244-e900-465a-ae0a-324d29faea38">


<details>
<summary><h2>Expand for Installation Instructions</h2></summary>
To configure and run the tool, follow the next steps:

```bash
:~$ git clone https://github.com/stratosphereips/hermeneisGPT.git
:~$
:~$ cd hermeneisGPT
:~$
:~$ python3 -m pip install -r requirements.txt
:~$
:~$ cp env_EXAMPLE .env
:~$
:~$ # Edit the .env file to add your OpenAI API Key
:~$ vim .env
```
</details>

# Installation
<details>
<summary><h2>Expand for Execution Instructions</h2></summary>

1. Install the requirements: `python3 -m pip install -r requirements.txt`
2. Create .env file with OpenAI API Key:
- `cp env_EXAMPLE .env`
- `vim .env`
5. Run the tool: `python3 hermeneisGPT.py --help`
Run hermeneisGPT help:

```bash
python3 hermeneisGPT.py --help
```

Run hermeneisGPT in manual interactive mode:

```bash
python3 hermeneisGPT.py -m manual
```

Run hermeneisGPT in automatic mode using the example SQLite DB:
```bash
python3 hermeneisGPT.py -m auto-sqlite --channel_name noname05716 --sqlite_db assets/sample.sqlite -d
```
</details>

0 comments on commit fc182b4

Please sign in to comment.