Skip to content

Commit

Permalink
docs(README.md): update readme.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
aliftech committed Jun 28, 2024
1 parent 2dcbf97 commit 149c136
Showing 1 changed file with 60 additions and 2 deletions.
62 changes: 60 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Jin: Your Hacking CLI Toolkit

![Screenshot_21](https://github.com/aliftech/jin/assets/47414125/3842752c-18df-41b8-83d5-a7ee27597c37)
![Screenshot_23](https://github.com/aliftech/jin/assets/47414125/318b6b70-54af-4fa8-8d1a-ce3a64929bb6)

Jin is a hacking command-line tools designed to make your scan port, gathering urls, check vulnerability and sending DDOS attack to your target. This tools is made for ethical and education purpose. I recommend you not to use this tools for harmfull action.

Expand Down Expand Up @@ -69,6 +69,16 @@ python main.py scan example.com

- The `example.com` above mean the targeted website domain.

- **Naming a log file**

When you running both scan or map command, the system will automaticly store your scanning or mapping result into a log file. The filename automaticly generate by system, but now, you can naming the log file by yourself.

```bash
scan example.com -wl example_test_scan
```

The command above will generate a log file name `scan_example_test_scan.json`. The `-wl` parameter is used to renamed the logs file from the default name generate by JIN into user expected name.

### **DDOS Attack**

To launch a ddos attack to the targeted website, you can use the following command:
Expand All @@ -91,6 +101,54 @@ python main.py map https://www.example.com

- `https://www.example.com` is the targeted url.

- **Naming a log file**

When you running both scan or map command, the system will automaticly store your scanning or mapping result into a log file. The filename automaticly generate by system, but now, you can naming the log file by yourself.

```bash
map https://www.example.com -wl example_test_map
```

The command above will generate a log file name `map_example_test_map.json`. The `-wl` parameter is used to renamed the logs file from the default name generate by JIN into user expected name.

### **Logs Management**

This function is used to manage the application logs. You can list all logs file, read, and even delete the logs file.

- **List all logs**

This command is used to list all logs files.

```bash
logs -ls [scan || map]
```

If you set scan as the param -ls value, the application will shows you all of the scanning logs files. Meanwhile, if you input map as the -ls value, it will return all mapping logs files.

- **Read logs file**

This command is used to read the log content.

```bash
logs -r filename.json
```

- **Delete a single los file**

This command is used to delete a single log file.

```bash
logs -rm filename.json
```

- **Delete all logs files**

This command will help you to delete all logs files.

```bash
logs -rm all
```

## **Run JIN CLI App Using Docker**

You can also running the cli app using docker by the following command:
Expand All @@ -101,7 +159,7 @@ docker compose run jin

Then, you will see the following result.

![Screenshot_21](https://github.com/aliftech/jin/assets/47414125/3842752c-18df-41b8-83d5-a7ee27597c37)
![Screenshot_23](https://github.com/aliftech/jin/assets/47414125/318b6b70-54af-4fa8-8d1a-ce3a64929bb6)

## **Run JIN Through Docker Image**

Expand Down

0 comments on commit 149c136

Please sign in to comment.