Skip to content

Commit 0125b8a

Browse files
pwnwriterpwnwriter
authored
feat(demonstration): demos for the latest releases
1 parent c5d1611 commit 0125b8a

File tree

1 file changed

+101
-72
lines changed

1 file changed

+101
-72
lines changed

‎README.md

+101-72
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<img src="https://raw.githubusercontent.com/pwnwriter/haylxon/showcase/hxn-transparent.png" width="240" align="right">
22

33
# [`Haylxon`](https://github.com/pwnwriter/haylxon) 🔥🦀
4-
`SHOOT BEFORE THE BLINK` || [`Haylxon`](https://github.com/pwnwriter/haylxon/),&nbsp; A tool embodying the [`K1SS`](https://en.wikipedia.org/wiki/KISS_principle) philosophy that allows you to take screenshots of `webpages/URLs` at lightning-fast speeds.
4+
`SHOOT BEFORE THE BLINK` || [`Haylxon`](https://github.com/pwnwriter/haylxon/),&nbsp; A tool embodying the [`K1SS`](https://en.wikipedia.org/wiki/KISS_principle) philosophy that allows you to take screenshots of `webpages/URLs` at lightning-fast speeds using `chromes` [`Headless`](https://en.wikipedia.org/wiki/Headless) feature, means, you'd be needing a [***`chromium based browser`***](https://en.wikipedia.org/wiki/Chromium_(web_browser)) for it to work.
55

66
Built from the ground up for ease of use, performance, beautiful ui and portability in mind. 💖
77

@@ -25,7 +25,7 @@ Built from the ground up for ease of use, performance, beautiful ui and portabil
2525
* [`Benchmarking`](#benchmarking)
2626
* [`Contribution`](#contribution)
2727
* [`License`](#license)
28-
* [`Thanks`](#thanks)
28+
* [`Also see`](#see)
2929

3030
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)
3131

@@ -39,90 +39,130 @@ Built from the ground up for ease of use, performance, beautiful ui and portabil
3939

4040
<a name="installation"></a>
4141
## Installation 📩
42-
43-
- **Binary**:
44-
You can directly download [`binary`](https://github.com/pwnwriter/haylxon/releases/) and run it.
42+
43+
<details> <summary><code>🪄 Binary </code></summary>
44+
&nbsp;
4545

46-
- **Source**: `Recommended ++++`
46+
- You can directly download the [**binary**](https://github.com/pwnwriter/haylxon/releases) of your arch and run it.
47+
48+
</details>
49+
<details> <summary><code>🌼 Source </code></summary>
50+
&nbsp;
4751

48-
> **Note**
49-
> To receive the most up-to-date updates, please utilize this method. I will only push updates through an alternative method if and only when I have stable code.
50-
51-
```bash
52-
$ git clone --depth=1 https://github.com/pwnwriter/haylxon --branch=main
53-
$ cd haylxon
54-
$ cargo build --release
52+
```bash
53+
git clone --depth=1 https://github.com/pwnwriter/haylxon --branch=main
54+
cd haylxon
55+
cargo build --release
5556
```
56-
Then go to `release` dir and `./hxn` or move the `binary` to your any `$PATH` for instant access from anywhere.
57+
Then go to `release` dir and `./haylxon` or move the `binary` to your any `$PATH` for instant access from anywhere.
58+
</details>
5759

58-
59-
- **Cargo**:
60+
<details> <summary><code>🎠 Cargo </code></summary>
61+
62+
- Using [crates.io](https://crates.io/crates/haylxon)
6063
```bash
61-
$ cargo install hxn
64+
cargo install haylxon
6265
```
63-
> **Note**
64-
> This requires a working setup of rust/cargo.
65-
66-
- **Aur**:
66+
- Using [binstall](https://github.com/cargo-bins/cargo-binstall)
6767
```bash
68-
$ paru/yay -Syyy haylxon
68+
cargo binstall haylxon
6969
```
70+
71+
> **Note** ⚠️
72+
> This requires a working setup of rust/cargo & binstall.
73+
</details>
74+
75+
<details> <summary><code>🚩 METIS Linux </code></summary>
76+
&nbsp;
7077

71-
- **[Metis Linux](https://metislinux.org)**:
72-
```
73-
$ sudo/doas pacman -Syyy hxn
78+
```bash
79+
sudo/doas pacman -Syyy haylxon
7480
```
81+
82+
</details>
83+
7584
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)
7685

7786

7887
<a name="action"></a>
7988
## Hxn in action 🚀
80-
- Help menu :
81-
[`Hxn`](https://github.com/pwnwriter/haylxon) utilizes [`clap`](https://docs.rs/clap/latest/clap/) for argument parsing. As expected, `clap` provides a much-improved help menu. The screenshot below shows Hxn's help menu when the `-h` flag is used.
82-
83-
> use `--help` for full menu.
84-
85-
![](https://raw.githubusercontent.com/pwnwriter/haylxon/showcase/v0.1.2/help.png)
86-
87-
- Taking screenshots of one/many urls.🖇️
89+
90+
- <details> <summary><code> Taking screenshots of one/many urls.🖇️ </code></summary>
91+
8892

89-
**It doesn't matter**, if you are parsing a `single url` or a `file` containing a list of `urls`, [`Hxn`](https://github.com/pwnwriter/haylxon) will handle itself. You don't need to worry about other flags.
93+
- single url
9094

91-
`v0.1.2 +` has an option to define `browser binary` [`#pr`](https://github.com/pwnwriter/haylxon/pull/8), by default it uses `/usr/bin/chrome`.
95+
&nbsp;
96+
***I'm using brave browser for all the demonstration. You can use any chromium based browsers.***
97+
98+
```bash
99+
hxn -b $(which brave) -u https://example.com
100+
```
101+
![single](https://github.com/pwnwriter/haylxon/assets/90331517/6b6460f8-72dd-4197-b43f-f283a2c49727)
102+
103+
- a file containing multiple urls
104+
105+
&nbsp;
106+
107+
```bash
108+
hxn -b $(which brave) -u urls.txt
109+
```
110+
111+
![many](https://github.com/pwnwriter/haylxon/assets/90331517/86f987d9-0961-4247-841e-18aee6aaf53f)
112+
113+
</details>
114+
115+
116+
- <details> <summary><code> Silent option for automation ⚙️ </code></summary>
117+
&nbsp;
92118

93-
- **Single URL**
94119
```bash
95-
$ hxn -b $(which <browserbin>) -u <url>
120+
hxn -b $(which brave) -u https://example.com --silent
96121
```
97-
98-
![](https://raw.githubusercontent.com/pwnwriter/haylxon/showcase/v0.1.2/single.png)
99-
100-
- **File containing more than one url**. 🖇️
122+
123+
![silent](https://github.com/pwnwriter/haylxon/assets/90331517/80e9f15f-9087-4b9f-a1d6-3e631e795b9d)
124+
125+
</details>
126+
127+
- <details> <summary><code> Read urls from stdin ⚓ </code></summary>
128+
&nbsp;
129+
101130
```bash
102-
$ hxn -b <browserbin> -t <no. of tabs to open //ly> -u <url/filename> -o <outdir(default hxnshots)>
131+
cat urls.txt | hxn -b $(which brave) --stdin
103132
```
104-
105-
![](https://raw.githubusercontent.com/pwnwriter/haylxon/showcase/v0.1.2/many.png)
106-
107-
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png)
133+
134+
![stdin](https://github.com/pwnwriter/haylxon/assets/90331517/db5b8542-af54-420a-8478-7bef4ef6fe0c)
108135

109-
- **Define x/y** 🐣
110-
The latest release has an option to set `height`, `width` and `--silent` option.
111-
136+
137+
</details>
138+
139+
- <details> <summary><code> Define x/y dimentions 🐀 </code></summary>
140+
&nbsp;
141+
112142
```bash
113-
$ hxn --height <height> --width <widht> --silent -url <url>
143+
cat urls.txt | hxn -b $(which brave) -x 144 -y 400 --stdin
114144
```
115-
116-
![](https://raw.githubusercontent.com/pwnwriter/haylxon/showcase/v0.1.2/feature.png)
145+
146+
![dimention](https://github.com/pwnwriter/haylxon/assets/90331517/c436100e-d647-40b2-9987-f52f81e09490)
147+
148+
149+
</details>
150+
151+
- <details> <summary><code> Help pls 🐤 </code></summary>
152+
&nbsp;
153+
154+
If your internet is slow, you may need to increase the timeout value for 'hxn' to work properly
117155

118-
- **Read urls from stdin**. ✂️
119-
You can use `--stdin` flag and read urls from stdin as well.
120156
```bash
121-
$ cat urls.txt | hxn -b $(which brave) --stdin --silent
157+
cat urls.txt | hxn -b $(which brave) --timeout 60
122158
```
123159

124-
![](https://raw.githubusercontent.com/pwnwriter/haylxon/showcase/v0.1.2/stdin.png)
125-
160+
![timeout_error](https://github.com/pwnwriter/haylxon/assets/90331517/96f69d9a-cfca-4af9-9987-4f336099f3f8)
161+
162+
163+
164+
</details>
165+
126166

127167
<a name="benchmarking"></a>
128168
## Benchmarking ⚡
@@ -134,7 +174,7 @@ Built from the ground up for ease of use, performance, beautiful ui and portabil
134174

135175

136176
<a name="contribution"></a>
137-
## Contribution 🥰
177+
## Contribution 🤝
138178
There is always scope for improvements and bugs to be fixed as contributors can make a valuable impact by addressing improvements and bugs through [**issue**](https://github.com/pwnwriter/haylxon/issues) submissions or [**pull requests**](https://github.com/pwnwriter/haylxon/pulls).
139179

140180
- Still, here are the ways to contribute,
@@ -147,23 +187,12 @@ Built from the ground up for ease of use, performance, beautiful ui and portabil
147187
<a name="license"></a>
148188
## License 🔐
149189
As always, this project is also Licensed under the [**`MIT LICENSE`**](/LICENSE)
150-
151-
<a name="thanks"></a>
152-
## Thanks 🌹
153-
A big thanks to the followings.
154-
- [`@rustlang`](https://rustlang.org)
155-
- [`@prabuddha`](https://www.facebook.com/PrabuddhaMP4)
156-
- [`@Dylan Arps`](https://github.com/dylanaraps)
157-
- [`@catppuccin`](https://github.com/catppuccin)
158-
- [`@cute-ducky`](https://github.com/Cute-Ducky) // plan9boys.
159-
- [`@blast`](https://github.com/joshua-mo-143)
160-
- and [**you**](https://github.com/pwnwriter/haylxon/graphs/contributors) ❤️‍🩹
161-
162190

163-
## Also see 👀
191+
<a name="see"></a>
192+
## Also see 👀
164193
- [`Kanha`](https://github.com/pwnwriter/kanha) :- A web-app pentesting suite written in rust 🦀
165194
- [`gowitness`](https://github.com/sensepost/gowitness) :- A golang, web screenshot utility using Chrome Headless
166195

167196
<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /></p>
168-
<p align="center">Copyright &copy; 2023<a href="https://pwnwriter.xyz" target="_blank"> pwnwriter xyz ☘️ </a>
197+
<p align="center">Copyright &copy; 2023<a href="https://pwnwriter.xyz" target="_blank"> pwnwriter xyz </a> ☘️</p>
169198

0 commit comments

Comments
 (0)