@railway/cli 4.50.0 → 4.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -86
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,135 +1,77 @@
|
|
|
1
1
|
# Railway CLI
|
|
2
2
|
|
|
3
|
-
[
|
|
4
|
-
[](https://github.com/railwayapp/cliv3/actions/workflows/ci.yml)
|
|
5
|
-
[](https://github.com/railwayapp/cli/actions/workflows/cargo-audit.yml)
|
|
3
|
+
The Railway CLI lets you interact with your Railway projects from the command line. Read the [CLI documentation](https://docs.railway.com/cli).
|
|
6
4
|
|
|
7
|
-
##
|
|
8
|
-
|
|
9
|
-
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.
|
|
10
|
-
|
|
11
|
-
The Railway command line interface (CLI) connects your code to your Railway project from the command line.
|
|
12
|
-
|
|
13
|
-
The Railway CLI allows you to:
|
|
14
|
-
|
|
15
|
-
- Create new Railway projects from the terminal
|
|
16
|
-
- Link to an existing Railway project
|
|
17
|
-
- Pull down environment variables for your project locally to run
|
|
18
|
-
- Create services and databases right from the comfort of your fingertips
|
|
19
|
-
|
|
20
|
-
And more.
|
|
21
|
-
|
|
22
|
-
## Agent Skills
|
|
5
|
+
## Installation
|
|
23
6
|
|
|
24
|
-
Install
|
|
7
|
+
Install the CLI with the Bash script on macOS, Linux, or Windows through WSL:
|
|
25
8
|
|
|
26
9
|
```bash
|
|
27
|
-
|
|
10
|
+
bash <(curl -fsSL cli.new)
|
|
28
11
|
```
|
|
29
12
|
|
|
30
|
-
|
|
13
|
+
Install the CLI and configure Railway agent support:
|
|
31
14
|
|
|
32
15
|
```bash
|
|
33
|
-
|
|
16
|
+
bash <(curl -fsSL cli.new) --agents -y
|
|
34
17
|
```
|
|
35
18
|
|
|
36
|
-
|
|
19
|
+
Uninstall the CLI:
|
|
37
20
|
|
|
38
21
|
```bash
|
|
39
|
-
|
|
22
|
+
bash <(curl -fsSL cli.new) -r
|
|
40
23
|
```
|
|
41
24
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
[View the CLI guide](https://docs.railway.com/guides/cli)
|
|
45
|
-
|
|
46
|
-
[View the CLI API reference](https://docs.railway.com/reference/cli-api)
|
|
47
|
-
|
|
48
|
-
## Quick start
|
|
49
|
-
|
|
50
|
-
Follow the [CLI guide](https://docs.railway.com/guides/cli) to install the CLI and run your first command.
|
|
25
|
+
Other installation methods are available in the CLI documentation: [Homebrew](https://docs.railway.com/cli#homebrew-macos), [npm](https://docs.railway.com/cli#npm-macos-linux-windows), [Scoop](https://docs.railway.com/cli#scoop-windows), [pre-built binaries](https://docs.railway.com/cli#pre-built-binaries), and [source builds](https://docs.railway.com/cli#from-source).
|
|
51
26
|
|
|
52
27
|
## Authentication
|
|
53
28
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
## Installation
|
|
57
|
-
|
|
58
|
-
### Package managers
|
|
59
|
-
|
|
60
|
-
#### Cargo
|
|
29
|
+
Before using the CLI, authenticate with your Railway account:
|
|
61
30
|
|
|
62
31
|
```bash
|
|
63
|
-
|
|
32
|
+
railway login
|
|
64
33
|
```
|
|
65
34
|
|
|
66
|
-
|
|
35
|
+
For environments without a browser, such as SSH sessions, use browserless login:
|
|
67
36
|
|
|
68
37
|
```bash
|
|
69
|
-
|
|
38
|
+
railway login --browserless
|
|
70
39
|
```
|
|
71
40
|
|
|
72
|
-
|
|
41
|
+
### Tokens
|
|
73
42
|
|
|
74
|
-
|
|
75
|
-
npm install -g @railway/cli
|
|
76
|
-
```
|
|
43
|
+
For CI/CD pipelines, set environment variables instead of using interactive login:
|
|
77
44
|
|
|
78
|
-
|
|
45
|
+
- Project token: Set `RAILWAY_TOKEN` for project-level actions.
|
|
46
|
+
- Account or workspace token: Set `RAILWAY_API_TOKEN` for account-level or workspace-level actions.
|
|
79
47
|
|
|
80
48
|
```bash
|
|
81
|
-
|
|
82
|
-
bash <(curl -fsSL cli.new)
|
|
83
|
-
|
|
84
|
-
# Install and configure Railway agent support
|
|
85
|
-
bash <(curl -fsSL cli.new) --agents -y
|
|
86
|
-
|
|
87
|
-
# Uninstall
|
|
88
|
-
bash <(curl -fsSL cli.new) -r
|
|
49
|
+
RAILWAY_TOKEN=xxx railway up
|
|
89
50
|
```
|
|
90
51
|
|
|
91
|
-
|
|
52
|
+
See [Tokens](https://docs.railway.com/integrations/api#creating-a-token) for more information.
|
|
92
53
|
|
|
93
|
-
|
|
94
|
-
scoop install railway
|
|
95
|
-
```
|
|
54
|
+
## Agent Setup
|
|
96
55
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
Install with Paru
|
|
56
|
+
Configure Railway agent support for AI coding tools:
|
|
100
57
|
|
|
101
58
|
```bash
|
|
102
|
-
|
|
59
|
+
railway setup agent -y
|
|
103
60
|
```
|
|
104
61
|
|
|
105
|
-
|
|
62
|
+
This installs Railway skills and configures the Railway MCP server for detected tools such as Claude Code, Cursor, Codex, OpenCode, GitHub Copilot, and Factory Droid.
|
|
106
63
|
|
|
107
|
-
|
|
108
|
-
yay -S railwayapp-cli
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
### Docker
|
|
112
|
-
|
|
113
|
-
#### Install from the command line
|
|
64
|
+
Use the focused commands when you only need one part of the setup:
|
|
114
65
|
|
|
115
66
|
```bash
|
|
116
|
-
|
|
67
|
+
railway mcp install --agent cursor
|
|
68
|
+
railway skills --agent claude-code
|
|
117
69
|
```
|
|
118
70
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
For GitHub Actions setup, see the blog post at [blog.railway.com/p/github-actions](https://blog.railway.com/p/github-actions).
|
|
122
|
-
|
|
123
|
-
#### Use in GitLab CI/CD
|
|
124
|
-
|
|
125
|
-
For GitLab CI/CD setup, see the blog post at [blog.railway.com/p/gitlab-ci-cd](https://blog.railway.com/p/gitlab-ci-cd).
|
|
126
|
-
|
|
127
|
-
### Contributing
|
|
71
|
+
## Contributing
|
|
128
72
|
|
|
129
73
|
See [CONTRIBUTING.md](https://github.com/railwayapp/cli/blob/master/CONTRIBUTING.md) for information on setting up this repository locally.
|
|
130
74
|
|
|
131
75
|
## Feedback
|
|
132
76
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
We also welcome pull requests into this repository. See [CONTRIBUTING.md](https://github.com/railwayapp/cli/blob/master/CONTRIBUTING.md) for information on setting up this repository locally.
|
|
77
|
+
Share feedback and suggestions on [Central Station](https://station.railway.com/feedback).
|