CLI API Reference
The Railway Command Line Interface (CLI) lets you interact with your Railway project from the command line.
This document describes the commands available in the CLI.
For information on how to install the CLI and more examples of usage, see the CLI guide.
Add a plugin to your project
Generate a shell-completions for the following shells:
Connect to a plugin's shell (
psql for Postgres,
mongosh for MongoDB, etc.)
This requires you to have the plugin's appropriate shell/client installed in your
Interactively delete a plugin
You will be prompted to select a plugin to delete, and if you have 2FA enabled, you will be prompted to enter your 2FA code.
Create a domain for a service
Open the Railway documentation site in the default browser
Remove the most recent deployment
Change which environment you are using
View environment docs for more information.
If you run
railway environment without specifying a name, you will be prompted
with an environment selector that lists all your environments for the project.
Help command reference
Create a new Project from the CLI
Connect to an existing Railway project
link with no project ID will prompt you to select a team and project.
List all projects in your Railway account
Login to your Railway account
This will open the browser to
If you are in an environment where the terminal cannot open a web browser, (i.e. SSH session or Codespaces), you can perform a browserless login.
This will prompt you to go to a URL (you can copy and paste) and present you with a 4 word code that you need to verify. If the codes match, click "Verify" and you will be logged in.
Logout of your Railway account
View logs for the most recent deployment
Open your current Railway project in the browser
Run a command using the Railway environment
This also injects all environment variables associated with the plugins you have installed in your project.
Link a service to the current project
Create a subshell (based on
$SHELL) with all the variables from your project/environment/service loaded and accessible
View the status of your Railway project and user
Disconnects the current directory from Railway
You will need to rerun
railway link to use
railway in this directory again.
Deploy a directory to your Railway project
If no path is provided, the top linked directory is deployed. The currently selected environment is used.
View a table of all the environment variables associated with your project and environment
View what user is currently authenticated with Railway
Edit this file on GitHub