This is the command line interface for Railway. Use it to connect your code to Railway's infrastructure without needing to worry about environment variables or configuration.
The Railway command line interface (CLI) connects your code to your Railway project from the command line.
The Railway CLI allows you to
- Create new Railway projects from the terminal
- Link to an existing Railway project
- Pull down environment variables for your project locally to run
- Create services and databases right from the comfort of your fingertips
Currently pre-release. We are looking for feedback and suggestions. Please join our Discord to provide feedback.
cargo install railwayapp --lockedbrew install railwaynpm install -g @railway/cli# Install
bash <(curl -fsSL cli.new)
# Uninstall
bash <(curl -fsSL cli.new) -rscoop install railwayInstall using Paru
paru -S railwayapp-cliInstall using Yay
yay -S railwayapp-cliBefore using CLI in non-interactive environment make sure that you have created an access token (account or project scoped) and made it available via the RAILWAY_TOKEN environment variable.
Install from the command line
docker pull ghcr.io/railwayapp/cli:latestUse in GitHub Actions
deploy-job:
runs-on: ubuntu-latest
container: ghcr.io/railwayapp/cli:latest
env:
SVC_ID: my-service
RAILWAY_TOKEN: ${{ secrets.RAILWAY_TOKEN }}
steps:
- uses: actions/checkout@v3
- run: railway up --service=${{ env.SVC_ID }} -dUse in GitLab CICD
deploy-job:
image: ghcr.io/railwayapp/cli:latest
variables:
SVC_ID: my-service
script:
- railway up --service=$SVC_ID -d* GitLab can access a protected (secret) variable directly, all you need to do is to add it in CI/CD settings.
See CONTRIBUTING.md for information on setting up this repo locally.
We would love to hear your feedback or suggestions. The best way to reach us is on Discord.
We also welcome pull requests into this repo. See CONTRIBUTING.md for information on setting up this repo locally.
