@harry-kp/vortix 0.1.8 → 0.2.0

package/CHANGELOG.md

@@ -7,6 +7,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2026-03-31
+
+### Added
+
+- Add a CLI-first headless mode with structured JSON output for scripting, automation, and AI-agent workflows, including `vortix status` for scriptable connection and kill-switch visibility ([#156](https://github.com/Harry-kp/vortix/issues/156), [#176](https://github.com/Harry-kp/vortix/pull/176)).
+- Add the new flip-panel dashboard interaction with animated card transitions ([#165](https://github.com/Harry-kp/vortix/pull/165)).
+
+### Changed
+
+- VPN sessions can now keep running after the TUI or CLI exits, so leaving the interface no longer tears down an active connection unexpectedly ([#155](https://github.com/Harry-kp/vortix/issues/155), [#176](https://github.com/Harry-kp/vortix/pull/176)).
+- Make `vortix down` wait for the OpenVPN daemon to fully exit before reporting success ([#176](https://github.com/Harry-kp/vortix/pull/176)).
+
+### Fixed
+
+- Remove the stale quit confirmation now that active connections can continue independently of the UI process ([#179](https://github.com/Harry-kp/vortix/issues/179), [#182](https://github.com/Harry-kp/vortix/pull/182)).
+- Fix help overlay scrolling edge cases, including opening before the first resize and clamping scroll correctly after keyboard and mouse input ([#180](https://github.com/Harry-kp/vortix/issues/180), [#182](https://github.com/Harry-kp/vortix/pull/182)).
+- Harden CLI lifecycle handling around disconnect flow, error paths, and config isolation ([#176](https://github.com/Harry-kp/vortix/pull/176)).
+
+### Documentation
+
+- Clarify current Linux support expectations and improve Linux bug-reporting guidance for distro-specific issues ([#185](https://github.com/Harry-kp/vortix/pull/185)).
+
+### CI
+
+- Add Fedora 41 CI coverage for `cargo check`, `cargo clippy`, `cargo test`, and `cargo doc`, including unprivileged test execution for Linux-specific validation ([#160](https://github.com/Harry-kp/vortix/issues/160), [#183](https://github.com/Harry-kp/vortix/pull/183)).
+
+
+
 ## [0.1.8] - 2026-03-19
 
 ### Features

package/README.md

@@ -49,6 +49,14 @@ Existing options (`wg show`, NetworkManager, Tunnelblick) either lack real-time
 - **Config Viewer** — Inspect profile configurations directly within the TUI
 - **Keyboard-driven** — No mouse required
 
+## Platform Support
+
+Vortix is actively developed and used primarily on macOS.
+
+Linux support is a current focus and is improving quickly, with CI coverage for Ubuntu and Fedora. Linux environments still vary a lot across distributions, firewall backends, DNS tooling, and privilege models, so distro-specific issues may still exist.
+
+If you use Vortix on Linux and hit a problem, please open an issue and include `vortix report` output when possible. Ubuntu, Fedora, and Arch users are especially helpful when testing release candidates and validating fixes before release. If you want to help test Linux support, join the [Linux tester discussion](https://github.com/Harry-kp/vortix/discussions/184).
+
 ## Requirements
 
 ### Runtime dependencies
@@ -154,16 +162,88 @@ After this, `sudo vortix` works as expected.
 - Nix (`nix profile install`) — **no**, installs to Nix profile bin
 - macOS — **no**, sudo preserves user PATH
 
+### Linux support note
+
+Most day-to-day development happens on macOS. Linux support is continuously tested in CI, but real-world distro coverage is still growing. If something behaves differently on your Linux setup, please treat that as useful signal and report it rather than assuming it is expected.
+
 ## Usage
 
+Vortix has two modes: an interactive TUI dashboard (default) and a headless CLI for scripting, automation, and AI agents.
+
 ```bash
-sudo vortix              # Launch TUI (requires root for VPN operations)
-vortix import <file>     # Import a .conf or .ovpn profile
-vortix info              # Show config directory and version
-vortix update            # Self-update to latest release
-vortix report            # Generate a bug report with system diagnostics
+sudo vortix              # Launch TUI dashboard (default)
 ```
 
+### CLI Commands
+
+Every subcommand supports `--json` for machine-readable output and `--quiet` for silent operation (exit code only).
+
+**Connection:**
+```bash
+sudo vortix up work-vpn         # Connect to a profile
+sudo vortix down                # Disconnect (graceful)
+sudo vortix down --force        # Force-disconnect (SIGKILL)
+sudo vortix reconnect           # Reconnect to last used profile
+vortix status                   # Show connection state + telemetry
+vortix status --brief           # One-line: "● Connected to work-vpn"
+vortix status --watch           # Live updates every 2s
+vortix status --watch --json    # NDJSON stream for monitoring
+```
+
+**Profile Management:**
+```bash
+vortix list                     # List all imported profiles
+vortix list --names-only        # Profile names for scripting
+vortix list --sort last-used    # Most recently used first
+vortix import ./work.conf       # Import a WireGuard profile
+vortix import ./configs/        # Bulk import from directory
+vortix show work-vpn            # Display profile configuration
+vortix show work-vpn --raw      # Raw config file contents
+vortix delete old-vpn --yes     # Delete without confirmation
+vortix rename old-vpn new-vpn   # Rename a profile
+```
+
+**Security:**
+```bash
+sudo vortix killswitch auto     # Set kill switch to auto mode
+sudo vortix killswitch always   # Always-on kill switch
+vortix killswitch               # Show current mode
+sudo vortix release-killswitch  # Emergency firewall release
+```
+
+**System:**
+```bash
+vortix info                     # Config paths, versions, profile count
+vortix update                   # Self-update from crates.io
+vortix report                   # Generate bug report
+vortix completions bash >> ~/.bashrc      # Shell completions
+vortix completions zsh > ~/.zfunc/_vortix
+```
+
+**JSON output for AI agents / scripts:**
+```bash
+# Structured JSON envelope on every command
+vortix status --json
+# {"ok":true,"command":"status","data":{...},"next_actions":[...]}
+
+vortix list --json | jq '.data[].name'    # Extract profile names
+
+# NDJSON stream for monitoring
+vortix status --watch --json
+```
+
+**Exit codes** are semantic and scriptable:
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success |
+| 1 | General error |
+| 2 | Permission denied (needs sudo) |
+| 3 | Not found (profile doesn't exist) |
+| 4 | State conflict (already connected) |
+| 5 | Missing dependency |
+| 6 | Timeout |
+
 ### Keybindings
 
 | Key | Action |

package/npm-shrinkwrap.json

@@ -23,7 +23,7 @@
       "hasInstallScript": true,
       "license": "MIT",
       "name": "@harry-kp/vortix",
-      "version": "0.1.8"
+      "version": "0.2.0"
     },
     "node_modules/@isaacs/balanced-match": {
       "engines": {
@@ -515,5 +515,5 @@
     }
   },
   "requires": true,
-  "version": "0.1.8"
+  "version": "0.2.0"
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "artifactDownloadUrl": "https://github.com/Harry-kp/vortix/releases/download/v0.1.8",
+  "artifactDownloadUrl": "https://github.com/Harry-kp/vortix/releases/download/v0.2.0",
   "author": "Harry KP <harrykp@users.noreply.github.com>",
   "bin": {
     "vortix": "run-vortix.js"
@@ -100,7 +100,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.1.8",
+  "version": "0.2.0",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"