@harry-kp/vortix 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +25 -6
- package/npm-shrinkwrap.json +2 -2
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.1.5] - 2026-02-16
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
- Address PR review feedback for bug report feature
|
|
15
|
+
|
|
16
|
+
### Documentation
|
|
17
|
+
|
|
18
|
+
- Add roadmap and feature voting links to README
|
|
19
|
+
- Add vortix report and Nix installation to README
|
|
20
|
+
- Rearrange badges, add Nix flake and npm downloads badges
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
- Add `vortix report` bug report command
|
|
25
|
+
|
|
26
|
+
### Miscellaneous
|
|
27
|
+
|
|
28
|
+
- **deps:** Bump the rust-minor group with 2 updates ([#40](https://github.com/Harry-kp/vortix/pull/40))
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
10
32
|
## [0.1.4] - 2026-02-12
|
|
11
33
|
|
|
12
34
|
### Documentation
|
package/README.md
CHANGED
|
@@ -1,17 +1,19 @@
|
|
|
1
1
|
# Vortix
|
|
2
2
|
|
|
3
|
-
[](https://crates.io/crates/vortix)
|
|
4
|
-
[](https://crates.io/crates/vortix)
|
|
5
3
|
[](https://github.com/Harry-kp/vortix/actions/workflows/ci.yml)
|
|
6
4
|
[](LICENSE)
|
|
5
|
+
[](CONTRIBUTING.md)
|
|
6
|
+
[](https://crates.io/crates/vortix)
|
|
7
|
+
[](https://crates.io/crates/vortix)
|
|
8
|
+
[](https://www.npmjs.com/package/@harry-kp/vortix)
|
|
9
|
+
[](https://www.npmjs.com/package/@harry-kp/vortix)
|
|
10
|
+
[](https://github.com/Harry-kp/homebrew-tap)
|
|
11
|
+
[](https://github.com/Harry-kp/vortix#installation)
|
|
7
12
|
[](https://github.com/Harry-kp/vortix)
|
|
8
13
|
[](https://github.com/Harry-kp/vortix)
|
|
9
14
|
[](https://www.rust-lang.org/)
|
|
10
|
-
[](https://github.com/sponsors/Harry-kp)
|
|
11
|
-
[](https://github.com/Harry-kp/homebrew-tap)
|
|
12
|
-
[](https://www.npmjs.com/package/@harry-kp/vortix)
|
|
13
|
-
[](CONTRIBUTING.md)
|
|
14
15
|
[](https://github.com/Harry-kp/vortix)
|
|
16
|
+
[](https://github.com/sponsors/Harry-kp)
|
|
15
17
|
|
|
16
18
|
Terminal UI for WireGuard and OpenVPN with real-time telemetry and leak guarding.
|
|
17
19
|
|
|
@@ -118,6 +120,12 @@ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Harry-kp/vortix/release
|
|
|
118
120
|
|
|
119
121
|
Download the `x86_64-unknown-linux-musl` release from the [releases page](https://github.com/Harry-kp/vortix/releases). This is a statically linked binary (no glibc needed), but you still need the runtime dependencies above (curl, openvpn/wireguard-tools, etc.).
|
|
120
122
|
|
|
123
|
+
**Nix (flakes):**
|
|
124
|
+
```bash
|
|
125
|
+
nix run github:Harry-kp/vortix # Run without installing
|
|
126
|
+
nix profile install github:Harry-kp/vortix # Install to profile
|
|
127
|
+
```
|
|
128
|
+
|
|
121
129
|
**From source:**
|
|
122
130
|
```bash
|
|
123
131
|
git clone https://github.com/Harry-kp/vortix.git
|
|
@@ -143,6 +151,7 @@ After this, `sudo vortix` works as expected.
|
|
|
143
151
|
- `pacman -S vortix` (Arch) — **no**, installs to `/usr/bin/`
|
|
144
152
|
- `brew install` (Homebrew) — **no**, installs to Homebrew prefix
|
|
145
153
|
- `npm install -g` (npm) — **no**, installs to npm global bin
|
|
154
|
+
- Nix (`nix profile install`) — **no**, installs to Nix profile bin
|
|
146
155
|
- macOS — **no**, sudo preserves user PATH
|
|
147
156
|
|
|
148
157
|
## Usage
|
|
@@ -152,6 +161,7 @@ sudo vortix # Launch TUI (requires root for VPN operations)
|
|
|
152
161
|
vortix import <file> # Import a .conf or .ovpn profile
|
|
153
162
|
vortix info # Show config directory and version
|
|
154
163
|
vortix update # Self-update to latest release
|
|
164
|
+
vortix report # Generate a bug report with system diagnostics
|
|
155
165
|
```
|
|
156
166
|
|
|
157
167
|
### Keybindings
|
|
@@ -326,6 +336,10 @@ If config files are owned by root, fix ownership:
|
|
|
326
336
|
sudo chown -R $(whoami) ~/.config/vortix/
|
|
327
337
|
```
|
|
328
338
|
|
|
339
|
+
## Roadmap
|
|
340
|
+
|
|
341
|
+
See the [project board](https://github.com/users/Harry-kp/projects/6) for what's being explored. Have an idea? [Join the discussion](https://github.com/Harry-kp/vortix/discussions/34).
|
|
342
|
+
|
|
329
343
|
## Development
|
|
330
344
|
|
|
331
345
|
```bash
|
|
@@ -334,6 +348,11 @@ cargo test # Run unit/integration tests
|
|
|
334
348
|
cargo clippy # Enforce code quality (Fail-fast via pre-commit)
|
|
335
349
|
```
|
|
336
350
|
|
|
351
|
+
**Nix users** can enter a development shell with all Rust tooling pre-configured:
|
|
352
|
+
```bash
|
|
353
|
+
nix develop
|
|
354
|
+
```
|
|
355
|
+
|
|
337
356
|
## Featured In
|
|
338
357
|
|
|
339
358
|
- [Terminal Trove](https://terminaltrove.com/vortix/) — The $HOME of all things in the terminal
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"hasInstallScript": true,
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"name": "@harry-kp/vortix",
|
|
26
|
-
"version": "0.1.
|
|
26
|
+
"version": "0.1.5"
|
|
27
27
|
},
|
|
28
28
|
"node_modules/@isaacs/balanced-match": {
|
|
29
29
|
"engines": {
|
|
@@ -515,5 +515,5 @@
|
|
|
515
515
|
}
|
|
516
516
|
},
|
|
517
517
|
"requires": true,
|
|
518
|
-
"version": "0.1.
|
|
518
|
+
"version": "0.1.5"
|
|
519
519
|
}
|
package/package.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"artifactDownloadUrl": "https://github.com/Harry-kp/vortix/releases/download/v0.1.
|
|
2
|
+
"artifactDownloadUrl": "https://github.com/Harry-kp/vortix/releases/download/v0.1.5",
|
|
3
3
|
"author": "Harry KP <harrykp@users.noreply.github.com>",
|
|
4
4
|
"bin": {
|
|
5
5
|
"vortix": "run-vortix.js"
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
"zipExt": ".tar.xz"
|
|
101
101
|
}
|
|
102
102
|
},
|
|
103
|
-
"version": "0.1.
|
|
103
|
+
"version": "0.1.5",
|
|
104
104
|
"volta": {
|
|
105
105
|
"node": "18.14.1",
|
|
106
106
|
"npm": "9.5.0"
|