CLI

Use the Railway CLI to connect your code to your projects infrastructure without needing to worry about environment variables or configuration.

Install

Install with Brew or NPM.

Homebrew

NPM

Shell Script

You can also install from source.

Login

Login to your Railway account. Opens a browser tab which authenticates into an existing Railway session.

If there are any issues with Browser based login you can use the --browserless flag to authenticate.

Project Token Authentication

You can use Project tokens to authenticate in environments that prevent you to authenticate with browsers such as CI environments.

Project tokens allow the CLI to access all the environment variables associated with a specific project and environment. Use the token by setting the RAILWAY_TOKEN environment variable and then running railway run.

Link to an existing Project under your Railway account or team.

Screenshot of Railway

Create a Project

Create a new project directly from the command line.

Run

Run code inside your Railway environment. We connect your code to your infrastructure hosted on Railway by injecting environment variables.

For example, to run your node project with Railway:

If you have a Dockerfile in your project directory, you can just run railway run with no arguments to build and run the Dockerfile.

Environments

Projects might have multiple environments, by default the CLI points to the production environment. If you'd like to use a different set of environment variables and a different deployment environment you can change the setting by:

Deploy

Deploy current directory to Railway. Displays deployment logs from the project deploys.

Add Plugin

Provision a plugin for a project.

Connect to Plugin

Open an interactive shell to a database directly in the CLI.

Logout


Edit this file on GitHub