https://github.com/railwayapp/cli
Railway CLI
https://github.com/railwayapp/cli
cli infrastructure railway
Last synced: about 1 month ago
JSON representation
Railway CLI
- Host: GitHub
- URL: https://github.com/railwayapp/cli
- Owner: railwayapp
- License: mit
- Created: 2020-10-01T18:34:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-05T21:43:33.000Z (about 1 month ago)
- Last Synced: 2025-05-05T22:37:28.779Z (about 1 month ago)
- Topics: cli, infrastructure, railway
- Language: Rust
- Homepage: https://railway.app
- Size: 1.19 MB
- Stars: 366
- Watchers: 7
- Forks: 95
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Railway CLI
[](https://crates.io/crates/railwayapp)
[](https://github.com/railwayapp/cliv3/actions/workflows/ci.yml)
[](https://github.com/railwayapp/cli/actions/workflows/cargo-audit.yml)
This is the command line interface for [Railway](https://railway.com). Use it to connect your code to Railway's infrastructure without needing to worry about environment variables or configuration.
[View the docs](https://docs.railway.com/develop/cli)
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
## Status
Currently pre-release. We are looking for feedback and suggestions. Please join our [Discord](https://discord.gg/railway) to provide feedback.
## Installation
### Cargo
```bash
cargo install railwayapp --locked
```
### Homebrew
```bash
brew install railway
```
### NPM
```bash
npm install -g @railway/cli
```
### Bash
```bash
# Install
bash <(curl -fsSL cli.new)
# Uninstall
bash <(curl -fsSL cli.new) -r
```
### Scoop
```ps1
scoop install railway
```
### Arch Linux AUR
Install using Paru
```bash
paru -S railwayapp-cli
```
Install using Yay
```bash
yay -S railwayapp-cli
```
### Docker
Before using the CLI in a non-interactive environment, ensure you have created an access token (only project-tokens are supported as of now) and set it as the `RAILWAY_TOKEN` environment variable. CI environments are automatically detected by the presence of `CI=true` variable. In these environments, only build logs will be streamed, and the CLI will exit with an appropriate code indicating success or failure.
Install from the command line
```bash
docker pull ghcr.io/railwayapp/cli:latest
```
Use in GitHub Actions
```yml
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 }}
```
Use in GitLab CICD
```yml
deploy-job:
image: ghcr.io/railwayapp/cli:latest
variables:
SVC_ID: my-service
script:
- railway up --service=$SVC_ID
```
> [!TIP]
> GitLab can access a protected (secret) variable directly, all you need to do is to add it in CI/CD settings.
### From source
See [CONTRIBUTING.md](https://github.com/railwayapp/cli/blob/master/CONTRIBUTING.md) for information on setting up this repo locally.
## Documentation
[View the full documentation](https://docs.railway.com)
## Feedback
We would love to hear your feedback or suggestions. The best way to reach us is on [Discord](https://discord.gg/railway).
We also welcome pull requests into this repo. See [CONTRIBUTING.md](https://github.com/railwayapp/cli/blob/master/CONTRIBUTING.md) for information on setting up this repo locally.