@fibteq/altair-runner 0.1.0 → 0.2.1
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 +28 -7
- package/dist/cli.js +83 -39
- package/dist/index.js +76 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ Gemini CLI.
|
|
|
10
10
|
- The CLI runs with **your own login on your computer**. altair-runner never reads, sends or stores your Claude,
|
|
11
11
|
OpenAI or Google credentials. The only secret it keeps is its own Altair runner token, in
|
|
12
12
|
`~/.altair-runner/config.json` (readable by you only).
|
|
13
|
-
- It only works in folders you shared with `altair-runner share`. A path from the server that is not one of them
|
|
13
|
+
- It only works in folders you shared, from Altair > Devices or with `altair-runner share`. A path from the server that is not one of them
|
|
14
14
|
(after resolving symlinks) is refused.
|
|
15
15
|
|
|
16
16
|
## Use
|
|
@@ -18,17 +18,38 @@ Gemini CLI.
|
|
|
18
18
|
Requires Node 22+ and at least one of `claude`, `codex` or `gemini` on your `PATH`, already signed in.
|
|
19
19
|
|
|
20
20
|
```sh
|
|
21
|
-
altair-runner pair ABCD-1234 --server https://altair.example.com # code from Altair > Devices
|
|
22
|
-
|
|
23
|
-
altair-runner start # leave it running
|
|
21
|
+
npx altair-runner pair ABCD-1234 --server https://altair.example.com # code from Altair > Devices
|
|
22
|
+
npx altair-runner service install # runs now and at every login
|
|
24
23
|
```
|
|
25
24
|
|
|
26
|
-
|
|
27
|
-
|
|
25
|
+
Then add folders in Altair > Devices with **Add folder**: it browses this computer's folders through the runner
|
|
26
|
+
(folder names only, never files) and shares the one you pick. The home folder itself and the disk root cannot be
|
|
27
|
+
shared. From a terminal, `altair-runner share [folder]` and `altair-runner unshare <folder>` do the same.
|
|
28
|
+
|
|
29
|
+
Other commands: `altair-runner status`, `altair-runner logout`, and `altair-runner start` to run it in a terminal
|
|
30
|
+
instead of in the background (Ctrl+C stops it).
|
|
31
|
+
|
|
32
|
+
### In the background
|
|
33
|
+
|
|
34
|
+
`altair-runner service install` copies the runner to `~/.altair-runner/bin` (so it keeps working after npx clears its
|
|
35
|
+
cache) and registers it to start at login:
|
|
36
|
+
|
|
37
|
+
| OS | How | Logs |
|
|
38
|
+
|---|---|---|
|
|
39
|
+
| macOS | launchd agent `~/Library/LaunchAgents/io.fibteq.altair-runner.plist` | `~/.altair-runner/runner.log` |
|
|
40
|
+
| Linux | systemd user service `altair-runner.service` | `journalctl --user -u altair-runner` |
|
|
41
|
+
| Windows | `altair-runner.vbs` in the Startup folder | `~/.altair-runner/runner.log` |
|
|
42
|
+
|
|
43
|
+
It keeps the `PATH` of the terminal you install it from, which is where it finds `claude`, `codex` and `gemini`.
|
|
44
|
+
On macOS and Linux it restarts after a crash, but not after a clean stop (the computer was removed in Altair, or
|
|
45
|
+
`altair-runner start` was run somewhere else with the same pairing). Run `service install` again after updating
|
|
46
|
+
(`npx altair-runner@latest service install`) or to restart it; `service status` shows its state and
|
|
47
|
+
`service uninstall` removes it. On Linux it starts when you log in; to start at boot without logging in, run
|
|
48
|
+
`loginctl enable-linger`.
|
|
28
49
|
|
|
29
50
|
### What the CLI may do
|
|
30
51
|
|
|
31
|
-
`altair-runner start --access <level>` (saved for next time):
|
|
52
|
+
`altair-runner start --access <level>` or `altair-runner service install --access <level>` (saved for next time):
|
|
32
53
|
|
|
33
54
|
| level | Claude Code | Codex | Gemini CLI |
|
|
34
55
|
|---|---|---|---|
|