chain-studio/tools/today/README.md
flemming-it 891acd2ba2
Some checks failed
Security / Security check (push) Failing after 2s
refactor: rename internal Fai* design system + fai_ helpers to chain
The Studio design system, widgets and helpers carried a Fai* / fai_
prefix (FaiSpace, FaiColors, FaiTheme, FaiLog, 17 fai_*.dart files, the
faiBinary* l10n keys). Studio is the Ch∆In product, so rename them to
Chain* / chain_ — carefully preserving English fail/failure/failed.
Also fix stale references: the 'fai' binary in l10n strings -> 'chain',
FAI_* env vars (FAI_BIN/DATA_DIR/MODULES_DIR/TODAY/BOOTSTRAP_TOKEN) ->
CHAIN_*, fai_platform -> fai_chain, fai_hub -> chain_hub. Vendor
security-hook tooling (FAI_BANNED_TERMS_FILE) + the .fai bundle ext left.
flutter analyze + test: clean (20 passed).

Signed-off-by: flemming-it <stefan.a.flemming@googlemail.com>
2026-06-16 17:53:17 +02:00

73 lines
2.7 KiB
Markdown

# Today-Hero proposal tooling
Daily-build pipeline for the editorial Today-Hero card in Studio's store.
See `../../docs/today-pipeline.md` for the full design rationale.
## Quick start
```bash
# 1. Generate today's proposals (calls the local Ollama by default).
./propose.sh
# 2. Skim them — they sit under ~/.fai/today/proposals/<ISO-DATE>/
ls ~/.fai/today/proposals/
# 3. Accept one. The chosen file becomes ~/.fai/today/active.yaml,
# which Studio reads at startup.
./accept.sh ~/.fai/today/proposals/2026-05-08/candidate-2.yaml
# 4. Restart Studio (or let the next launch pick it up).
```
## Schedule it
### macOS — launchd
```bash
# Drop a plist that runs propose.sh every morning at 07:30 local time.
# `launchctl load ~/Library/LaunchAgents/ai.flemming.chain.today.plist` to
# install. The plist must point at the absolute path of propose.sh.
```
A starter plist lives at `launchd/ai.flemming.chain.today.plist`.
### Linux — systemd timer
```bash
# Copy systemd/fai-today.{service,timer} into ~/.config/systemd/user/,
# then `systemctl --user enable --now fai-today.timer`.
```
### Anywhere — cron
```cron
30 7 * * * /Users/flemming/.../tools/today/propose.sh > /tmp/fai-today.log 2>&1
```
## Provider override
`propose.sh` defaults to Ollama at `http://127.0.0.1:11434` with the model
`gemma3:4b`. Override via env vars:
| Variable | Default | Example |
|-------------------|----------------------------------|-------------------------------------------------|
| `CHAIN_TODAY_API` | `http://127.0.0.1:11434/api/generate` | `https://api.openai.com/v1/chat/completions` |
| `CHAIN_TODAY_MODEL` | `gemma3:4b` | `gpt-4o-mini` |
| `CHAIN_TODAY_KEY` | (unset) | `$OPENAI_API_KEY` |
| `CHAIN_TODAY_N` | `3` | `1` (single shot) |
OpenAI-compatible endpoints will work as long as they speak `chat/completions`
or `generate`; the script auto-detects from the URL path.
## Trust model
- Reads only `git log`, `git diff`, and the bundled `seed.yaml` of
installed Ch∆In monorepos. Never your audit log without explicit op-in.
- Calls only the System-AI you've already configured for Studio. The same
privacy mode you set there applies here.
- Writes only into `~/.fai/today/`. Nothing in `~/.fai/data/` or
`~/.fai/config.yaml` is touched.
- Studio loads `active.yaml` at startup; if the file is missing or fails
schema validation, the compiled-in fallback story renders. KRITIS
fresh installs see the fallback until and unless an operator accepts a
proposal.