@whittlelabs/trivet 0.0.0-stage → 0.1.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 CHANGED
@@ -1,3 +1,57 @@
1
- # Temporary Holding Version
1
+ # Trivet Runner
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Trivet writes trivia about your team's own code. The Runner is the part that
4
+ reads the code: it runs on your machine, clones the repositories you chose for
5
+ a game, and asks your own Claude to write the rounds and questions. Your code
6
+ never leaves your machine except as the questions you keep, and the tokens it
7
+ spends are your subscription's.
8
+
9
+ ## Set it up
10
+
11
+ You need Node 20 or newer, git, and Claude Code signed in to your account.
12
+
13
+ ```bash
14
+ npm install -g @whittlelabs/trivet
15
+ trivet init --pairing-code=<the code Trivet shows you>
16
+ trivet run
17
+ ```
18
+
19
+ Trivet's Runner page shows the pairing code, and the three commands with the
20
+ code already in them. `trivet run` keeps working until you stop it; leave it
21
+ running while you prepare a game.
22
+
23
+ Against a tier other than production, add `--profile stage` (or `test`) to
24
+ `trivet init`.
25
+
26
+ ## What it does
27
+
28
+ The Runner waits for work from Trivet. When you ask for categories or
29
+ questions, it:
30
+
31
+ 1. clones each repository at the commit Trivet pinned, into a throwaway
32
+ directory, using your own git credentials;
33
+ 2. runs Claude Code there with read-only tools (it can read and search the
34
+ code, and nothing else);
35
+ 3. sends the answer back to Trivet, and deletes the checkout.
36
+
37
+ ## Commands
38
+
39
+ | Command | What it does |
40
+ |---|---|
41
+ | `trivet init` | Pairs this machine with your Trivet account |
42
+ | `trivet run` | Works through generation jobs until stopped |
43
+ | `trivet doctor` | Checks git, Claude Code and the pairing |
44
+ | `trivet --help` | Everything else |
45
+
46
+ Settings live in `~/.trivet/`.
47
+
48
+ ## Developing
49
+
50
+ This package is a whitelabel of `@whittlelabs/shuttle` (the Sifter is the
51
+ other one): `src/brand.ts` is the whole of what makes it Trivet's.
52
+
53
+ ```bash
54
+ k test whittle-trivet-runner
55
+ pnpm --filter @whittlelabs/trivet build # dist/bin.js, a single bundled file
56
+ node apps/whittle-trivet-runner/dist/bin.js init --profile studio --pairing-code=<code>
57
+ ```