Skip to content

docs: add use-case bridge and direct-mode example to READMEs #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cvl merged 1 commit into from
Sep 28, 2026
Merged

docs: add use-case bridge and direct-mode example to READMEs #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

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

```bash
Expand Down Expand Up @@ -45,7 +47,7 @@ curl https://ipinfo.io/json
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=cli_readme).
[Read the full quickstart](https://shellroute.com/docs/quickstart?utm_source=github&utm_medium=readme&utm_campaign=exp_ghconv_01).

## Commands

Expand Down
10 changes: 9 additions & 1 deletion npm/shellroute/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,15 @@ shellroute login
curl https://ipinfo.io/json
```

[Follow the two-minute quickstart](https://shellroute.com/docs/quickstart?utm_source=npm&utm_medium=package-readme&utm_campaign=cli_readme).
Or route a single command through another country:

```bash
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).

The CLI is open source and connects to the shellroute service. The service uses prepaid credits.

Expand Down
Loading