You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is the command line interface for [Railway](https://railway.app). Use it to connect your code to Railway's infrastructure without needing to worry about environment variables or configuration.
7
+
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.
8
8
9
-
[View the docs](https://docs.railway.app/develop/cli)
9
+
[View the docs](https://docs.railway.com/develop/cli)
10
10
11
11
The Railway command line interface (CLI) connects your code to your Railway project from the command line.
12
12
@@ -18,47 +18,55 @@ The Railway CLI allows you to
18
18
- Create services and databases right from the comfort of your fingertips
19
19
20
20
## Status
21
+
21
22
Currently pre-release. We are looking for feedback and suggestions. Please join our [Discord](https://discord.gg/railway) to provide feedback.
22
23
23
24
## Installation
24
25
25
26
### Cargo
27
+
26
28
```bash
27
29
cargo install railwayapp --locked
28
30
```
29
31
30
32
### Homebrew
31
33
32
-
```bash
34
+
```bash
33
35
brew install railway
34
36
```
35
37
36
38
### NPM
39
+
37
40
```bash
38
41
npm install -g @railway/cli
39
42
```
40
43
41
44
### Bash
45
+
42
46
```bash
43
-
# Install
47
+
# Install
44
48
bash <(curl -fsSL cli.new)
45
49
46
50
# Uninstall
47
51
bash <(curl -fsSL cli.new) -r
48
52
```
49
53
50
54
### Scoop
55
+
51
56
```ps1
52
57
scoop install railway
53
58
```
54
59
55
60
### Arch Linux AUR
56
61
57
62
Install using Paru
63
+
58
64
```bash
59
65
paru -S railwayapp-cli
60
66
```
67
+
61
68
Install using Yay
69
+
62
70
```bash
63
71
yay -S railwayapp-cli
64
72
```
@@ -68,11 +76,13 @@ yay -S railwayapp-cli
68
76
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.
69
77
70
78
Install from the command line
79
+
71
80
```bash
72
81
docker pull ghcr.io/railwayapp/cli:latest
73
82
```
74
83
75
84
Use in GitHub Actions
85
+
76
86
```yml
77
87
deploy-job:
78
88
runs-on: ubuntu-latest
@@ -86,6 +96,7 @@ deploy-job:
86
96
```
87
97
88
98
Use in GitLab CICD
99
+
89
100
```yml
90
101
deploy-job:
91
102
image: ghcr.io/railwayapp/cli:latest
@@ -99,10 +110,12 @@ deploy-job:
99
110
> GitLab can access a protected (secret) variable directly, all you need to do is to add it in CI/CD settings.
100
111
101
112
### From source
113
+
102
114
See [CONTRIBUTING.md](https://github.com/railwayapp/cli/blob/master/CONTRIBUTING.md) for information on setting up this repo locally.
103
115
104
116
## Documentation
105
-
[View the full documentation](https://docs.railway.app)
117
+
118
+
[View the full documentation](https://docs.railway.com)
0 commit comments