1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
# hex (hx)
Futuristic take on hexdump.
[hx](https://github.com/sitkevij/hex) accepts a file path as input and outputs a hexadecimal colorized view to stdout.
```sh
$ hx tests/files/alphanumeric.txt
0x000000: 0x61 0x62 0x63 0x64 0x65 0x66 0x67 0x68 0x69 0x6a abcdefghij
0x00000a: 0x6b 0x69 0x6c 0x6d 0x6e 0x6f 0x70 0x71 0x72 0x73 kilmnopqrs
0x000014: 0x74 0x75 0x76 0x77 0x78 0x79 0x7a 0x30 0x31 0x32 tuvwxyz012
0x00001e: 0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x0a 0x30 0x31 3456789.01
0x000028: 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x30 0x31 2345678901
0x000032: 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x30 0x31 2345678901
0x00003c: 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x39 23456789
bytes: 68
```
[hx](https://github.com/sitkevij/hex) also accepts stdin as input.
```sh
cat "tests/files/alphanumeric.txt" | hx
0x000000: 0x61 0x62 0x63 0x64 0x65 0x66 0x67 0x68 0x69 0x6a abcdefghij
0x00000a: 0x6b 0x69 0x6c 0x6d 0x6e 0x6f 0x70 0x71 0x72 0x73 kilmnopqrs
0x000014: 0x74 0x75 0x76 0x77 0x78 0x79 0x7a 0x30 0x31 0x32 tuvwxyz012
0x00001e: 0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x0a 0x30 0x31 3456789.01
0x000028: 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x30 0x31 2345678901
0x000032: 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x30 0x31 2345678901
0x00003c: 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x39 23456789
bytes: 68
```
[](https://travis-ci.org/sitkevij/hex)
[](https://codecov.io/gh/sitkevij/hex)
## quick links
* [install](#install)
* [features](#features)
* [manual](#manual)
* [license](#license)
## examples
### lower hex format -fx
`$ hx src/main.rs`
### binary hex format -fb
`$ hx -fb -c4 src/main.rs`
### octal hex format -fo
`$ hx -fo -c8 src/main.rs`
## install
### crates.io install
If `cargo` is already installed, simply:
```sh
cargo install hx
```
### source install
From within the `hx` source code directory, simply execute:
```sh
make install
```
This will run the following `cargo` commands:
```sh
cargo build --release
cargo test --verbose --all -- --nocapture
cargo install --path .
```
Which will compile the release version, run tests and install release binary to `<USERDIR>/.cargo/bin/hx`.
If `<USERDIR>/.cargo/bin` is part of the `PATH` environment variable, `hx` should be able to be executed anywhere in the shell.
### arch linux install
```
pacman -S hex
```
### debian install
```sh
curl -sLO https://github.com/sitkevij/hex/releases/download/v0.4.1/hx_0.4.1_amd64.deb && dpkg -i hx_0.4.1_amd64.deb
```
### docker run
```sh
cat README.md | docker run -i sitkevij/hx:latest
```
## features
### output arrays in `rust`, `c`, `golang`, `python`, `kotlin`, `java`, or `swift`
`hx` has a feature which can output the input file bytes as source code arrays.
For example:
#### rust array: -ar
```sh
$ hx -ar -c8 tests/files/tiny.txt
let ARRAY: [u8; 3] = [
0x69, 0x6c, 0x0a
];
```
#### c array: -ac
```sh
$ hx -ac -c8 tests/files/tiny.txt
unsigned char ARRAY[3] = {
0x69, 0x6c, 0x0a
};
```
#### golang array: -ag
```sh
$ hx -ag -c8 tests/files/tiny.txt
a := [3]byte{
0x69, 0x6c, 0x0a,
}
```
#### python array: -ap
```sh
$ hx -ap -c8 tests/files/tiny.txt
a = [
0x69, 0x6c, 0x0a
]
```
#### kotlin array: -ak
```sh
$ hx -ak -c8 tests/files/tiny.txt
val a = byteArrayOf(
0x69, 0x6c, 0x0a
)
```
#### java array: -aj
```sh
$ hx -aj -c8 tests/files/tiny.txt
byte[] a = new byte[]{
0x69, 0x6c, 0x0a
};
```
#### swift array: -as
```sh
$ hx -as -c8 tests/files/tiny.txt
let a: [UInt8] = [
0x69, 0x6c, 0x0a
]
```
### NO_COLOR support
`hx` will honor the NO_COLOR environment variable. If set, no color will be output to the terminal.
Rust `no_color` crate:
* <https://crates.io/crates/no_color>
* <https://github.com/sitkevij/no_color>
## manual
```txt
hx
Futuristic take on hexdump, made in Rust.
USAGE:
hx [OPTIONS] [INPUTFILE]
<stdout> | hx [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-a, --array <array_format> Set source code format output: rust (r), C (c), golang (g), python (p), kotlin (k), java (j) [possible values: r, c, g, p, k, j]
-t, --color <color> Set color tint terminal output. 0 to disable, 1 to enable [possible values: 0, 1]
-c, --cols <columns> Set column length
-f, --format <format> Set format of octet: Octal (o), LowerHex (x), UpperHex (X), Binary (b) [possible
values: o, x, X, b]
-u, --func <func_length> Set function wave length
-l, --len <len> Set <len> bytes to read
-p, --places <func_places> Set function wave output decimal places
ARGS:
<INPUTFILE> Pass file path as an argument for hex dump
```
## license
MIT
|
