Omahub
← All plugins
T

Windscribe

by tuxr

Windscribe VPN status, locations, protocol, and firewall in the Omarchy bar via windscribe-cli.

GitHub

Security review

No obvious issues detected

Deterministic scan — not a security guarantee

None
Risk level
None
Analyzed commit
ae3f7dc
Scanned
1 month ago

No potentially dangerous behavior detected in the analyzed commit.

Automated analysis only — not a security guarantee.

AI advisory review

No obvious issues detected

Language-model assessment · ~deepseek/deepseek-v4-flash-latest — advisory only

None
AI risk level
None
Recommendation
install
Model
~deepseek/deepseek-v4-flash-latest
Analyzed commit
ae3f7dc
Reviewed
1 month ago

Manual review agrees with the deterministic scan: this is a straightforward bar widget that wraps windscribe-cli for user-initiated VPN operations through a bounded, non-shell Python runner. No obfuscation, hidden persistence, credential theft, or destructive install-time behavior was found.

How this check works

This review combines the deterministic scan (the rule-based results above) with an independent look at the plugin's code by a language model. The model reads a trimmed sample of the repository's files, the manifest, and the README, then gives a plain-language risk level and a recommendation: install (no notable danger), review (look closer first), or avoid (clearly dangerous).

It runs on the same analyzed commit as the deterministic scan and is strictly advisory — it is not a security guarantee and never blocks a plugin by itself. A human moderator still reviews plugins before they are listed.

AI advisory only — automated analysis, not a security guarantee.

Install
$ omarchy plugin add https://github.com/tuxr/omarchy-windscribe --enable
Widgets #bar #quickshell #security

Windscribe for Omarchy

Bar widget for the Omarchy Quattro shell. It wraps windscribe-cli: connection state in the bar, a keyboard-friendly panel for locations, protocol, firewall, and IP tools.

Install

Requires windscribe-cli on PATH, already logged in (windscribe-cli login).

omarchy plugin add https://github.com/tuxr/omarchy-windscribe.git --enable

Place it if the default right-section slot is not what you want:

omarchy bar move io.github.dsumpter.windscribe --section right

Usage

  • Left click the shield: open or close the panel
  • Right click: connect to best / disconnect
  • Middle click: refresh
  • Escape closes the panel

Inside the panel:

Key Action
j / k or arrows move cursor
Enter / Space expand a region, or connect a city
h / l or left/right collapse / expand region
/ or s focus location search (type normally, including j/k)
t or c toggle VPN
r refresh
f toggle firewall
i rotate IP (while connected)
p pin current IP to favourites
y copy VPN IP

Locations follow the Omarchy panel pattern (hero, CONNECTION, LOCATIONS) and the Windscribe tree: Best location, recents, favourites / static IPs when the CLI has any, then expandable regions with City Nickname rows. Search filters the tree.

Configure

Widget settings (refresh interval, default connect protocol) live in the Omarchy bar widget editor. Protocol is also on the panel; Auto uses the CLI's last / preferred protocol.

IPC

omarchy-shell io.github.dsumpter.windscribe status
omarchy-shell io.github.dsumpter.windscribe connectBest
omarchy-shell io.github.dsumpter.windscribe disconnect
omarchy-shell io.github.dsumpter.windscribe rotateIp
omarchy-shell io.github.dsumpter.windscribe pinIp
omarchy-shell io.github.dsumpter.windscribe refresh
omarchy-shell io.github.dsumpter.windscribe open
omarchy-shell io.github.dsumpter.windscribe close
omarchy-shell io.github.dsumpter.windscribe toggle

Develop

Source of truth is this repository. On a machine you are iterating on, symlink it into the user plugin directory (Omarchy discovers ~/.config/omarchy/plugins/<id>):

ln -sfn "$PWD" ~/.config/omarchy/plugins/io.github.dsumpter.windscribe
omarchy plugin validate ~/.config/omarchy/plugins/io.github.dsumpter.windscribe
omarchy plugin enable io.github.dsumpter.windscribe right
omarchy-shell shell rescanPlugins

omarchy plugin validate must be run against this repository path, not the ~/.config/omarchy/plugins/... symlink. The validator treats the symlink itself as a forbidden link; the shell still loads symlink installs, and omarchy plugin remove knows how to unlink them.

windscribe-cli is single-instance. The service serializes every spawn through one process; do not add a second concurrent CLI call. At most eight jobs wait behind the running command. Duplicate status/list reads coalesce, queued connection and firewall setters are latest-wins, and accepted rotate/pin operations remain FIFO until the cap rejects new work.

IPC handler changes need omarchy-restart-shell. Manifest and QML edits usually hot-reload after touch manifest.json or omarchy-shell shell rescanPlugins. Follow live logs with:

qs -p "$OMARCHY_PATH/shell" log -f

Remove

Removing the plugin unloads and deletes only the Omarchy widget. It does not disconnect an active Windscribe tunnel, turn off the Windscribe firewall, log out windscribe-cli, or delete Windscribe configuration. Tunnel or firewall state can therefore remain active after the plugin is gone.

If you want to restore normal non-VPN networking before removal, inspect the current state and run the cleanup commands explicitly:

windscribe-cli status
windscribe-cli disconnect
windscribe-cli firewall off
omarchy plugin remove io.github.dsumpter.windscribe

Run the commands separately so a harmless “already disconnected” result does not prevent the firewall command. If you intentionally want the existing tunnel or firewall state to remain, skip the corresponding cleanup command and remove only the plugin.

License

MIT. See LICENSE.