Railway CLI

Overview

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

And more.

Documentation

View the CLI guide

View the CLI API reference

Quick start

Follow the CLI guide to install the CLI and run your first command.

Authentication

For non-interactive authentication details, see the CLI guide.

Installation

Package managers

Cargo

cargo install railwayapp --locked

Homebrew

brew install railway

NPM

npm install -g @railway/cli

Bash

# Install
bash <(curl -fsSL cli.new)

# Uninstall
bash <(curl -fsSL cli.new) -r

Scoop

scoop install railway

Arch Linux AUR

Install with Paru

paru -S railwayapp-cli

Install with Yay

yay -S railwayapp-cli

Docker

Install from the command line

docker pull ghcr.io/railwayapp/cli:latest

Use in GitHub Actions

For GitHub Actions setup, see the blog post at blog.railway.com/p/github-actions.

Use in GitLab CI/CD

For GitLab CI/CD setup, see the blog post at blog.railway.com/p/gitlab-ci-cd.

Contributing

See CONTRIBUTING.md for information on setting up this repository locally.

Feedback

We would love to hear your feedback or suggestions. The best way to reach us is on Central Station.

We also welcome pull requests into this repository. See CONTRIBUTING.md for information on setting up this repository locally.