@r5n/hydra 0.5.8 → 0.7.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/LICENSE CHANGED
@@ -1,201 +1 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
177
-
178
- APPENDIX: How to apply the Apache License to your work.
179
-
180
- To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
182
- replaced with your own identifying information. (Don't include
183
- the brackets!) The text should be enclosed in the appropriate
184
- comment syntax for the file format. We also recommend that a
185
- file or class name and description of purpose be included on the
186
- same "printed page" as the copyright notice for easier
187
- identification within third-party archives.
188
-
189
- Copyright R5N Labs
190
-
191
- Licensed under the Apache License, Version 2.0 (the "License");
192
- you may not use this file except in compliance with the License.
193
- You may obtain a copy of the License at
194
-
195
- http://www.apache.org/licenses/LICENSE-2.0
196
-
197
- Unless required by applicable law or agreed to in writing, software
198
- distributed under the License is distributed on an "AS IS" BASIS,
199
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
- See the License for the specific language governing permissions and
201
- limitations under the License.
1
+ See [../LICENSE](../LICENSE)
package/README.md CHANGED
@@ -1,364 +1,115 @@
1
- <div align="center">
2
- <a href="https://github.com/r5n-labs">
3
- <img src="https://avatars.githubusercontent.com/u/99986752?s=400&v=4" alt="R5N Labs" width="100" height="100">
4
- </a>
1
+ # Hydra
5
2
 
6
- <p><strong>The GitHub Runner Manager That Actually Scales 🚀</strong></p>
7
- <p><em>🏊 Made for developers who'd rather be coding than configuring</em></p>
8
-
9
- <h1>Hydra</h1>
3
+ Spawn and manage local self-hosted GitHub Actions runners.
10
4
 
11
- <p>
12
- <a href="https://www.npmjs.com/package/@r5n/hydra">
13
- <img src="https://img.shields.io/npm/v/@r5n/hydra.svg" alt="npm version">
14
- </a>
15
- <a href="https://github.com/r5n-labs/clis/blob/main/packages/hydra/LICENSE">
16
- <img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License">
17
- </a>
18
- <img src="https://img.shields.io/badge/bundle%20size-~73KB-green.svg" alt="Bundle Size">
19
- </p>
20
- </div>
5
+ [![npm version](https://img.shields.io/npm/v/@r5n/hydra.svg)](https://www.npmjs.com/package/@r5n/hydra) [![License](https://img.shields.io/npm/l/@r5n/hydra.svg)](./LICENSE)
21
6
 
22
- ---
7
+ Hydra registers runners against a GitHub repository or organization and runs them as background processes on the machine it runs on. All state lives in a `.hydra/` directory relative to your current working directory, so each directory you run it from is its own isolated runner fleet.
23
8
 
24
- ## Overview
9
+ ## Requirements
25
10
 
26
- Tired of manually setting up GitHub Actions runners? Hydra transforms hours of tedious work into a single command. Create, manage, and monitor dozens of self-hosted runners with the simplicity you've been craving.
11
+ - Bun (the published CLI runs on Bun)
12
+ - `gh` CLI, installed and authenticated (`gh auth login`) — Hydra mints runner registration and removal tokens via `gh api`; it never asks for or stores a token itself. Repository runners need admin access to the repository; organization runners need the `admin:org` scope.
13
+ - `bash`, `curl`, `tar`
14
+ - macOS (Apple Silicon) or Linux (x64). A `win-x64` runner download mapping exists in the code, but registration and startup shell out to `bash config.sh` / `bash run.sh`, so Windows is not actually supported.
27
15
 
28
- ### ✨ Why Hydra?
29
-
30
- - 🚀 **Lightning Fast** - Create 20 runners in the time it takes to manually create 1
31
- - 🔧 **Smart Profiles** - Define once, deploy anywhere with reusable configs
32
- - 📊 **Live Insights** - See exactly what your runners are doing in real-time
33
- - 🏃 **73KB of Pure Speed** - Installs before your coffee finishes brewing
34
- - 🎯 **Works Everywhere** - macOS, Linux, Windows - we've got you covered
35
-
36
- ## 🎯 What Can You Do?
37
-
38
- <details>
39
- <summary><strong>Create a fleet of runners in seconds</strong></summary>
16
+ ## Install
40
17
 
41
18
  ```bash
42
- $ hydra create -t $TOKEN -u https://github.com/myorg/repo -m 10 -l "gpu,docker"
43
- ⠋ Downloading runner package... (2.1s)
44
- ✔ Created runner gpu-runner-1
45
- ✔ Created runner gpu-runner-2
46
- ✔ Created runner gpu-runner-3
47
- ✔ Created runner gpu-runner-4
48
- ✔ Created runner gpu-runner-5
49
- ✔ Created runner gpu-runner-6
50
- ✔ Created runner gpu-runner-7
51
- ✔ Created runner gpu-runner-8
52
- ✔ Created runner gpu-runner-9
53
- ✔ Created runner gpu-runner-10
54
- ✅ All 10 runners created successfully in 8.3s
19
+ bun add -g @r5n/hydra
55
20
  ```
56
- </details>
57
21
 
58
- <details>
59
- <summary><strong>Monitor your runner army</strong></summary>
22
+ ## Quick start
60
23
 
61
24
  ```bash
62
- $ hydra status -p production
63
- ┌─────────────────┬─────────┬───────────┬──────────────┐
64
- │ Name │ Status │ Busy │ Labels │
65
- ├─────────────────┼─────────┼───────────┼──────────────┤
66
- │ prod-runner-1 │ ✅ Idle │ No │ linux,docker │
67
- │ prod-runner-2 │ ✅ Idle │ No │ linux,docker │
68
- │ prod-runner-3 │ 🔄 Busy │ Yes (2m) │ linux,docker │
69
- │ prod-runner-4 │ ✅ Idle │ No │ linux,docker │
70
- │ prod-runner-5 │ ❌ Offline │ - │ linux,docker │
71
- └─────────────────┴─────────┴───────────┴──────────────┘
72
- Summary: 3 idle, 1 busy, 1 offline
25
+ mkdir ~/runners && cd ~/runners
26
+ hydra init https://github.com/owner/repo -c 2
27
+ hydra create
28
+ hydra start
29
+ hydra status
73
30
  ```
74
- </details>
75
31
 
76
- <details>
77
- <summary><strong>Monitor runner status</strong></summary>
32
+ Bare `hydra` prints help. `hydra -i` opens an interactive menu that walks through the same commands with prompts. `hydra help <command>` or `hydra <command> --help` shows per-command usage.
78
33
 
79
- ```bash
80
- $ hydra status -p production
81
- 🔍 Checking runner status...
82
- ✅ Runner 1: Online (idle)
83
- ✅ Runner 2: Online (busy - job #1234)
84
- ✅ Runner 3: Online (idle)
85
- ✓ Created runner-4
86
- ✓ Created runner-5
87
-
88
- 🔍 Monitoring continues... (press Ctrl+C to stop)
89
- ```
90
- </details>
34
+ ## Commands
91
35
 
92
- ## 📦 Installation
36
+ ### init
93
37
 
94
- ```bash
95
- # Using Bun (recommended)
96
- bun add -g @r5n/hydra
97
- hydra --help
38
+ `hydra init [url]` writes a profile to `.hydra/config.json`. The first profile becomes the default. Run with no arguments it opens an interactive form; when any positional or piped input is involved the URL is required.
98
39
 
99
- # Direct usage (no installation)
100
- bunx @r5n/hydra --help
101
- ```
40
+ - `-p, --profile` profile name (default: `default`)
41
+ - `-n, --name` base name for runners (default: `runner`)
42
+ - `-c, --runners` number of runners (default: 1)
43
+ - `-l, --labels` comma-separated extra labels
44
+ - `-f, --force` overwrite an existing profile
102
45
 
103
- ## 🚀 Quick Start
46
+ ### create
104
47
 
105
- ### 1. Initialize Configuration
48
+ `hydra create [profile] [count]` downloads the latest `actions/runner` release (once per version, shared across runners), then registers runners named `<name>-1`, `<name>-2`, … It tops up to the target count: if the profile already has enough runners recorded, it does nothing. `count` overrides the profile's `numberOfMachines`.
106
49
 
107
- ```bash
108
- # Interactive setup
109
- hydra init
50
+ ### start / stop
110
51
 
111
- # Use TOML format
112
- hydra init --toml
113
- ```
52
+ `hydra start [profile] [ids...]` launches each runner's `run.sh` as a detached background process and records its pid. `hydra stop [profile] [ids...]` kills them. Omit the ids to target every runner in the profile; omit the profile to use the default. Runners do not survive a reboot — run `hydra start` again.
114
53
 
115
- ### 2. Create Runners
54
+ ### status
116
55
 
117
- ```bash
118
- # Basic usage
119
- hydra create -t YOUR_TOKEN -u https://github.com/org/repo
56
+ `hydra status` lists every profile's runners with their state (`running` with pid, `registered`, or `unknown`). State is determined locally from pid liveness and the runner's `.runner` file; no API calls.
120
57
 
121
- # Create multiple runners with labels
122
- hydra create -t YOUR_TOKEN -u REPO_URL -m 3 -l "docker,gpu"
58
+ ### logs
123
59
 
124
- # Using a profile
125
- hydra create -p production -t YOUR_TOKEN
126
- ```
60
+ `hydra logs [id]` tails the newest job log (`Worker_*.log`) from the runner's `_diag` directory. If no job has run yet it falls back to the runner daemon log with a warning. The id can be omitted when there is exactly one runner.
127
61
 
128
- ### 3. Monitor Status
62
+ - `-n, --lines` lines to tail (default: 100)
63
+ - `-r, --runner` show the runner daemon log (`Runner_*.log`) instead of the job log
64
+ - `-l, --list` list available log files with timestamps and sizes
65
+ - `-o, --open` open the log in `$EDITOR` (falls back to `open` on macOS)
129
66
 
130
- ```bash
131
- # Check runner status
132
- hydra status -t YOUR_TOKEN -u REPO_URL
67
+ ### update
133
68
 
134
- # JSON output for automation
135
- hydra status -t YOUR_TOKEN -u REPO_URL --json
136
- ```
69
+ `hydra update` checks the latest `actions/runner` release, and if it differs from the installed version, swaps the binaries for every runner. Runners that were running are stopped, updated, and restarted.
137
70
 
138
- ## 📖 Commands
139
-
140
- ### `hydra init`
141
- Initialize a new configuration file with profiles.
142
-
143
- **Options:**
144
- - `-t, --toml` - Use TOML format instead of JSON
145
-
146
- ### `hydra create`
147
- Create and register new GitHub runner machines.
148
-
149
- **Options:**
150
- - `-t, --token` - GitHub Personal Access Token (required)
151
- - `-u, --url` - GitHub repository/organization URL (required)
152
- - `-m, --numberOfMachines` - Number of runners to create (default: 1)
153
- - `-n, --name` - Runner name prefix (default: "runner")
154
- - `-l, --labels` - Comma-separated custom labels
155
- - `-d, --directory` - Runners directory (default: "./gh-runners")
156
- - `-o, --os` - Operating system: osx, linux, windows (default: "osx")
157
- - `-O, --overwrite` - Overwrite existing runners
158
- - `-p, --profile` - Use configuration profile
159
- - `-c, --config` - Configuration file path
160
-
161
- ### `hydra run`
162
- Start existing GitHub runner machines.
163
-
164
- **Options:**
165
- - `-t, --token` - GitHub Personal Access Token (required)
166
- - `-u, --url` - GitHub repository/organization URL (required)
167
- - `-m, --numberOfMachines` - Number of runners (default: 1)
168
- - `-n, --name` - Runner name prefix
169
- - `-d, --directory` - Runners directory
170
- - `-p, --profile` - Use configuration profile
171
- - `-c, --config` - Configuration file path
172
-
173
- ### `hydra remove`
174
- Remove GitHub runner machines.
175
-
176
- **Options:**
177
- - `-t, --token` - GitHub Personal Access Token (required)
178
- - `-u, --url` - GitHub repository/organization URL (required)
179
- - `-m, --numberOfMachines` - Number of runners (default: 1)
180
- - `-n, --name` - Runner name prefix
181
- - `-d, --directory` - Runners directory
182
- - `-f, --force` - Force removal without unregistering
183
- - `-p, --profile` - Use configuration profile
184
- - `-c, --config` - Configuration file path
185
-
186
- ### `hydra status`
187
- Check the status of GitHub runner machines.
188
-
189
- **Options:**
190
- - `-t, --token` - GitHub Personal Access Token (required)
191
- - `-u, --url` - GitHub repository/organization URL (required)
192
- - `-d, --directory` - Runners directory
193
- - `-j, --json` - Output as JSON
194
- - `-p, --profile` - Use configuration profile
195
- - `-c, --config` - Configuration file path
196
-
197
- ### `hydra help`
198
- Show help information for commands.
71
+ ### remove
199
72
 
200
- ```bash
201
- hydra help
202
- hydra help create
203
- hydra create --help
204
- ```
73
+ `hydra remove [profile] [ids...]` stops the runners, deregisters them from GitHub, and deletes their directories.
205
74
 
206
- ## 🔧 Configuration
75
+ ### profile
207
76
 
208
- ### The Magic of Profiles 🎭
77
+ - `hydra profile list` — profiles with URL, OS, and created/running counts
78
+ - `hydra profile default <name>` — set the default profile
79
+ - `hydra profile remove <name>` — remove a profile; if it has runners, stops and deregisters them first (after confirmation)
209
80
 
210
- Stop typing the same commands over and over. Profiles let you define your runner configurations once and reuse them everywhere:
81
+ ## Configuration
211
82
 
212
- #### Example: `hydra.json`
83
+ `.hydra/config.json`, resolved relative to the working directory. Hydra writes it; the `profiles` section is safe to edit by hand:
213
84
 
214
85
  ```json
215
86
  {
87
+ "defaultProfile": "default",
216
88
  "profiles": {
217
89
  "default": {
90
+ "url": "https://github.com/owner/repo",
218
91
  "name": "runner",
219
- "numberOfMachines": 1,
220
- "directory": "./gh-runners",
221
- "os": "osx"
222
- },
223
- "production": {
224
- "url": "https://github.com/org/repo",
225
- "name": "prod-runner",
226
- "numberOfMachines": 3,
227
- "labels": "production,linux,docker",
228
- "directory": "/opt/runners/prod",
229
- "os": "linux"
230
- },
231
- "development": {
232
- "url": "https://github.com/org/dev-repo",
233
- "name": "dev-runner",
234
92
  "numberOfMachines": 2,
235
- "labels": "development,test",
236
- "directory": "./dev-runners"
93
+ "labels": "macOS,ARM64",
94
+ "directory": ".hydra/runners",
95
+ "os": "osx",
96
+ "provider": "github",
97
+ "overwrite": false,
98
+ "run": false
237
99
  }
238
100
  },
239
- "defaultProfile": "default"
101
+ "runners": []
240
102
  }
241
103
  ```
242
104
 
243
- #### Example: `hydra.toml`
244
-
245
- ```toml
246
- defaultProfile = "default"
247
-
248
- [profiles.default]
249
- name = "runner"
250
- numberOfMachines = 1
251
- directory = "./gh-runners"
252
- os = "linux"
253
-
254
- [profiles.production]
255
- url = "https://github.com/org/repo"
256
- name = "prod-runner"
257
- numberOfMachines = 3
258
- labels = "production,linux,docker"
259
- directory = "/opt/runners/prod"
260
- os = "linux"
261
- ```
262
-
263
- ### Environment Variables
264
-
265
- - `GITHUB_PERSONAL_ACCESS_TOKEN` - Default token if not provided via CLI
266
- - `HYDRA_CONFIG` - Default configuration file path
267
-
268
- ## 📂 Directory Structure
269
-
270
- ```
271
- ./gh-runners/ # Default runner directory
272
- ├── machines/
273
- │ ├── 1/ # Runner instance 1
274
- │ │ ├── _diag/ # Diagnostics logs
275
- │ │ ├── _work/ # Job working directory
276
- │ │ ├── config.sh # Runner configuration
277
- │ │ └── run.sh # Runner execution script
278
- │ ├── 2/ # Runner instance 2
279
- │ └── .../
280
- └── actions-runner-*.tar.gz # Downloaded runner package
281
- ```
282
-
283
- ## 🔐 Security
284
-
285
- ### Token Requirements
286
-
287
- - **Repository runners**: Token needs `repo` scope
288
- - **Organization runners**: Token needs `admin:org` scope
289
- - Tokens are never stored in configuration files
290
- - Use environment variables for automation
291
-
292
- ### Best Practices
293
-
294
- 1. Never commit tokens to version control
295
- 2. Use read-only tokens when possible
296
- 3. Rotate tokens regularly
297
-
298
- ## 📊 Examples
299
-
300
- ### CI/CD Pipeline Setup
301
-
302
- ```bash
303
- # Development environment
304
- hydra create -p development -t $GITHUB_TOKEN -m 2
305
-
306
- # Production with specific labels
307
- hydra create -p production -t $GITHUB_TOKEN -l "deploy,production"
308
-
309
- # Temporary test runners
310
- hydra create -t $GITHUB_TOKEN -u $REPO_URL -n "test" -m 5
311
- hydra remove -t $GITHUB_TOKEN -u $REPO_URL -n "test" -m 5
312
- ```
313
-
314
- ### Monitoring Script
315
-
316
- ```bash
317
- #!/bin/bash
318
- # Check runner status and alert if offline
319
-
320
- STATUS=$(hydra status -p production -t $GITHUB_TOKEN --json)
321
- OFFLINE=$(echo $STATUS | jq '[.[] | select(.status == "offline")] | length')
322
-
323
- if [ $OFFLINE -gt 0 ]; then
324
- echo "Alert: $OFFLINE runners are offline!"
325
- fi
326
- ```
327
-
328
- ## 🐛 Troubleshooting
329
-
330
- ### Common Issues
331
-
332
- 1. **"Invalid GitHub token"**
333
- - Verify token permissions (repo/admin:org scope)
334
- - Check token expiration
335
-
336
- 2. **"Runner configuration failed"**
337
- - Check network connectivity
338
- - Verify GitHub URL format
339
- - Ensure write permissions in runner directory
340
-
341
- 3. **"No runners found"**
342
- - Verify runner directory path
343
- - Check if runners were created successfully
344
- - Ensure profile name is correct
345
-
346
- ### Debug Mode
347
-
348
- ```bash
349
- # Run with debug logging
350
- DEBUG=* hydra create -t TOKEN -u URL
351
-
352
- # Check runner diagnostics (if needed)
353
- cat ./gh-runners/machines/1/_diag/*.log
354
- ```
105
+ `os` is one of `osx` | `linux` | `windows` (auto-detected by `init`). An optional `runnerGroup` string is passed through to `config.sh --runnergroup`; runner groups only apply to organization runners. The `runners` array is Hydra's record of what it created — leave it alone.
355
106
 
356
- ## 🤝 Contributing
107
+ The `url` is either a repository URL (`https://github.com/owner/repo`) or an organization URL (`https://github.com/org`). Repository URLs mint tokens from the repository endpoint (requires repo admin); organization URLs use the organization endpoint (requires the `admin:org` scope).
357
108
 
358
- Contributions are welcome! Please see the [main repository](https://github.com/r5n-labs/clis) for contribution guidelines.
109
+ ## How it works
359
110
 
360
- ## 📄 License
111
+ Runner binaries are downloaded once per version into `.hydra/shared/github/<version>`. Each runner directory under `.hydra/runners/<id>` gets hardlinks for `bin`, a symlink for `externals`, and its own copies of the shell scripts, so ten runners cost roughly one copy of the runner distribution on disk. Start/stop is plain process management: a detached `bash run.sh` plus a pid file per runner.
361
112
 
362
- Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for details.
113
+ ## License
363
114
 
364
- ---
115
+ Apache-2.0 — see [LICENSE](./LICENSE)