From 868f0df0405453da9874e4224fdb7f720a4ebf3b Mon Sep 17 00:00:00 2001 From: Vitas Civilis Date: Thu, 22 Oct 2026 13:17:24 +0300 Subject: [PATCH 1/5] docs(readme): lead with running a command from another country; quick starts for your own proxy and Shellroute's routes Signed-off-by: Vitas Civilis --- README.md | 23 +++++++++-------------- npm/shellroute/README.md | 21 +++++++++------------ 2 files changed, 18 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 0d5a17f..4bf15d8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ -# shellroute CLI +# Shellroute CLI [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) -**Run terminal commands through a proxy.** +**Run your command from another country.** -Choose a country or city and route a shell session or a single command through a proxy. Your other apps and terminals keep their normal connection. Learn more at [shellroute.com](https://shellroute.com/). - -Need to reproduce country-specific behavior? Run the same command through another country while the rest of your machine keeps its normal connection. +See what your site and API do for a visitor in Germany, the US or Japan. Shellroute runs one command or one shell through a proxy in that country; the rest of your machine stays on its normal connection. Works with any HTTP or SOCKS5 proxy you already have, or with Shellroute's built-in routes. Learn more at [shellroute.com](https://shellroute.com/). ## Install @@ -30,24 +28,21 @@ Or download binaries from [GitHub Releases](https://github.com/shellroute/shellr Supports macOS and Linux. -## Quick start +## Quick start with your own proxy ```bash -# Log in. A new account is created automatically. -shellroute login - -# Shellroute opens after login. Run these inside it: -/connect US -curl https://ipinfo.io/json +shellroute upstream add your-proxy-name http://USER:PASSWORD@HOST:PORT +shellroute run your-proxy-name -- curl https://ipinfo.io/json ``` -### Or route one command +## Quick start with Shellroute's routes ```bash +shellroute login shellroute run DE -- curl https://ipinfo.io/json ``` -[Read the full quickstart](https://shellroute.com/docs/quickstart?utm_source=github&utm_medium=readme&utm_campaign=exp_ghconv_01). +Start with $1 of credit, no card needed. [Read the full quickstart](https://shellroute.com/docs/quickstart?utm_source=github&utm_medium=readme&utm_campaign=exp_ghconv_01). ## Commands diff --git a/npm/shellroute/README.md b/npm/shellroute/README.md index d51c09c..1321337 100644 --- a/npm/shellroute/README.md +++ b/npm/shellroute/README.md @@ -1,8 +1,8 @@ # shellroute -**Run terminal commands through a proxy.** +**Run your command from another country.** -Choose a country or city and route a shell session or a single command through a proxy. Your other apps and terminals keep their normal connection. +See what your site and API do for a visitor in Germany, the US or Japan. Shellroute runs one command or one shell through a proxy in that country; the rest of your machine stays on its normal connection. Works with any HTTP or SOCKS5 proxy you already have, or with Shellroute's built-in routes. ## Install @@ -10,27 +10,24 @@ Choose a country or city and route a shell session or a single command through a npm install -g shellroute ``` -## First session +## Quick start with your own proxy ```bash -# Log in. A new account is created automatically. -shellroute login - -# Shellroute opens after login. Run these inside it: -/connect US -curl https://ipinfo.io/json +shellroute upstream add your-proxy-name http://USER:PASSWORD@HOST:PORT +shellroute run your-proxy-name -- curl https://ipinfo.io/json ``` -Or route a single command through another country: +## Quick start with Shellroute's routes ```bash +shellroute login shellroute run DE -- curl https://ipinfo.io/json ``` Use this when you need to reproduce country or IP-sensitive behavior from a terminal command, script, or test without changing the rest of your machine. -[Follow the two-minute quickstart](https://shellroute.com/docs/quickstart?utm_source=npm&utm_medium=package-readme&utm_campaign=exp_npmconv_01). +Start with $1 of credit, no card needed. [Follow the two-minute quickstart](https://shellroute.com/docs/quickstart?utm_source=npm&utm_medium=package-readme&utm_campaign=exp_npmconv_01). -The CLI is open source and connects to the shellroute service. The service uses prepaid credits. +The CLI is open source. With your own proxy no account is needed; Shellroute's built-in routes use prepaid credits. [GitHub](https://github.com/shellroute/shellroute-cli) · [Pricing](https://shellroute.com/pricing) · [Compatibility](https://shellroute.com/docs/compatibility) · [Acceptable use](https://shellroute.com/acceptable-use) From 66ce689e29b5b5acb0f83a8ebba7f4cac590cbb6 Mon Sep 17 00:00:00 2001 From: Vitas Civilis Date: Thu, 22 Oct 2026 13:17:24 +0300 Subject: [PATCH 2/5] build: package descriptions name your own proxy and Shellroute's routes Signed-off-by: Vitas Civilis --- .goreleaser.yaml | 2 +- npm/shellroute/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 94f4bab..c399577 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -67,7 +67,7 @@ brews: name: homebrew-tap token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}" homepage: "https://shellroute.com" - description: "Run terminal commands through a proxy." + description: "Run your command from another country. Per-command proxy routing with your own proxy or Shellroute's routes." directory: Formula signs: diff --git a/npm/shellroute/package.json b/npm/shellroute/package.json index f4f7485..9bfc028 100644 --- a/npm/shellroute/package.json +++ b/npm/shellroute/package.json @@ -1,7 +1,7 @@ { "name": "shellroute", "version": "0.0.0", - "description": "Choose a country or city and route a shell session or a single command through a proxy. Your other apps and terminals keep their normal connection.", + "description": "Run your command from another country. Per-command proxy routing with your own proxy or Shellroute's routes.", "license": "Apache-2.0", "repository": { "type": "git", From 70458ec03461f5f5c2eb4d6f650c217de14e8213 Mon Sep 17 00:00:00 2001 From: Vitas Civilis Date: Thu, 22 Oct 2026 13:23:01 +0300 Subject: [PATCH 3/5] Revert "build: package descriptions name your own proxy and Shellroute's routes" This reverts commit 66ce689e29b5b5acb0f83a8ebba7f4cac590cbb6. Signed-off-by: Vitas Civilis --- .goreleaser.yaml | 2 +- npm/shellroute/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.goreleaser.yaml b/.goreleaser.yaml index c399577..94f4bab 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -67,7 +67,7 @@ brews: name: homebrew-tap token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}" homepage: "https://shellroute.com" - description: "Run your command from another country. Per-command proxy routing with your own proxy or Shellroute's routes." + description: "Run terminal commands through a proxy." directory: Formula signs: diff --git a/npm/shellroute/package.json b/npm/shellroute/package.json index 9bfc028..f4f7485 100644 --- a/npm/shellroute/package.json +++ b/npm/shellroute/package.json @@ -1,7 +1,7 @@ { "name": "shellroute", "version": "0.0.0", - "description": "Run your command from another country. Per-command proxy routing with your own proxy or Shellroute's routes.", + "description": "Choose a country or city and route a shell session or a single command through a proxy. Your other apps and terminals keep their normal connection.", "license": "Apache-2.0", "repository": { "type": "git", From c8ab9f6af44e51d9fe6a41fed69f1aaa5b7f4986 Mon Sep 17 00:00:00 2001 From: Vitas Civilis Date: Thu, 22 Oct 2026 13:23:01 +0300 Subject: [PATCH 4/5] Revert "docs(readme): lead with running a command from another country; quick starts for your own proxy and Shellroute's routes" This reverts commit 868f0df0405453da9874e4224fdb7f720a4ebf3b. Signed-off-by: Vitas Civilis --- README.md | 23 ++++++++++++++--------- npm/shellroute/README.md | 21 ++++++++++++--------- 2 files changed, 26 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 4bf15d8..0d5a17f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -# Shellroute CLI +# shellroute CLI [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) -**Run your command from another country.** +**Run terminal commands through a proxy.** -See what your site and API do for a visitor in Germany, the US or Japan. Shellroute runs one command or one shell through a proxy in that country; the rest of your machine stays on its normal connection. Works with any HTTP or SOCKS5 proxy you already have, or with Shellroute's built-in routes. Learn more at [shellroute.com](https://shellroute.com/). +Choose a country or city and route a shell session or a single command through a proxy. Your other apps and terminals keep their normal connection. Learn more at [shellroute.com](https://shellroute.com/). + +Need to reproduce country-specific behavior? Run the same command through another country while the rest of your machine keeps its normal connection. ## Install @@ -28,21 +30,24 @@ Or download binaries from [GitHub Releases](https://github.com/shellroute/shellr Supports macOS and Linux. -## Quick start with your own proxy +## Quick start ```bash -shellroute upstream add your-proxy-name http://USER:PASSWORD@HOST:PORT -shellroute run your-proxy-name -- curl https://ipinfo.io/json +# Log in. A new account is created automatically. +shellroute login + +# Shellroute opens after login. Run these inside it: +/connect US +curl https://ipinfo.io/json ``` -## Quick start with Shellroute's routes +### Or route one command ```bash -shellroute login shellroute run DE -- curl https://ipinfo.io/json ``` -Start with $1 of credit, no card needed. [Read the full quickstart](https://shellroute.com/docs/quickstart?utm_source=github&utm_medium=readme&utm_campaign=exp_ghconv_01). +[Read the full quickstart](https://shellroute.com/docs/quickstart?utm_source=github&utm_medium=readme&utm_campaign=exp_ghconv_01). ## Commands diff --git a/npm/shellroute/README.md b/npm/shellroute/README.md index 1321337..d51c09c 100644 --- a/npm/shellroute/README.md +++ b/npm/shellroute/README.md @@ -1,8 +1,8 @@ # shellroute -**Run your command from another country.** +**Run terminal commands through a proxy.** -See what your site and API do for a visitor in Germany, the US or Japan. Shellroute runs one command or one shell through a proxy in that country; the rest of your machine stays on its normal connection. Works with any HTTP or SOCKS5 proxy you already have, or with Shellroute's built-in routes. +Choose a country or city and route a shell session or a single command through a proxy. Your other apps and terminals keep their normal connection. ## Install @@ -10,24 +10,27 @@ See what your site and API do for a visitor in Germany, the US or Japan. Shellro npm install -g shellroute ``` -## Quick start with your own proxy +## First session ```bash -shellroute upstream add your-proxy-name http://USER:PASSWORD@HOST:PORT -shellroute run your-proxy-name -- curl https://ipinfo.io/json +# Log in. A new account is created automatically. +shellroute login + +# Shellroute opens after login. Run these inside it: +/connect US +curl https://ipinfo.io/json ``` -## Quick start with Shellroute's routes +Or route a single command through another country: ```bash -shellroute login shellroute run DE -- curl https://ipinfo.io/json ``` Use this when you need to reproduce country or IP-sensitive behavior from a terminal command, script, or test without changing the rest of your machine. -Start with $1 of credit, no card needed. [Follow the two-minute quickstart](https://shellroute.com/docs/quickstart?utm_source=npm&utm_medium=package-readme&utm_campaign=exp_npmconv_01). +[Follow the two-minute quickstart](https://shellroute.com/docs/quickstart?utm_source=npm&utm_medium=package-readme&utm_campaign=exp_npmconv_01). -The CLI is open source. With your own proxy no account is needed; Shellroute's built-in routes use prepaid credits. +The CLI is open source and connects to the shellroute service. The service uses prepaid credits. [GitHub](https://github.com/shellroute/shellroute-cli) · [Pricing](https://shellroute.com/pricing) · [Compatibility](https://shellroute.com/docs/compatibility) · [Acceptable use](https://shellroute.com/acceptable-use) From ea001d8d700b86b2e0db60ae3237ca456eb342d1 Mon Sep 17 00:00:00 2001 From: Vitas Civilis Date: Thu, 22 Oct 2026 13:23:54 +0300 Subject: [PATCH 5/5] docs(npm): add the use-your-own-proxy section to the npm README Signed-off-by: Vitas Civilis --- npm/shellroute/README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/npm/shellroute/README.md b/npm/shellroute/README.md index d51c09c..730beed 100644 --- a/npm/shellroute/README.md +++ b/npm/shellroute/README.md @@ -31,6 +31,35 @@ Use this when you need to reproduce country or IP-sensitive behavior from a term [Follow the two-minute quickstart](https://shellroute.com/docs/quickstart?utm_source=npm&utm_medium=package-readme&utm_campaign=exp_npmconv_01). -The CLI is open source and connects to the shellroute service. The service uses prepaid credits. +## Use your own proxy + +Already have a proxy, from a provider or your own server? Save it under a name you choose and use that name wherever a country code goes. No Shellroute account is needed and nothing is billed. + +`your-proxy-name` below is a placeholder: the alias you pick when saving the proxy. Replace `USER`, `PASSWORD`, `HOST` and `PORT` with what your provider gave you. + +```bash +# 1. Save it. Schemes: http, https (TLS to the proxy), socks5, socks5h. +shellroute upstream add your-proxy-name http://USER:PASSWORD@HOST:PORT + +# 2. Check it: one tunnel, exit IP, observed country, latency. +shellroute upstream test your-proxy-name + +# 3. Use it. +shellroute run your-proxy-name -- curl https://ipinfo.io/json # one command +shellroute # interactive shell, then: /connect your-proxy-name +shellroute proxy --upstream your-proxy-name # persistent local proxy on 127.0.0.1:41900 + +# Without saving, for example in CI: +shellroute run --proxy socks5://USER:PASSWORD@HOST:PORT -- curl https://ipinfo.io/json +SHELLROUTE_PROXY=http://USER:PASSWORD@HOST:PORT shellroute run -- curl https://ipinfo.io/json + +# Manage saved proxies. Passwords are shown as ***. +shellroute upstream list +shellroute upstream remove your-proxy-name +``` + +The command only ever sees the local proxy on `127.0.0.1`, so your proxy's credentials never reach it, your shell history or your CI logs. Where the proxy exits is observed when the route starts, not declared; a different exit per request is normal on rotating plans. + +The CLI is open source. Shellroute's built-in routes use prepaid credits; your own proxy needs no account. [GitHub](https://github.com/shellroute/shellroute-cli) · [Pricing](https://shellroute.com/pricing) · [Compatibility](https://shellroute.com/docs/compatibility) · [Acceptable use](https://shellroute.com/acceptable-use)