Skip to content

docs: document railway ssh and clarify that railway run executes locally#30

Open
aspiers wants to merge 1 commit intorailwayapp:mainfrom
aspiers:fix/document-railway-ssh
Open

docs: document railway ssh and clarify that railway run executes locally#30
aspiers wants to merge 1 commit intorailwayapp:mainfrom
aspiers:fix/document-railway-ssh

Conversation

@aspiers
Copy link
Copy Markdown

@aspiers aspiers commented Mar 27, 2026

Summary

  • Adds a new Shell access section to operate.md documenting railway ssh for interactive shells and one-off commands inside running containers
  • Explicitly calls out that railway run is not railway sshrailway run executes locally with injected env vars, not inside the remote container
  • Adds railway ssh to the common quick operations table in SKILL.md
  • Adds execution rule Simplify install script #6 to SKILL.md warning that railway run is local-only
  • Updates Validated against with SSH docs and CLI source links

Motivation

Without this documentation, AI agents using this skill naturally reach for railway run when asked to execute a command "on" a service, since it's the only relevant command visible. This leads to silently wrong behaviour — the command runs locally, not remotely — and the agent has no way to know it made a mistake.

railway ssh is already used extensively in the analysis scripts (dal.py, analyze-*.py) but is never surfaced in the main skill references where agents would discover it.

- Add 'Shell access' section to operate.md covering railway ssh usage,
  the railway run vs railway ssh distinction, and SSH key setup
- Add railway ssh to the common quick operations table in SKILL.md
- Add execution rule railwayapp#6 explicitly warning that railway run is local
- Add ssh docs and CLI source to 'Validated against' block
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