Skip to content

Commit

Permalink
Added workflow + appended CLI README info
Browse files Browse the repository at this point in the history
  • Loading branch information
battleoverflow committed Feb 21, 2023
1 parent b41f0c9 commit 1fee098
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/dev.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Rust

on:
push:
branches: ["dev"]
pull_request:
branches: ["dev"]

env:
CARGO_TERM_COLOR: always

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Build
run: cargo build --verbose
19 changes: 19 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Rust

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]

env:
CARGO_TERM_COLOR: always

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Build
run: cargo build --verbose
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,61 @@ use mercy::source;
fn main() {
mercy_source();
}
```

## CLI

Once the executable has been downloaded, you can run the CLI tool using the following syntax:
```bash
./mercy-cli -m <METHOD> -p <PROTOCOL> -i <STRING/FILE>
```

You can also run the help command if you need a refresher on the available arguments:
```bash
./mercy-cli -h
```

The available options are listed below:
```
-i, --input Encoded/Plaintext string for decoding/encoding (ex: IaMStr1Ng) + location of the file for hex_dump
-m, --method Chosen method for data manipulation (ex: decode)
-p, --protocol Chosen protocol for data manipulation (ex: base64)
-e, --extended View every available option within the Mercy CLI
```

### Examples

Here are some quick examples of use cases:

If you need to decode a string using the base64 protocol.
```bash
./mercy -m decode -p base64 -i <EncodedString>
```

Print host system information, such as hostname, cpu cores, etc.
```bash
./mercy -m sys -p system_info -i all
```

Take a plaintext string and encode it using MD5.
```bash
./mercy -m hash -p md5 -i <PlaintextString>
```

Print the internal IP address of your host system.
```bash
./mercy -m ip -p internal_ip
```

Quickly check if a domain is malicious.
```
./mercy -m mal -p status -i "example.com"
```

If you're stuck, you can use this option to learn every command at your disposal from [Mercy](https://github.com/azazelm3dj3d/mercy):
```bash
./mercy -e
```

0 comments on commit 1fee098

Please sign in to comment.