Command Reference

This page is the quick lookup for every command. For the story behind a feature — why you'd use it, how it behaves in edge cases — follow the links out to the guides.

Apply & status

Command	What it does
`socksy set 'user:pass@host:port'`	Apply a proxy now — auto-installs `gost`, auto-tests the exit IP.
`socksy on`	Re-apply the last proxy.
`socksy off`	Back to a direct connection.
`socksy status [--json]`	Show what's active right now (`--json` for scripts).
`socksy test`	Print the current exit IP.

set flags:

Flag	Meaning
`--type <socks5\|http\|https>`	Upstream type. Default `socks5`.
`--country <XX>`	Tag the username for a geo-targeted exit, e.g. `--country GR`.
`--sticky` / `--session <id>`	Pin one exit IP instead of getting a new one per connection — see Rotation, Sticky Sessions & the Watchdog.

No-auth proxies work too — pass host:port anywhere a proxy string is expected.

Proxy formats

Anywhere socksy takes a proxy, all of these are accepted:

socksy set 'user:pass@host:1080'          # the canonical form
socksy set 'socks5://user:pass@host:1080' # with an explicit scheme
socksy set 'host:1080:user:pass'          # what most providers actually export
socksy set 'host:1080'                    # no authentication

The third form is the one proxy providers hand you in their dashboard, so you can paste a line straight from their list without rewriting it.

Run a single app

Command	What it does
`socksy run [--profile <name>] <cmd>`	Proxy one command; leave the desktop on a direct connection.

Without --profile it reuses the relay that's already running. With --profile it starts a throwaway relay just for that command. See Proxying a Single App.

Saved profiles

Command	What it does
`socksy save <name> 'user:pass@..'`	Remember a proxy under a name.
`socksy use [<name>]`	Apply a saved proxy (no name = last used).
`socksy list`	List saved proxies (passwords masked).
`socksy rm <name>`	Forget a saved proxy.

See Proxying a Single App.

Rotation & reliability

Command	What it does
`socksy rotate [<id>]`	Same proxy, fresh exit IP.
`socksy watchdog on\|off\|status`	Auto-restart the relay when the exit goes bad.
`socksy watch [seconds]`	Live exit-IP loop (default 5s; flags every change).
`socksy logs [-f] [-n <lines>]`	Tail the relay's journal.

See Rotation, Sticky Sessions & the Watchdog for how these fit together.

Leak audit

Command	What it does
`socksy check [--json] [--strict]`	Audit for leaks — DNS, IPv6, bind, bypass, exit geo — in one command.

See Leak Audit for what each check catches and a sample report.

DNS & LAN bypass

Command	What it does
`socksy dns on\|off\|reset\|status`	Remote DNS for Firefox; `reset` removes socksy's block from `user.js`.
`socksy bypass list\|add\|rm\|reset`	Manage the no-proxy (ignore-hosts) list.

See DNS & Browsers.