@railway/cli 3.11.4 → 3.14.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 +46 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -51,6 +51,52 @@ bash <(curl -fsSL cli.new) -r
|
|
|
51
51
|
scoop install railway
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
+
### Arch Linux AUR
|
|
55
|
+
|
|
56
|
+
Install using Paru
|
|
57
|
+
```bash
|
|
58
|
+
paru -S railwayapp-cli
|
|
59
|
+
```
|
|
60
|
+
Install using Yay
|
|
61
|
+
```bash
|
|
62
|
+
yay -S railwayapp-cli
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Docker
|
|
66
|
+
|
|
67
|
+
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.
|
|
68
|
+
|
|
69
|
+
Install from the command line
|
|
70
|
+
```bash
|
|
71
|
+
docker pull ghcr.io/railwayapp/cli:latest
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Use in GitHub Actions
|
|
75
|
+
```yml
|
|
76
|
+
deploy-job:
|
|
77
|
+
runs-on: ubuntu-latest
|
|
78
|
+
container: ghcr.io/railwayapp/cli:latest
|
|
79
|
+
env:
|
|
80
|
+
SVC_ID: my-service
|
|
81
|
+
RAILWAY_TOKEN: ${{ secrets.RAILWAY_TOKEN }}
|
|
82
|
+
steps:
|
|
83
|
+
- uses: actions/checkout@v3
|
|
84
|
+
- run: railway up --service=${{ env.SVC_ID }}
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Use in GitLab CICD
|
|
88
|
+
```yml
|
|
89
|
+
deploy-job:
|
|
90
|
+
image: ghcr.io/railwayapp/cli:latest
|
|
91
|
+
variables:
|
|
92
|
+
SVC_ID: my-service
|
|
93
|
+
script:
|
|
94
|
+
- railway up --service=$SVC_ID
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
> [!TIP]
|
|
98
|
+
> GitLab can access a protected (secret) variable directly, all you need to do is to add it in CI/CD settings.
|
|
99
|
+
|
|
54
100
|
### From source
|
|
55
101
|
See [CONTRIBUTING.md](https://github.com/railwayapp/cli/blob/master/CONTRIBUTING.md) for information on setting up this repo locally.
|
|
56
102
|
|