alle
A universal VPN client that manages multiple VPN connections with rule-based routing.
Why alle
Most VPN clients are built around one global idea: connect this device to a single VPN server, then send everything through it until you disconnect or switch.
That is not enough when different resources need to appear from different regions — a geo-fenced stream, a bank that blocks foreign IPs, a region-locked test environment. Switching origins means disconnecting from one server and reconnecting to another, and the official client on one machine usually cannot keep several locations active at once anyway.
alle keeps multiple VPN exits live at the same time, from one provider or mixed
across several. Say you want a US exit, a UK exit, and a Japan exit at once —
NordVPN for the US and Japan, ProtonVPN for the UK:
streaming + admin ──► alle ──► United States (NordVPN)
test runner ──► alle ──► Japan (NordVPN)
bank login ──► alle ──► United Kingdom (Proton VPN)
Each app points at the exit it needs; they run concurrently and independently, so opening the bank never disturbs the stream.
In short: not one global location you keep switching, but several exits alive at once, each used where it is needed.
What alle does
alle runs multiple VPN exits side by side. Each exit is exposed as its own
local HTTP+SOCKS proxy on 127.0.0.1:<port>. A single HTTP+SOCKS router
entrypoint routes traffic by rule (domain, IP) to a VPN exit, to direct
outbound, or blocks it. Instead of changing your whole machine's VPN location,
you point each app, browser profile, script, or test job at the path it needs.
Under the hood, alle manages one
sing-box process. Each channel becomes
one local proxy inbound routed through one WireGuard VPN peer. Channels can come
from different providers, so a NordVPN exit and a Proton VPN .conf import can
run at the same time.
System-wide VPN (TUN mode). The above is per-app by design — you point each
app at the proxy it needs. For a whole-machine VPN that captures all traffic
(raw sockets, UDP, every app) through the same routing rules, enable TUN mode
with alle tun on. It needs a one-time privilege grant and then no sudo
for daily use: sudo alle helper install on macOS (a root LaunchDaemon owns
sing-box while tun is on), or sudo setcap cap_net_admin,cap_net_raw+ep "$(alle version --singbox-path)" on Linux. See
TUN mode and the
runbook; the rest of alle stays no-sudo. Note: while
TUN mode is on, IPv6 is blocked, not leaked — the supported providers'
WireGuard configs are IPv4-only (their restriction), so rather than let IPv6
bypass the VPN and expose your home address, alle captures and rejects it.
Current status
alle is usable today as a CLI-first client for per-app/per-workflow VPN exits.
Providers
| Provider | Support |
|---|---|
| NordVPN | Token/API setup, location selection, automatic WireGuard channel creation |
| Proton VPN | WireGuard .conf import |
Platforms
| Platform | Support |
|---|---|
| macOS | Supported |
| Linux | Supported |
| Windows | Planned |
Features
| Phase | Status |
|---|---|
| Core CLI | Providers, channels, per-channel proxies, status, tests (probe + speed + traffic), logs |
| Routing | Ruleset-based router entrypoint with domain/CIDR/all matchers, kill-switch, CLI shadow lint, built-in LAN bypass |
| Web UI | Dashboard (channels, probe/speed, routes, kill-switch) + Logs page |
| Desktop companion | Planned |
| Distribution | PyPI CLI package; native installers planned |
Install
alle is a Python CLI (Python 3.10+) installed as a user-level tool — no sudo.
Two recommended, fully explicit paths; each step is an ordinary command you can
inspect, and the tool that installed alle is also the one that upgrades and
uninstalls it.
With uv:
# 1. install uv (see its docs for other methods)
curl -LsSf https://astral.sh/uv/install.sh | sh
# 2. install the alle CLI
uv tool install alle-proxy
# 3. (optional) run the background daemon at login, so channels survive a reboot
alle daemon install
With pipx:
# 1. install pipx (e.g. `brew install pipx` or your distro's package)
# 2. install the alle CLI
pipx install alle-proxy
# 3. (optional) run the background daemon at login
alle daemon install
Step 3 is optional: without it the runtime auto-starts on first use (alle start
or the first channel you add) and runs for the session. alle daemon install
registers it as a user-level login service (macOS LaunchAgent / systemd --user)
so it starts at login and is supervised — see the
CLI reference.
Also works: python -m pip install alle-proxy into an environment you manage,
or one-off runs with uvx --from alle-proxy alle --help.
After installation:
alle version
alle --help
Uninstall with the same tool that installed it — uv tool uninstall alle-proxy or pipx uninstall alle-proxy (run alle stop first). ~/.alle
is left behind since it holds your provider credentials and WireGuard keys; a
reinstall picks up where you left off. Remove it with rm -rf ~/.alle if you
want everything gone.
Quick start
Add a provider, create a channel, start the runtime, then use the channel's local proxy port.
alle providers add nordvpn
alle channels add nordvpn --country "United States"
alle start
alle channels ls
alle channels ls prints the local proxy port for each channel:
LABEL ID PORT COUNTRY CITY
--------------- ----------------------- ------ ------------- ----------
united_states_1 nordvpn/united_states_1 :53124 United States (Any City)
Use that port from any tool or app that supports an HTTP or SOCKS proxy:
curl -x http://127.0.0.1:53124 https://api.ipify.org
Check health and traffic (status is the system summary; test is the
per-channel table — fresh IP/latency plus cumulative sent/received):
alle status
alle test
Provider setup
alle supports two provider setup styles today:
NordVPN uses an access token:
alle providers add nordvpn
alle locations nordvpn
alle locations nordvpn --country "United States"
alle channels add nordvpn --country "United States" --city "Seattle"
To rotate a bad or expired token later, run alle providers add nordvpn again
(or use the gear on the provider in the Web UI): it confirms, validates the new
token, and re-resolves the provider's channels — no need to remove and re-add.
The stored token is never displayed back, only a masked preview. This is distinct
from a bundle import (which changes your whole setup from a file); a token update
changes one live credential. See
alle providers add.
Proton VPN uses WireGuard config files downloaded from Proton:
alle providers add protonvpn
alle channels add protonvpn --config ~/Downloads/wg-US-CA-842.conf
Re-importing the same .conf file updates that channel in place, keeping the
same channel id and local port; re-importing a byte-identical file changes
nothing and tells you the channel already exists.
Friendly names
Channels are identified by a globally-unique, provider-qualified id
(nordvpn/united_states_1) — the handle every command takes, shown in the ID
column. You can also give one a display label for readability (the LABEL
column in channels ls and test). The id never changes,
so relabelling is always safe:
alle channels add nordvpn --country "United States" --label "Streaming - US"
alle channels setlabel united_states_1 "Streaming - US" # or set it later
alle channels setlabel united_states_1 # omit text to clear
Common commands
Useful commands after setup:
alle providers ls
alle channels ls
alle channels ls --refs
alle status
alle test
alle logs
alle stop
Most read commands support --json for scripts:
alle status --json
alle channels ls --json
alle test --json
Channel and provider removals accept multiple targets:
alle channels rm japan_1 united_states_seattle_1
alle channels rm protonvpn/wg_us_ca_842
alle channels rm 'united_states_*' --dry-run
alle providers rm nordvpn protonvpn -y
For the complete command reference, see the CLI Reference.
Rule-based routing
Besides the per-channel ports, alle runs one router entrypoint — a single
local HTTP+SOCKS proxy that dispatches each connection by rule to a channel, to
direct (no VPN), or to block. The entrypoint is always on: with no rules it
is a transparent pass-through, and traffic only uses a VPN exit once you wire a
rule to one. Its port is assigned once and stays stable (alle status shows it),
so apps and future OS-level profiles can point at it permanently.
alle routes ruleset create Streaming --via nordvpn/united_states_1 --domain netflix.com --domain hulu.com
alle routes ruleset create LocalDirect --via direct --cidr 192.168.0.0/16
alle routes ruleset create BlockTrackers --via block --domain tracker.example.com
alle routes ruleset create DefaultVPN --via nordvpn/japan_1 --all
alle routes ls
- Rulesets are the authoring model: a named, ordered block of matchers that
all share one exit (
<provider>/<channel>,direct, orblock). Block order is priority: first matching ruleset wins. Reorder blocks withalle routes reorder rs3 rs1 rs2. - Matchers inside a ruleset are unordered because same-target matchers
commute. Use
--domainfor a destination domain — it matches the domain and all of its subdomains (dot-boundary) —--cidrfor destination IP/CIDR, and--allfor a catch-all. A matcher that can never win because an earlier ruleset covers it is flagged as shadowed inroutes ls. - Unmatched traffic goes direct — without a VPN — like other modern VPN
clients. To block unmatched traffic instead (a kill-switch for the router
entrypoint), turn it on explicitly:
alle routes killswitch on. Per-channel ports are never affected by the kill-switch. - LAN/local traffic stays direct by default. Built-in rules for private,
link-local, and multicast ranges are compiled ahead of every user rule, so a
catch-all VPN rule never cuts off printers, NAS boxes, router admin pages, or
LAN discovery — the same protection mainstream VPN clients ship. Inspect or
disable with
alle routes lan [on|off](leaving it on is recommended). - Channels referenced by rules cannot be removed.
alle channels rm(andalle providers rm, for any of its channels) refuses while a rule targets the channel, listing every referencing rule and the exactalle routes rm …to run first. Remove the rules, then the channel — routing config never changes as a side effect of something else. - Per-channel ports keep working exactly as before, with or without rules — the router is an addition, never a replacement.
Backup and declarative setup
The whole setup — providers (with credentials), channels, rulesets, and router
toggles — round-trips through one declarative YAML bundle file. import
applies it two ways: a merge by default, or --replace to overwrite the
whole setup (it confirms first).
alle export # write the bundle (0600)
alle import alle-backup-20260709-143022.yaml # merge into the current setup
alle import alle-backup-20260709-143022.yaml --replace # REPLACE the whole setup (confirms)
The bundle is a secret (it carries WireGuard private keys and provider tokens), so treat it like a password file. The same export and import (merge / replace) are on the Web UI's Bundle page.
The full format, apply semantics, how to hand-write one provider by provider,
and all caveats (ports don't travel, token-provider channels may re-resolve a
fresh server, cloning a setup to two machines) live in the dedicated guides:
docs/declarative-config.md (how to author
one) and docs/bundle.md (format reference + caveats),
plus alle validate to check a
file before applying it.
Web UI
alle serves a local dashboard from the background daemon — nothing extra to
install. Open it with:
alle ui
This opens your browser to a Dashboard, a Bundle page, and a Logs page:
- Router entrypoint —
http://127.0.0.1:<port>at the top (click to copy). - Channels table — every channel with Location, Port, Latency, IP, and Sent / Received / Down Speed / Up Speed columns. The measured columns stay blank until you run a Probe (latency + IP + traffic totals) or Speed Test (adds download/upload) from the row or the column header, with a spinner while it runs. Speed Test All streams — each channel's row fills in the moment its own test completes, instead of all at once at the end. While a channel is being tested (or a batch run is in flight) that row's Probe and Speed Test buttons are disabled, so a test can't be fired twice at once. Rename a channel inline, remove one, and add channels through a provider-guided wizard.
- Add channel wizard — pick a provider (an icon-only row of providers plus
an always-present "+" to add NordVPN or Proton VPN). For token providers like
NordVPN, choose a country and city from a searchable list (no typing); for
Proton VPN, upload a WireGuard
.conf(with a link to the portal). Each added token provider carries a gear to replace its stored token (write-only — the token is never shown back); replacing it re-resolves that provider's channels. - Router rules — add/delete rules, drag to reorder (first match wins), and toggle Allow Non-VPN Traffic (the Unmatched row: on lets unmatched destinations reach the Internet, off blocks them). A fixed Priority 0 / LAN row at the top keeps local traffic direct ahead of every rule, with a toggle to turn that protection off.
- Bundle — download the whole setup as a bundle file (it contains credentials — the UI warns first), and upload one to merge it in or replace the whole setup (with a confirmation dialog).
- Start / stop / restart are host/CLI controls (
alle start|stop|restart); the masthead links to the project on GitHub.
The server binds to 127.0.0.1 only and is never exposed to the network. The
browser URL uses a per-installation alle-<random>.localhost hostname (which
browsers resolve to loopback on their own) so the session cookie is scoped to
alle alone, never shared with other local web apps. To reach the UI from
another machine, forward the same port over SSH rather than exposing it:
alle status # on the remote host: note the Web UI port
ssh -L <port>:127.0.0.1:<port> user@host
# then open the `alle ui` sign-in link locally — it resolves to your tunnel
SSH provides the encryption and access control; the browser still reaches alle on loopback. Do not open or reverse-proxy the alle Web UI port directly to a network.
alle ui signs you in automatically. To sign in by hand, paste the secret
from ~/.alle/control_api.json into the login page. Sessions idle out after
30 minutes without an open tab (capped at 12 hours); the masthead's Sign
out button revokes every session immediately.
How it works
-
allekeeps its local state under~/.alle/, or under$ALLE_HOMEwhen that environment variable is set. This includes providers, channels, credentials, metrics, generated config, logs, and runtime files. -
allemanages onesing-boxprocess instead of starting one VPN process per channel. The generated config contains one local HTTP+SOCKS inbound per channel, plus the router entrypoint inbound whose sing-box route rules are compiled fromalle routes. -
Each channel routes to one WireGuard peer. NordVPN channels are created from the provider API; Proton VPN channels are created by importing a WireGuard
.conffile. After creation, both behave the same way. -
WireGuard is connectionless, so
alledoes not model channels as connected or disconnected. A channel exists in config; its health comes from the latest probe. -
Local proxy ports are assigned by the OS and stored in state. Use
alle channels lsto see the current ports. -
The background runtime applies state changes, keeps the
sing-boxprocess in sync, probes channel health, and records per-channel traffic totals. -
alleuses a pinned upstreamsing-boxrelease and verifies its checksum before running it.
Security and privacy
- Provider credentials and WireGuard private keys are stored locally under
~/.alle/or$ALLE_HOME. - The state directory is kept owner-only (
0700), and credential/state/config files inside it are written with private permissions from the first byte. alledoes not read provider tokens from environment variables; credentials are added explicitly withalle providers add.alledownloads a pinned upstreamsing-boxrelease and verifies its checksum before running it.- Local proxy ports bind to loopback. Traffic only uses a VPN exit when an app is pointed at one of those proxies.
- The loopback proxies are unauthenticated: on a multi-user machine, any local user or process can send traffic through your channels (and your provider account). alle assumes a single-user machine; don't run it where that assumption fails. The internal stats API is authenticated with a generated per-installation secret, so connection metadata is not exposed locally.
- The full threat model — trust boundaries, Web UI session design, fail-closed routing — lives in docs/security.md.
Roadmap and non-goals
Planned next steps:
- More WireGuard-capable VPN providers. See VPN Provider Research.
- Desktop companion with OS-level VPN integration.
- Windows support and broader distribution.
Non-goals:
- OpenVPN or IKEv2/IPsec support.
- VPN providers without usable WireGuard support, such as ExpressVPN, HideMyAss, Perfect Privacy, Privado, SlickVPN, VPN.ac/VPNSecure, and Giganews.
- SOCKS5-only or unencrypted proxy providers.
- Bundling
sing-boxinside the Python package.
License
MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file alle_proxy-0.1.5.tar.gz.
File metadata
- Download URL: alle_proxy-0.1.5.tar.gz
- Upload date:
- Size: 760.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
480b14cf767fe706924a1cd80709cec9f8475b2ab2061aa984dea99167dd74a3
|
|
| MD5 |
568c466997d8a8316bba7297c664e3d3
|
|
| BLAKE2b-256 |
f1296fbb8db3a8b39f4c885243b0f9f37828e19f30bfd81f76b20b8ab0e27041
|
Provenance
The following attestation bundles were made for alle_proxy-0.1.5.tar.gz:
Publisher:
publish.yml on zydo/alle
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
alle_proxy-0.1.5.tar.gz -
Subject digest:
480b14cf767fe706924a1cd80709cec9f8475b2ab2061aa984dea99167dd74a3 - Sigstore transparency entry: 2149500439
- Sigstore integration time:
-
Permalink:
zydo/alle@7a65d77845e9d8997d201eea5bab307a8caa4e0f -
Branch / Tag:
refs/tags/v0.1.5 - Owner: https://github.com/zydo
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7a65d77845e9d8997d201eea5bab307a8caa4e0f -
Trigger Event:
push
-
Statement type:
File details
Details for the file alle_proxy-0.1.5-py3-none-any.whl.
File metadata
- Download URL: alle_proxy-0.1.5-py3-none-any.whl
- Upload date:
- Size: 230.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b99a8142d5ad58781692cd83cf0e1d3f1c57937b657fe99b2b5346b5c31d32d8
|
|
| MD5 |
6a692fa4d18412dfc183e93898fa031d
|
|
| BLAKE2b-256 |
debe2ad948ad73f7a0be2a10c5093228b0f8c4662248a48bd54ab0c0d6a65e6c
|
Provenance
The following attestation bundles were made for alle_proxy-0.1.5-py3-none-any.whl:
Publisher:
publish.yml on zydo/alle
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
alle_proxy-0.1.5-py3-none-any.whl -
Subject digest:
b99a8142d5ad58781692cd83cf0e1d3f1c57937b657fe99b2b5346b5c31d32d8 - Sigstore transparency entry: 2149501348
- Sigstore integration time:
-
Permalink:
zydo/alle@7a65d77845e9d8997d201eea5bab307a8caa4e0f -
Branch / Tag:
refs/tags/v0.1.5 - Owner: https://github.com/zydo
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7a65d77845e9d8997d201eea5bab307a8caa4e0f -
Trigger Event:
push
-
Statement type: