Skip to content

Commit e989e6c

Browse files
authored
Update README.md
Improve CLI examples.
1 parent d828367 commit e989e6c

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ composer.json excerpt:
4949

5050
Example with flags, including launching the runner immediately:
5151
```
52+
export GITHUB_REPOSITORY=operations-project/github-runner-starter
53+
export GITHUB_TOKEN=ghp_***
5254
./github-runner-starter \
53-
--repo=owner/repo \
54-
--token=ghp_... \
5555
--labels=my-runner,linux \
5656
--run
5757
```
@@ -98,28 +98,24 @@ On SIGTERM (stop) the script attempts to stop the runner and unregister it using
9898
## Examples
9999
- Configure only (no immediate run):
100100
```
101-
./github-runner-starter --repo=owner/repo --token=ghp_...
101+
./github-runner-starter
102102
```
103103

104104
- Configure and run:
105105
```
106-
./github-runner-starter --repo=owner/repo --token=ghp_... --run
106+
./github-runner-starter --run
107107
```
108108

109109
- Custom path and labels:
110110
```
111111
./github-runner-starter \
112-
--repo=owner/repo \
113-
--token=ghp_... \
114112
--runner-path=/opt/gh-runner \
115113
--labels=linux,x64
116114
```
117115

118116
- Pass extra options to config.sh:
119117
```
120118
./github-runner-starter \
121-
--repo=owner/repo \
122-
--token=ghp_... \
123119
--config-sh-options="--ephemeral"
124120
```
125121

0 commit comments

Comments
 (0)