@railway/cli 4.25.0 → 4.25.2
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 +38 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,40 +4,58 @@
|
|
|
4
4
|
[](https://github.com/railwayapp/cliv3/actions/workflows/ci.yml)
|
|
5
5
|
[](https://github.com/railwayapp/cli/actions/workflows/cargo-audit.yml)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## Overview
|
|
8
8
|
|
|
9
|
-
|
|
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
10
|
|
|
11
11
|
The Railway command line interface (CLI) connects your code to your Railway project from the command line.
|
|
12
12
|
|
|
13
|
-
The Railway CLI allows you to
|
|
13
|
+
The Railway CLI allows you to:
|
|
14
14
|
|
|
15
15
|
- Create new Railway projects from the terminal
|
|
16
16
|
- Link to an existing Railway project
|
|
17
17
|
- Pull down environment variables for your project locally to run
|
|
18
18
|
- Create services and databases right from the comfort of your fingertips
|
|
19
19
|
|
|
20
|
+
And more.
|
|
21
|
+
|
|
22
|
+
## Documentation
|
|
23
|
+
|
|
24
|
+
[View the CLI guide](https://docs.railway.com/guides/cli)
|
|
25
|
+
|
|
26
|
+
[View the CLI API reference](https://docs.railway.com/reference/cli-api)
|
|
27
|
+
|
|
28
|
+
## Quick start
|
|
29
|
+
|
|
30
|
+
Follow the [CLI guide](https://docs.railway.com/guides/cli) to install the CLI and run your first command.
|
|
31
|
+
|
|
32
|
+
## Authentication
|
|
33
|
+
|
|
34
|
+
For non-interactive authentication details, see the [CLI guide](https://docs.railway.com/guides/cli#tokens).
|
|
35
|
+
|
|
20
36
|
## Installation
|
|
21
37
|
|
|
22
|
-
###
|
|
38
|
+
### Package managers
|
|
39
|
+
|
|
40
|
+
#### Cargo
|
|
23
41
|
|
|
24
42
|
```bash
|
|
25
43
|
cargo install railwayapp --locked
|
|
26
44
|
```
|
|
27
45
|
|
|
28
|
-
|
|
46
|
+
#### Homebrew
|
|
29
47
|
|
|
30
48
|
```bash
|
|
31
49
|
brew install railway
|
|
32
50
|
```
|
|
33
51
|
|
|
34
|
-
|
|
52
|
+
#### NPM
|
|
35
53
|
|
|
36
54
|
```bash
|
|
37
55
|
npm install -g @railway/cli
|
|
38
56
|
```
|
|
39
57
|
|
|
40
|
-
|
|
58
|
+
#### Bash
|
|
41
59
|
|
|
42
60
|
```bash
|
|
43
61
|
# Install
|
|
@@ -47,21 +65,21 @@ bash <(curl -fsSL cli.new)
|
|
|
47
65
|
bash <(curl -fsSL cli.new) -r
|
|
48
66
|
```
|
|
49
67
|
|
|
50
|
-
|
|
68
|
+
#### Scoop
|
|
51
69
|
|
|
52
70
|
```ps1
|
|
53
71
|
scoop install railway
|
|
54
72
|
```
|
|
55
73
|
|
|
56
|
-
|
|
74
|
+
#### Arch Linux AUR
|
|
57
75
|
|
|
58
|
-
Install
|
|
76
|
+
Install with Paru
|
|
59
77
|
|
|
60
78
|
```bash
|
|
61
79
|
paru -S railwayapp-cli
|
|
62
80
|
```
|
|
63
81
|
|
|
64
|
-
Install
|
|
82
|
+
Install with Yay
|
|
65
83
|
|
|
66
84
|
```bash
|
|
67
85
|
yay -S railwayapp-cli
|
|
@@ -69,52 +87,26 @@ yay -S railwayapp-cli
|
|
|
69
87
|
|
|
70
88
|
### Docker
|
|
71
89
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
Install from the command line
|
|
90
|
+
#### Install from the command line
|
|
75
91
|
|
|
76
92
|
```bash
|
|
77
93
|
docker pull ghcr.io/railwayapp/cli:latest
|
|
78
94
|
```
|
|
79
95
|
|
|
80
|
-
Use in GitHub Actions
|
|
81
|
-
|
|
82
|
-
```yml
|
|
83
|
-
deploy-job:
|
|
84
|
-
runs-on: ubuntu-latest
|
|
85
|
-
container: ghcr.io/railwayapp/cli:latest
|
|
86
|
-
env:
|
|
87
|
-
SVC_ID: my-service
|
|
88
|
-
RAILWAY_TOKEN: ${{ secrets.RAILWAY_TOKEN }}
|
|
89
|
-
steps:
|
|
90
|
-
- uses: actions/checkout@v3
|
|
91
|
-
- run: railway up --service=${{ env.SVC_ID }}
|
|
92
|
-
```
|
|
96
|
+
#### Use in GitHub Actions
|
|
93
97
|
|
|
94
|
-
|
|
98
|
+
For GitHub Actions setup, see the blog post at [blog.railway.com/p/github-actions](https://blog.railway.com/p/github-actions).
|
|
95
99
|
|
|
96
|
-
|
|
97
|
-
deploy-job:
|
|
98
|
-
image: ghcr.io/railwayapp/cli:latest
|
|
99
|
-
variables:
|
|
100
|
-
SVC_ID: my-service
|
|
101
|
-
script:
|
|
102
|
-
- railway up --service=$SVC_ID
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
> [!TIP]
|
|
106
|
-
> GitLab can access a protected (secret) variable directly, all you need to do is to add it in CI/CD settings.
|
|
100
|
+
#### Use in GitLab CI/CD
|
|
107
101
|
|
|
108
|
-
|
|
102
|
+
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).
|
|
109
103
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
## Documentation
|
|
104
|
+
### Contributing
|
|
113
105
|
|
|
114
|
-
[
|
|
106
|
+
See [CONTRIBUTING.md](https://github.com/railwayapp/cli/blob/master/CONTRIBUTING.md) for information on setting up this repository locally.
|
|
115
107
|
|
|
116
108
|
## Feedback
|
|
117
109
|
|
|
118
|
-
We would love to hear your feedback or suggestions. The best way to reach us is on [
|
|
110
|
+
We would love to hear your feedback or suggestions. The best way to reach us is on [Central Station](https://station.railway.com/feedback).
|
|
119
111
|
|
|
120
|
-
We also welcome pull requests into this
|
|
112
|
+
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.
|