Skip to content

docs(cli): document railway sandbox forward command#1191

Open
codyde wants to merge 1 commit into
mainfrom
sandbox/forward-command-docs
Open

docs(cli): document railway sandbox forward command#1191
codyde wants to merge 1 commit into
mainfrom
sandbox/forward-command-docs

Conversation

@codyde

@codyde codyde commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

What

Documents the railway sandbox forward subcommand, which was missing from the CLI reference.

content/docs/cli/sandbox.md

  • Add forward (aliases port-forward, fwd) to the Subcommands table
  • Include forward in the Active sandbox note about commands that default to the active sandbox
  • Add usage examples: single port, LOCAL:REMOTE mapping, and multiple ports at once
  • Add an Options for forward table (<[LOCAL:]REMOTE>..., --id, -i/--identity-file, --strict), noting it runs over SSH and stays in the foreground

content/docs/sandboxes.md

  • Mention forwarding ports in the CLI overview
  • Cross-link railway sandbox forward from the Networking section for reaching a server inside a sandbox

Notes

Authored from the railway sandbox forward --help output (CLI 5.6.1). No SDK equivalent exists, so the SDK section is unchanged.

Add the forward subcommand to the railway sandbox CLI reference: a
subcommands table row, the active-sandbox note, usage examples, and an
options table. Cross-reference port forwarding from the sandboxes page.
@railway-app

railway-app Bot commented Jun 9, 2026

Copy link
Copy Markdown

🚅 Deployed to the docs-pr-1191 environment in 🪄 *.railway.com

Service Status Web Updated (UTC)
Docs Frontend ✅ Success (View Logs) Web Jun 9, 2026 at 12:14 am
6 services not affected by this PR
  • devicons
  • OG
  • Frontend Redis
  • Turnout
  • Meilisearch
  • Geofeed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant