Quick Start¶
Get cs-proxy running in under a minute.
Prerequisites¶
- Python 3.8+
- GitHub CLI (
gh) installed and authenticated sshandcurlavailable
Install¶
Authenticate¶
Start a Proxy¶
This will:
- Select an existing Codespace (or create one interactively)
- Start an SSH tunnel with SOCKS5 forwarding on
127.0.0.1:1080 - Run in the background with automatic reconnection
Verify¶
This compares your direct IP with the proxied IP to confirm traffic is routing through the Codespace.
Use It¶
Route tools through the proxy¶
cs-tools pcurl https://ifconfig.me
cs-tools pnmap -p 80,443 target.com
cs-tools pffuf -u https://target.com/FUZZ -w wordlist.txt
Serve files publicly¶
Set up a VPN tunnel¶
Two Proxies, Different Exit IPs¶
cs-proxy -n 2 start -l WestEurope -l EastUs
# Tunnel 1: socks5://127.0.0.1:1080 (WestEurope)
# Tunnel 2: socks5://127.0.0.1:1081 (EastUs)
curl --socks5-hostname 127.0.0.1:1080 https://ifconfig.me
curl --socks5-hostname 127.0.0.1:1081 https://ifconfig.me
cs-proxy status # health + exit IP per tunnel
cs-proxy ssh # numbered menu to pick which codespace to shell into
Stop¶
cs-proxy stop # stop all proxy tunnels
cs-proxy down # stop tunnels + shut down all managed codespaces
cs-proxy delete # permanently delete codespace(s)
Next Steps¶
- Installation Guide -- platform-specific setup and troubleshooting
- Configuration -- customize ports, codespace, and behavior
- Command Reference -- full list of commands
- Use Cases -- real-world scenarios and workflows