File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -86,11 +86,14 @@ uv add vortex-data
8686For browsing the structure of Vortex files, you can use the ` vx ` command-line tool.
8787
8888``` bash
89- # Install latest release
90- cargo install vortex-tui --locked
89+ # Install pre-built binary (fast, recommended)
90+ cargo binstall vortex-tui
9191
9292# Or build from source
93- cargo install --path vortex-tui --locked
93+ cargo install vortex-tui --locked
94+
95+ # Or run via Python without installing
96+ uvx --from vortex-data vx --help
9497
9598# Usage
9699vx browse < file>
Original file line number Diff line number Diff line change @@ -7,17 +7,32 @@ the terminal.
77
88::::{tab-set}
99
10+ :::{tab-item} Binstall (recommended)
11+ ``` bash
12+ cargo binstall vortex-tui
13+ ```
14+ Downloads a pre-built binary. Requires [ cargo-binstall] ( https://github.com/cargo-bins/cargo-binstall ) .
15+ :::
16+
1017:::{tab-item} pip
1118``` bash
1219pip install vortex-data
1320```
1421This also installs the Python library. See the [ Python quickstart] ( python.rst ) for library usage.
1522:::
1623
24+ :::{tab-item} uvx
25+ ``` bash
26+ uvx --from vortex-data vx --help
27+ ```
28+ Runs the CLI without installing. Requires [ uv] ( https://docs.astral.sh/uv/ ) .
29+ :::
30+
1731:::{tab-item} Cargo
1832``` bash
1933cargo install vortex-tui
2034```
35+ Builds from source. This can be slow due to the large dependency tree.
2136:::
2237
2338::::
You can’t perform that action at this time.
0 commit comments