You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-2Lines changed: 19 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -196,9 +196,26 @@ Vortex to model more complex arrays while still exposing a logical interface. Fo
196
196
`ChunkedArray` where the first chunk is run-length encoded and the second chunk is dictionary encoded.
197
197
In Arrow, `RunLengthArray` and `DictionaryArray` are separate incompatible types, and so cannot be combined in this way.
198
198
199
-
## Usage
199
+
## vx - Vortex's built-in file investigation tool
200
200
201
-
For best performance we recommend using [MiMalloc](https://github.com/microsoft/mimalloc) as the application's
201
+
Vortex has its own TUI-based tool called `vx` that can be used to investigate a file's structure. It can show a file's layout, compressions, columns statistics and chunking.
202
+
We keep adding new capabilities and features to it all the time because we use it ourselves during development!
203
+
204
+
In order to install `vx`, you need to have `cargo` install and then you can just the following command to get the latest release
205
+
206
+
```bash
207
+
cargo install vortex-tui --locked
208
+
```
209
+
210
+
If you want to build it from source, you can pull this repo and run
211
+
212
+
```bash
213
+
cargo install --path vortex-tui --locked
214
+
```
215
+
216
+
## Performance Tips
217
+
218
+
For the best performance, we recommend using [MiMalloc](https://github.com/microsoft/mimalloc) as the application's
0 commit comments