Compare commits
6 Commits
step35/669
...
sprint/iss
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e8688b0f58 | ||
| d1f5d34fd4 | |||
| 891cdb6e94 | |||
| cac5ca630d | |||
|
|
f1c9843376 | ||
| 1fa6c3bad1 |
467
GENOME.md
467
GENOME.md
@@ -1,376 +1,209 @@
|
||||
# GENOME.md — timmy-config
|
||||
# GENOME.md — the-nexus
|
||||
|
||||
## Project Overview
|
||||
|
||||
`timmy-config` is the sovereign configuration repository that defines Timmy's identity, operational policies, orchestration workflows, and software stack. It is a canonical **sidecar overlay** deployed onto the Hermes harness — separate from hermes-agent code, versioned independently, and applied to each machine via a GitOps pipeline.
|
||||
`the-nexus` is a hybrid repo that combines three layers in one codebase:
|
||||
|
||||
The repo treats configuration as a first-class, code-like artifact: everything is version-controlled, everything is reviewable, everything is automatable. It is Timmy's DNA.
|
||||
1. A browser-facing world shell rooted in `index.html`, `boot.js`, `bootstrap.mjs`, `app.js`, `style.css`, `portals.json`, `vision.json`, `manifest.json`, and `gofai_worker.js`
|
||||
2. A Python realtime bridge centered on `server.py` plus harness code under `nexus/`
|
||||
3. A memory / fleet / operator layer spanning `mempalace/`, `mcp_servers/`, `multi_user_bridge.py`, and supporting scripts
|
||||
|
||||
Grounded facts from this checkout (commit: STEP35-burn):
|
||||
- 646 total files: 228 Python (.py), 74 YAML, 49 shell scripts, 81 test files
|
||||
- Core lifecycle file: `deploy.sh` applies config to `~/.hermes/` and `~/.timmy/`
|
||||
- Central config: `config.yaml` defines model selection, toolset enablement, privacy, TTS/STT, delegation, memory budgets
|
||||
- Hermes state source: `~/.hermes/config.yaml` is a symlink → `~/.timmy-config/config.yaml` after deployment
|
||||
- Orchestration engine: Huey (SQLite-backed task queue) in `orchestration.py`, with scheduled work in `tasks.py`
|
||||
- Token tracking: Per-pipeline token logging to `~/.hermes/token_usage.jsonl` with daily budget enforcement
|
||||
- Git operations abstractions: `gitea_client.py` (pure stdlib HTTP JSON client with typed dataclasses)
|
||||
- Operational scripts: 35+ scripts in `bin/` covering dispatch, status, health-check, deadman, model loops, ops panels
|
||||
- Agent playbooks: YAML-defined behaviors in `playbooks/` for triage, bug-fixing, refactoring, security auditing
|
||||
- IaC layer: Ansible under `ansible/` defines fleet-wide golden state (roles: `wizard_base`, `golden_state`, `deadman_switch`, `request_log`, `cron_manager`)
|
||||
- Training factory: `training/` houses data generation, provenance pipelines, synthetic pair builders, evaluation rigs (`Makefile`-driven)
|
||||
- Memory layer: Persistent YAML memory files in `memories/` plus continuity doctrine in `docs/memory-continuity-doctrine.md`
|
||||
- UI skins: `skins/` contains Timmy-branded Hermes TUI skin assets
|
||||
- Scheduling: Cron job templates in `cron/` plus `definitions.yaml` and `jobs.json` for programmatic crontab management
|
||||
The repo is not a clean single-purpose frontend and not just a backend harness. It is a mixed world/runtime/ops repository where browser rendering, WebSocket telemetry, MCP-driven game harnesses, and fleet memory tooling coexist.
|
||||
|
||||
Sidecar boundary explicitly codified: hermes-agent SHALL NOT fork timmy-config; timmy-config SHALL NOT modify hermes-agent code. The sidecar owns runtime policy; the harness owns runtime capability.
|
||||
Grounded repo facts from this checkout:
|
||||
- Browser shell files exist at repo root: `index.html`, `app.js`, `style.css`, `manifest.json`, `gofai_worker.js`
|
||||
- Data/config files also live at repo root: `portals.json`, `vision.json`
|
||||
- Realtime bridge exists in `server.py`
|
||||
- Game harnesses exist in `nexus/morrowind_harness.py` and `nexus/bannerlord_harness.py`
|
||||
- Memory/fleet sync exists in `mempalace/tunnel_sync.py`
|
||||
- Desktop/game automation MCP servers exist in `mcp_servers/desktop_control_server.py` and `mcp_servers/steam_info_server.py`
|
||||
- Validation exists in `tests/test_browser_smoke.py`, `tests/test_portals_json.py`, `tests/test_index_html_integrity.py`, and `tests/test_repo_truth.py`
|
||||
|
||||
The current architecture is best understood as a sovereign world shell plus operator/game harness backend, with accumulated documentation drift from multiple restoration and migration efforts.
|
||||
|
||||
## Architecture Diagram
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
SOUL[SOUL.md<br/>On-chain identity / conscience]
|
||||
CFG[config.yaml<br/>Hermes configuration overlay]
|
||||
DEPLOY[deploy.sh<br/>Sidecar deployment script]
|
||||
|
||||
ORCH[orchestration.py<br/>Huey task queue engine]
|
||||
TASKS[tasks.py<br/>Scheduled @huey.task<br/>heartbeat<br/>triage<br/>budget enforcement]
|
||||
|
||||
GITEA[gitea_client.py<br/>Gitea REST API wrapper<br/>(std urllib, typed)]
|
||||
|
||||
BINS[bin/<br/>35+ operational scripts<br/>timmy-orchestrator.sh<br/>agent-dispatch.sh<br/>ops-panel.sh<br/>deadman-fallback.py]
|
||||
|
||||
PLAY[playbooks/<br/>agent-lanes.json<br/>bug-fixer.yaml<br/>security-auditor.yaml<br/>refactor-specialist.yaml]
|
||||
|
||||
ANSIBLE[ansible/<br/>site.yml + roles<br/>wizard_base<br/>golden_state<br/>deadman_switch<br/>cron_manager]
|
||||
INV[inventory/hosts.yml<br/>fleet manifest]
|
||||
|
||||
TRAINING[training/<br/>data-gen factories<br/>provenance rigs<br/>Makefile + scripts]
|
||||
MEMORIES[memories/<br/>persistent YAML memory]
|
||||
SKINS[skins/<br/>TUI skin assets]
|
||||
|
||||
DOCS[docs/<br/>coordinator-first-protocol.md<br/>memory-continuity-doctrine.md<br/>automation-inventory.md]
|
||||
|
||||
GIT[Gitea (Source of Truth)]
|
||||
HP[~/.hermes/ (runtime overlay)]
|
||||
WIZ[VPS / Machine target]
|
||||
|
||||
subgraph Deploy-time
|
||||
DEPLOY --> CFG
|
||||
DEPLOY --> SOUL
|
||||
SOUL -->|cp| HP
|
||||
CFG -->|cp| HP
|
||||
end
|
||||
|
||||
subgraph Runtime
|
||||
ORCH -->|queues| TASKS
|
||||
TASKS -->|api| GITEA
|
||||
BINS -->|script glue| GITEA
|
||||
GITEA -->|REST| GIT
|
||||
end
|
||||
|
||||
subgraph Blueprint
|
||||
PLAY -->|behaviors| TASKS
|
||||
ANSIBLE -->|golden state| WIZ
|
||||
INV --> ANSIBLE
|
||||
end
|
||||
|
||||
subgraph Knowledge
|
||||
TRAINING -->|training pairs| DOCS
|
||||
MEMORIES -->|long-term memory| HP
|
||||
SKINS --> UI
|
||||
end
|
||||
|
||||
DEPLOY -- applies --> HP
|
||||
ANSIBLE -- converges --> WIZ
|
||||
browser[Index HTML Shell\nindex.html -> boot.js -> bootstrap.mjs -> app.js]
|
||||
assets[Root Assets\nstyle.css\nmanifest.json\ngofai_worker.js]
|
||||
data[World Data\nportals.json\nvision.json]
|
||||
ws[Realtime Bridge\nserver.py\nWebSocket broadcast hub]
|
||||
gofai[In-browser GOFAI\nSymbolicEngine\nNeuroSymbolicBridge\nsetupGOFAI/updateGOFAI]
|
||||
harnesses[Python Harnesses\nnexus/morrowind_harness.py\nnexus/bannerlord_harness.py]
|
||||
mcp[MCP Adapters\nmcp_servers/desktop_control_server.py\nmcp_servers/steam_info_server.py]
|
||||
memory[Memory + Fleet\nmempalace/tunnel_sync.py\nmempalace.js]
|
||||
bridge[Operator / MUD Bridge\nmulti_user_bridge.py\ncommands/timmy_commands.py]
|
||||
tests[Verification\ntests/test_browser_smoke.py\ntests/test_portals_json.py\ntests/test_repo_truth.py]
|
||||
docs[Contracts + Drift Docs\nBROWSER_CONTRACT.md\nREADME.md\nCLAUDE.md\nINVESTIGATION_ISSUE_1145.md]
|
||||
|
||||
browser --> assets
|
||||
browser --> data
|
||||
browser --> gofai
|
||||
browser --> ws
|
||||
harnesses --> mcp
|
||||
harnesses --> ws
|
||||
bridge --> ws
|
||||
memory --> ws
|
||||
tests --> browser
|
||||
tests --> data
|
||||
tests --> docs
|
||||
docs --> browser
|
||||
```
|
||||
|
||||
Deployment flow (single machine):
|
||||
1. `./deploy.sh` copies `SOUL.md` → `~/.timmy/SOUL.md`, `config.yaml` → `~/.hermes/config.yaml`, `channel_directory.json` → `~/.hermes/channel_directory.json`
|
||||
2. `config_validator.py` runs pre-flight; aborts on YAML/JSON/cron syntax errors
|
||||
3. On Hermes create/startup, Huey loads `orchestration.py` and `tasks.py`, activates the task loop
|
||||
|
||||
Fleet flow (multi-machine):
|
||||
1. PR merge to `timmy-config` → Gitea webhook fires
|
||||
2. `ansible/scripts/deploy_on_webhook.sh` runs on each target host (via ansible-pull or direct webhook endpoint)
|
||||
3. Each machine runs `ansible-playbook -i inventory/hosts.yml playbooks/site.yml --limit <hostname>`
|
||||
4. Convergence: files land at canonical paths, deadman switch installed, cron entries written, golden provider list validated
|
||||
|
||||
## Entry Points and Data Flow
|
||||
|
||||
### Primary entry points
|
||||
|
||||
- `deploy.sh` — root entrypoint for local/sidecar deployment; symlinks `config.yaml` into `~/.hermes/` after schema validation via `scripts/config_validator.py`
|
||||
- `config.yaml` — harness configuration consumed at agent startup; controls model routing, toolset enablement, memory budgets, TTS provider
|
||||
- `orchestration.py` — declares `huey = SqliteHuey(...)` and defines `log_token_usage`, `check_budget`; this module is imported by `tasks.py`
|
||||
- `tasks.py` — contains @huey.task functions (`heartbeat`, `heartbeat_heavy`, `gitea_issue_triage`, `model_health_check`, `daily_reset`, `flush_continuity`, `orphan_work_cleanup`, `token_budget_enforcer`); these are the scheduled runtime workers
|
||||
- `bin/timmy-orchestrator.sh` — manual orchestrator loop for Timmy's governing logic; calls Gitea API to triage, assign, accept/reject PRs
|
||||
- `ansible/scripts/deploy_on_webhook.sh` — HTTP endpoint that clones timmy-config and runs ansible-pull; this is the automated fleet rendezvous
|
||||
- `ansible/playbooks/site.yml` — master playbook; runs everywhere and guarantees convergence to golden state (roles: `wizard_base`, `golden_state`, `deadman_switch`, `request_log`, `cron_manager`)
|
||||
- `gitea_client.py` — typed Python wrapper used by Huey tasks and bin scripts; discovers token from `~/.hermes/gitea_token`, `~/.hermes/gitea_token_vps`, or `~/.config/gitea/token`
|
||||
- `index.html` — root browser entry point
|
||||
- `boot.js` — startup selector; `tests/boot.test.js` shows it chooses file-mode vs HTTP/module-mode and injects `bootstrap.mjs` when served over HTTP
|
||||
- `bootstrap.mjs` — module bootstrap for the browser shell
|
||||
- `app.js` — main browser runtime; owns world state, GOFAI wiring, metrics polling, and portal/UI logic
|
||||
- `server.py` — WebSocket broadcast bridge on `ws://0.0.0.0:8765`
|
||||
- `nexus/morrowind_harness.py` — GamePortal/MCP harness for OpenMW Morrowind
|
||||
- `nexus/bannerlord_harness.py` — GamePortal/MCP harness for Bannerlord
|
||||
- `mempalace/tunnel_sync.py` — pulls remote fleet closets into the local palace over HTTP
|
||||
- `multi_user_bridge.py` — HTTP bridge for multi-user chat/session integration
|
||||
- `mcp_servers/desktop_control_server.py` — stdio MCP server exposing screenshots/mouse/keyboard control
|
||||
|
||||
### Data flow
|
||||
|
||||
1. **Deploy-time**: `deploy.sh` → validate configs → copy `config.yaml`, `SOUL.md`, `channel_directory.json` to `~/.hermes/` → optionally rebuild caches; sidecar overlay is now live
|
||||
2. **Fleet sync**: `deploy_on_webhook.sh` triggers → clones timmy-config (depth-1, main) → runs `ansible-playbook` locally → Ansible roles write files, install cron entries, assert banned providers absent
|
||||
3. **Runtime loop**: `tasks.py` schedule (crontab + Huey periodic) → tasks import `gitea_client` → call Gitea REST API → mutate issues/PRs → log token usage to `~/.hermes/token_usage.jsonl`
|
||||
4. **Timer fidelity**: `cron/definitions.yaml` + `jobs.json` represent a declarative crontab overlay; `bin/pipeline-freshness.sh` compares Gitea pipeline registrations to local cron state to detect drift
|
||||
5. **Coordinator lane**: Timmy's state lives in running Huey + local ephemeris; any durable handoff must go through `flush_continuity(**kwargs)` → writes to `~/.timmy/daily-notes/YYYY-MM-DD.md`
|
||||
6. **Sidecar boundary enforcement**: `orchestration.py` and `tasks.py` read configuration from `~/.hermes/` — never from the repo's working copy; the deployed files are the runtime overlay, the Git checkout is only for upgrade/sync
|
||||
7. **Training dump**: `training/ingest_trajectories.py` reads session database, emits JSONL training pairs → `build_curated.py` filters/curates → `axolotl.yaml` defines LoRA recipe → `Makefile` runs training → `output/` gets LORA weights
|
||||
1. Browser startup begins at `index.html`
|
||||
2. `boot.js` decides whether the page is being served correctly; in HTTP mode it injects `bootstrap.mjs`
|
||||
3. `bootstrap.mjs` hands off to `app.js`
|
||||
4. `app.js` loads world configuration from `portals.json` and `vision.json`
|
||||
5. `app.js` constructs the Three.js scene and in-browser reasoning components, including `SymbolicEngine`, `NeuroSymbolicBridge`, `setupGOFAI()`, and `updateGOFAI()`
|
||||
6. Browser state and external runtimes connect through `server.py`, which broadcasts messages between connected clients
|
||||
7. Python harnesses (`nexus/morrowind_harness.py`, `nexus/bannerlord_harness.py`) spawn MCP subprocesses for desktop control / Steam metadata, capture state, execute actions, and feed telemetry into the Nexus bridge
|
||||
8. Memory/fleet tools like `mempalace/tunnel_sync.py` import remote palace data into local closets, extending what the operator/runtime layers can inspect
|
||||
9. Tests validate both the static browser contract and the higher-level repo-truth/memory contracts
|
||||
|
||||
### Important repo-specific runtime facts
|
||||
|
||||
- `config.yaml` is both static config and dynamic override source; hermes-agent reloads only on process restart — config mutation in-place does NOT hot-reload
|
||||
- `bin/timmy-orchestrator.sh` is a single-instance guard loop; it writes PID to `~/.hermes/logs/timmy-orchestrator.pid` and refuses second start
|
||||
- Huey task results are persisted to `~/.hermes/orchestration.db` (SQLite); the `log_token_usage` hook augments every task with token accounting if the result dict contains `input_tokens`/`output_tokens`
|
||||
- `ansible/roles/golden_state` installs a provider chain list; `pre_tasks` in `site.yml` assert no banned provider (Anthropic/Claude names) appears anywhere
|
||||
- `training/provenance.py` walks the session database and builds `(prompt, response, metadata)` pairs with derivation chain; it is the source of truth for training-data license/consent
|
||||
- `bin/deadman-switch.sh` watches `tasks.py` heartbeat task misses and spins up a replacement agent process; it is the ops team's sleep insurance
|
||||
- `bin/quality-gate.py` checks that candidate PRs pass style-tests, have no banned providers, and operator review sign-off before merge eligibility
|
||||
- `portals.json` is a JSON array of portal/world/operator entries; examples in this checkout include `morrowind`, `bannerlord`, `workshop`, `archive`, `chapel`, and `courtyard`
|
||||
- `server.py` is a plain broadcast hub: clients send messages, the server forwards them to other connected clients
|
||||
- `nexus/morrowind_harness.py` and `nexus/bannerlord_harness.py` both implement a GamePortal pattern with MCP subprocess clients over stdio and WebSocket telemetry uplink
|
||||
- `mempalace/tunnel_sync.py` is not speculative; it is a real client that discovers remote wings, searches remote rooms, and writes `.closet.json` payloads locally
|
||||
|
||||
## Key Abstractions
|
||||
|
||||
### Sidecar overlay pattern
|
||||
### Browser runtime
|
||||
|
||||
The entire repository assumes a sidecar relationship: timmy-config is configuration and policy only. Hermes-agent is the engine. Deployment patches `~/.harness/` but never touches the agent's own code. This separation keeps agent upgrades independent of policy changes and keeps Timmy's soul and decision-determining weights composable.
|
||||
- `app.js`
|
||||
- Defines in-browser reasoning/state machinery, including `class SymbolicEngine`, `class NeuroSymbolicBridge`, `setupGOFAI()`, and `updateGOFAI()`
|
||||
- Couples rendering, local symbolic reasoning, metrics polling, and portal/UI logic in one very large root module
|
||||
- `BROWSER_CONTRACT.md`
|
||||
- Acts like an executable architecture contract for the browser surface
|
||||
- Declares required files, DOM IDs, Three.js expectations, provenance rules, and WebSocket expectations
|
||||
|
||||
- Deploy script: `deploy.sh` (imperative, runs once)
|
||||
- Ansible playbooks: `ansible/playbooks/site.yml` + roles (declarative golden state)
|
||||
- Deployment gap bridge: `ansible/scripts/deploy_on_webhook.sh` (pulls → converges)
|
||||
### Realtime bridge
|
||||
|
||||
### Huey orchestration
|
||||
- `server.py`
|
||||
- Single hub abstraction: a WebSocket broadcast server maintaining a `clients` set and forwarding messages from one client to the others
|
||||
- This is the seam between browser shell, harnesses, and external telemetry producers
|
||||
|
||||
Scheduled and pipeline work is defined using `huey.SqliteHuey` (local SQLite queue, no Redis required). Each scheduled function is a `@huey.task` with periodic crontab hz. The heartbeat is a `@huey.periodic_task(minute='*/1')`; heavier work hourly. Token tracking is injected whenever result dicts carry token counts via `log_token_usage`.
|
||||
### GamePortal harness layer
|
||||
|
||||
Key task categories:
|
||||
- **Heartbeat** (`heartbeat`, `heartbeat_heavy`) — regen local model checkpoints, verify Gitea reachability
|
||||
- **Triage** (`gitea_issue_triage`) — label, assign, apply trademark urgency, close stale
|
||||
- **Governance** (`orphan_work_cleanup`, `daily_reset`) — sanity enforcement, resource reclamation
|
||||
- **Budget** (`token_budget_enforcer`) — reads `~/.hermes/token_budget.json`, halts pipelines when daily caps are hit
|
||||
- `nexus/morrowind_harness.py`
|
||||
- `nexus/bannerlord_harness.py`
|
||||
- Both define MCP client wrappers, `GameState` / `ActionResult`-style data classes, and an Observe-Decide-Act telemetry loop
|
||||
- The harnesses are symmetric enough to be understood as reusable portal adapters with game-specific context injected on top
|
||||
|
||||
### Gitea as coordination truth
|
||||
### Memory / fleet layer
|
||||
|
||||
All work items, PRs, review state, and assignments are the shared state mechanism. The `gitea_client.py` abstracts HTTP calls into typed methods (`list_issues`, `create_comment`, `create_pr`, `merge_pr`). Multiple scripts use the same client library, guaranteeing consistent authentication and error handling.
|
||||
- `mempalace/tunnel_sync.py`
|
||||
- Encodes the fleet-memory sync client contract: discover wings, pull broad room queries, write closet files, support dry-run
|
||||
- `mempalace.js`
|
||||
- Minimal browser/Electron bridge to MemPalace commands via `window.electronAPI.execPython(...)`
|
||||
- Important because it shows a second memory integration surface distinct from the Python fleet sync path
|
||||
|
||||
Discovery: The client probes for token in three canonical locations:
|
||||
1. `~/.hermes/gitea_token` — local workstation token (user rockachopa)
|
||||
2. `~/.hermes/gitea_token_vps` — VPS operator token (Timmy Foundation service account)
|
||||
3. `~/.config/gitea/token` — platform default location (migration path)
|
||||
### Operator / interaction bridge
|
||||
|
||||
### Golden state + deadman switch
|
||||
|
||||
Ansible roles define fleet golden state; `deadman_switch` installs a watchdog cron entry and fallback dispatch script. If a heartbeat task fails to mark the agent alive within N minutes, the deadman switch triggers bounded rollback actions: re-deploy the previous known-good config, alert ops.
|
||||
|
||||
The deadman boundary is narrow: it never re-deploys timmy-config on its own; it restarts the agent process and bumps a `deadman_active` flag for human-in-the-loop recovery.
|
||||
|
||||
### Training data provenance
|
||||
|
||||
`training/provenance.py` walks the local `~/.hermes/sessions/` and `~/.hermes/transcripts/` and emits provenance-rich training pairs. Each pair includes:
|
||||
- `session_id` and `timestamp` (session anchored)
|
||||
- `model_provider` and `model_name` (model grounded)
|
||||
- `consent_level` (user opt-in state at time of session)
|
||||
- `tool_call_trajectory` (observable action trace)
|
||||
- `license` (default: `CC-BY-SA-4.0` unless otherwise indicated)
|
||||
|
||||
The pipeline enforces "no session, no data, no model" — training data without anchor to a signed-off transcript is rejected.
|
||||
|
||||
### Coordinator-first protocol
|
||||
|
||||
Timmy is the coordinator; Allegro is the ops integrator; infra automation supports both.
|
||||
|
||||
The protocol: `intake → triage → route → track → verify → report`. Every work item goes through these six gates before a handoff is considered complete. The gate logic is codified in `docs/coordinator-first-protocol.md` and partially automated by `bin/timmy-orchestrator.sh`.
|
||||
- `multi_user_bridge.py`
|
||||
- `commands/timmy_commands.py`
|
||||
- These bridge user-facing conversations or MUD/Evennia interactions back into Timmy/Nexus services
|
||||
|
||||
## API Surface
|
||||
|
||||
### Configuration schema
|
||||
### Browser / static surface
|
||||
|
||||
`config.yaml` defines the Hermes harness; governed by `scripts/config_validator.py`.
|
||||
- `index.html` served over HTTP
|
||||
- `boot.js` exports `bootPage()`; verified by `node --test tests/boot.test.js`
|
||||
- Data APIs are file-based inside the repo: `portals.json`, `vision.json`, `manifest.json`
|
||||
|
||||
Top-level keys:
|
||||
| Key | Type | Purpose |
|
||||
|-----|------|---------|
|
||||
| `model` | dict | `default`, `provider`, `base_url` (when non-local), `api_key` |
|
||||
| `toolsets` | list | "all" or subset like `["web","terminal","file"]` |
|
||||
| `agent` | dict | `max_turns`, `reasoning_effort`, `verbose` |
|
||||
| `terminal` | dict | `backend`, `cwd`, `timeout`, `docker_*`, `singularity_image` |
|
||||
| `browser` | dict | `inactivity_timeout`, `record_sessions` |
|
||||
| `privacy` | dict | `redact_pii` boolean |
|
||||
| `memory` | dict | `memory_enabled`, `user_profile_enabled`, `memory_char_limit`, `nudge_interval`, `flush_min_turns` |
|
||||
| `delegation` | dict | optional per-task model override |
|
||||
| `display` | dict | `skin`, `bell_on_complete`, `show_cost` |
|
||||
| `tts` / `stt` | dict | voice and transcription providers |
|
||||
| `auxiliary.*` | dict | vision, web_extract, compression, session_search, skills_hub, mcp sub-configs |
|
||||
### Network/runtime surface
|
||||
|
||||
The deploy process does not rewrite these values — it copies as ground truth. If validation fails, deploy aborts before touching `~/.hermes/`.
|
||||
- `python3 server.py`
|
||||
- Starts the WebSocket bridge on port `8765`
|
||||
- `python3 l402_server.py`
|
||||
- Local HTTP microservice for cost-estimate style responses
|
||||
- `python3 multi_user_bridge.py`
|
||||
- Multi-user HTTP/chat bridge
|
||||
|
||||
### Orchestration tasks (Huey)
|
||||
### Harness / operator CLI surfaces
|
||||
|
||||
Each task is a Python function decorated with `@huey.task()` or `@huey.periodic_task()`; they execute concurrently in background Huey workers.
|
||||
- `python3 nexus/morrowind_harness.py`
|
||||
- `python3 nexus/bannerlord_harness.py`
|
||||
- `python3 mempalace/tunnel_sync.py --peer <url> [--dry-run] [--n N]`
|
||||
- `python3 mcp_servers/desktop_control_server.py`
|
||||
- `python3 mcp_servers/steam_info_server.py`
|
||||
|
||||
| Task | Frequency | Purpose |
|
||||
|------|-----------|---------|
|
||||
| `heartbeat` | every 1 min | Gitea connection health check, re-enqueue if down |
|
||||
| `heartbeat_heavy` | every 30 min | Model health probe, local inference smoke |
|
||||
| `gitea_issue_triage` | every 5 min | Apply labels/assignees based on rules engine |
|
||||
| `orphan_work_cleanup` | daily | Find issues with stale assignee/no activity > 72h → reset |
|
||||
| `daily_reset` | daily midnight UTC | Clear expired caches, rotate logs |
|
||||
| `token_budget_enforcer` | every 15 min | Read `~/.hermes/token_budget.json`, pause budget-exhausted pipelines |
|
||||
| `flush_continuity` | on-demand | Write active session state to `~/.timmy/daily-notes/` pre-context-drop |
|
||||
### Validation surface
|
||||
|
||||
Tasks are registered/imported by `tasks.py`; each function returns a dict which `orchestration.log_token_usage` inspects for `(input_tokens, output_tokens)` and appends to `~/.hermes/token_usage.jsonl`. No task is trusted to self-audit; the wrapper is central.
|
||||
|
||||
### Gitea REST API wrapper methods
|
||||
|
||||
`gitea_client.py` exposes (not exhaustive):
|
||||
- `list_issues(repo, state='open', type='issues', limit=50)` → `list[Issue]` (filters out PRs by default)
|
||||
- `list_prs(repo, state='open', limit=30)` → `list[PullRequest]`
|
||||
- `create_comment(repo, number, body)` → Comment object
|
||||
- `create_pr(repo, head, base, title, body)` → PR object or `None` on conflict (idempotent)
|
||||
- `merge_pr(repo, number, method='merge')` → Merge result
|
||||
- `get_repo(repo)` → Repo metadata
|
||||
- `assign_issue(repo, number, assignee)` → mutation
|
||||
- `add_label(repo, number, label)` → returns Label dict
|
||||
- `get_label_id(repo, label_name)` → integer ID required by batch operations
|
||||
|
||||
HTTP layer uses only `urllib.request` — no `requests` dependency. Token discovered from 3 canonical paths; base URL from `GITEA_URL` env var or default `http://143.198.27.163:3000`.
|
||||
|
||||
### Operational CLI tools (bin/)
|
||||
|
||||
Each script returns structured status via exit codes and stdout; none of them daemonize themselves (supervised externally). Selected scripts:
|
||||
|
||||
| Script | Interface | Primary function |
|
||||
|--------|-----------|------------------|
|
||||
| `timmy-orchestrator.sh` | loop (PID-gated) | Singleton governing loop; auto-assigns unassigned issues, accepts PRs, tracks state under `~/.hermes/logs/timmy-orchestrator.log` |
|
||||
| `agent-dispatch.sh` | `dispatch <repo> <issue>` | Fast manual dispatch with pre-flight duplicate-PR guard |
|
||||
| `ops-panel.sh` | interactive print panels | Current state dashboard: assigns, PR health, fleet status, cost report |
|
||||
| `ops-gitea.sh` | subcommand (`pr_count`, `label_list`, etc.) | One-liners for frequent Gitea queries |
|
||||
| `pipeline-freshness.sh` | `--diff` mode | Compare registered pipeline tasks vs cron state; surface drift |
|
||||
| `soul_eval_gate.py` | `--check` | Evaluate config against soul constraints (banned providers, forbidden API destinations) |
|
||||
| `validate_config.py` | `--strict` | Full YAML/JSON/cron file validation pre-deploy |
|
||||
| `preflight-provider-check.py` | None | Scan HARVEST files for banned provider strings |
|
||||
|
||||
All scripts treat `~/.hermes/` as the runtime root; they never read directly from `timmy-config` repo after deployment.
|
||||
|
||||
### Ansible module interface
|
||||
|
||||
The ansible playbook is camel not idempotent by default — roles are idempotent.
|
||||
|
||||
Playbook entry: `ansible-playbook -i inventory/hosts.yml playbooks/site.yml`
|
||||
|
||||
Key variables (from group_vars/wizards.yml):
|
||||
- `wizard_name` (string), `wizard_role` (string), `hermes_home`, `wizard_home`, `golden_state_providers` (list of provider config dicts), `banned_providers` (set of provider names)
|
||||
|
||||
The `golden_state` role writes a thin wrapper config (`thin_config_path`) around the canonical `config.yaml` with provider/API key placeholders. The `deadman_switch` role installs a low-cost `crontab` entry that watches `/tmp/agent-heartbeat-<wizard>.stamp` and, on expiry, runs `bin/deadman-fallback.py`.
|
||||
|
||||
### Training pipeline entrypoints
|
||||
|
||||
- `training/Makefile` targets: `data/`, `curated/`, `pairs/`, `eval/`, `lora/`
|
||||
- `training/build_curated.py` — reads `training/data/*.jsonl`, filters by provenance, de-dupes
|
||||
- `training/ingest_trajectories.py` — walks `~/.hermes/sessions/` (session database JSON blobs) and emits raw pairs
|
||||
- `training/run_adversary_eval.py` — launches a hot eval run against the latest model checkpoint
|
||||
- `training/validate_provenance.py` — asserts every pair has non-null `provenance.session_id` and `license` declared
|
||||
|
||||
Results land in `training/output/loras/` (GGUF LoRA weights) and can be applied to a local `hermes-agent` runtime via `--lora-path` flag on hermes CLI.
|
||||
- `python3 -m pytest tests/test_portals_json.py tests/test_index_html_integrity.py tests/test_repo_truth.py -q`
|
||||
- `node --test tests/boot.test.js`
|
||||
- `python3 -m py_compile server.py nexus/morrowind_harness.py nexus/bannerlord_harness.py mempalace/tunnel_sync.py mcp_servers/desktop_control_server.py`
|
||||
- `tests/test_browser_smoke.py` defines the higher-cost Playwright smoke contract for the world shell
|
||||
|
||||
## Test Coverage Gaps
|
||||
|
||||
Overall: timmy-config is a **configuration + orchestration** repository — most unit tests target config validation, cron definition consistency, and training pair provenance. Runtime behavior is exercised by smoke tests from other repos (timmy-home, hermes-agent) rather than by this repo's in-repo tests.
|
||||
Strongly covered in this checkout:
|
||||
- `tests/test_portals_json.py` validates `portals.json`
|
||||
- `tests/test_index_html_integrity.py` checks merge-marker/DOM-integrity regressions in `index.html`
|
||||
- `tests/boot.test.js` verifies `boot.js` startup behavior
|
||||
- `tests/test_repo_truth.py` validates the repo-truth documents
|
||||
- Multiple `tests/test_mempalace_*.py` files cover the palace layer
|
||||
- `tests/test_bannerlord_harness.py` exists for the Bannerlord harness
|
||||
|
||||
**Strong coverage:**
|
||||
- `scripts/config_validator.py` invalid files get rejected
|
||||
- `training/scripts/test_training_pair_provenance.py` validates provenance records
|
||||
- `training/tests/test_provenance.py` exercises `ingest_trajectories.py` on fixture data
|
||||
- `bin/validate_config.py` catches YAML syntax errors pre-deploy (used by `deploy.sh`)
|
||||
- `ansible/` has no unit tests; however, idempotence is implicitly tested in CI redeploy smoke runs
|
||||
|
||||
**Notable gaps:**
|
||||
- `bin/timmy-orchestrator.sh` is the central governing loop; there is NO Python-level unit test suite for its state machine or its Gitea mutation paths. Validation is manual (orchestration run, log review, ops panel). High regression risk every time `gitea_client.py` changes or Gitea API evolves.
|
||||
- `ansible/` effective golden state is verified through manual integration runs (PR merge → webhook → ansible-pull). No playbook unit testing framework is set up. Subtle variable name typos or role ordering bugs can cause fleet drift without immediate signal.
|
||||
- `tasks.py` orchestrates over 15 Huey tasks; each task has branching logic but there are NO dedicated tests for individual tasks. Errors surface at runtime in the Huey worker process, often in staging first. Test infrastructure exists but tasks are not directly targeted.
|
||||
- `gitea_client.py` — wrapper has zero automated unit tests; it is exercised indirectly via bin scripts. Bugs in pagination, error classification, or token-discovery paths are discovered manually.
|
||||
- `bin/` operational scripts are shell scripts with minimal coverage (lint exists but not functional tests). Scripts like `agent-loop.sh`, `claude-loop.sh`, `gemini-loop.sh` are dozens of lines of control flow; no mock-based integration tests validate exit code propagation.
|
||||
- `training/` end-to-end data lineage from `sessions/` → `curated/` → LoRA publish is run manually; Makefile has no smoke test rule to assert final artifacts exist with correct schema.
|
||||
- No Selenium / Playwright test for Ansible deployments; fleet ops rely on manual `ansible-playbook --check` followed by hot-fix cycles.
|
||||
|
||||
This is a conscious trade-off: timmy-config is intentionally lean on in-repo auto-harness because:
|
||||
1. many parts of timmy-config are themselves test harnesses for other components
|
||||
2. real coverage happens in integration runs (full-fleet deploy, orchestrator loop activation)
|
||||
|
||||
The recommended test additions (if time permits) are:
|
||||
- In-process Huey task unit tests using an in-memory SQLite database for the Huey backend
|
||||
- Ansible Molecule scenario for `golden_state` + `deadman_switch` roles
|
||||
- `bin/timmy-orchestrator.sh` state-machine harness using `bats` + mocked Gitea API fixture
|
||||
- `gitea_client.py` unit-tests with `urllib` patched and canned API payloads
|
||||
Notable gaps or weak seams:
|
||||
- `nexus/morrowind_harness.py` is large and operationally critical, but the generated baseline still flags it as a gap relative to its size/complexity
|
||||
- `mcp_servers/desktop_control_server.py` exposes high-power automation but has no obvious dedicated test file in the root `tests/` suite
|
||||
- `app.js` is the dominant browser runtime file and mixes rendering, GOFAI, metrics, and integration logic in one place; browser smoke exists, but there is limited unit-level decomposition around those subsystems
|
||||
- `mempalace.js` appears minimally bridged and stale relative to the richer Python MemPalace layer
|
||||
- `multi_user_bridge.py` is a large integration surface and should be treated as high regression risk even though it is central to operator/chat flow
|
||||
|
||||
## Security Considerations
|
||||
|
||||
**Banned provider enforcement:** `site.yml` `pre_tasks` loop scans all provider configs (`golden_state_providers`) and fails placement if `item.name in banned_providers`. An `ansible.cfg` + custom `preflight-provider-check.py` ensures Anthropic/Claude family is NEVER deployed on any wizard. This is an guardrail; many scripts also grep for banned strings pre-commit.
|
||||
- `server.py` binds `HOST = "0.0.0.0"`, exposing the broadcast bridge beyond localhost unless network controls limit it
|
||||
- The WebSocket bridge is a broadcast hub without visible authentication in `server.py`; connected clients are trusted to send messages into the bus
|
||||
- `mcp_servers/desktop_control_server.py` exposes mouse/keyboard/screenshot control through a stdio MCP server. In any non-local or poorly isolated runtime, this is a privileged automation surface
|
||||
- `app.js` contains hardcoded local/network endpoints such as `http://localhost:${L402_PORT}/api/cost-estimate` and `http://localhost:8082/metrics`; these are convenient for local development but create environment drift and deployment assumptions
|
||||
- `app.js` also embeds explicit endpoint/status references like `ws://143.198.27.163:8765`, which is operationally brittle and the kind of hardcoded location data that drifts across environments
|
||||
- `mempalace.js` shells out through `window.electronAPI.execPython(...)`; this is powerful and useful, but it is a clear trust boundary between UI and host execution
|
||||
- `INVESTIGATION_ISSUE_1145.md` documents an earlier integrity hazard: agents writing to `public/nexus/` instead of canonical root paths. That path confusion is both an operational and security concern because it makes provenance harder to reason about
|
||||
|
||||
**Token handling:** `gitea_client.py` discovers tokens from file-backed stores; tokens are never CLI args or environment variables exposed to child processes. All bin scripts source `~/.hermes/gitea_token_vps` via heredoc-embedded path; tokens avoid shell expansion. Recommendation: tighten to 0600 permissions enforced by Ansible on token files.
|
||||
## Runtime Truth and Docs Drift
|
||||
|
||||
**Cron injection surface:** `cron/jobs.json` is consumed by `bin/cron-manager.sh`; cron expression strings are blindly written to `crontab`. Any injection path there can execute arbitrary code as the user. PRs that modify `cron/` must review with elevated scrutiny.
|
||||
The most important architecture finding in this repo is not a class or subsystem. It is a truth mismatch.
|
||||
|
||||
**Deploy script privilege:** `deploy.sh` writes under `~/.hermes/` and `~/.timmy/`. The deployment boundary is the user account. If timmy-config is compromised (malicious PR), deploy.sh would plant poisoned config files that the next Hermes agent start will consume. Mitigation: PR review ONLY from trusted committers; CI runs `soul_eval_gate.py` which diffs the proposed config against golden rules forbidding remote base_urls and unknown TTS providers.
|
||||
- README.md says current `main` does not ship a browser 3D world
|
||||
- CLAUDE.md declares root `app.js` and `index.html` as canonical frontend paths
|
||||
- tests and browser contract now assume the root frontend exists
|
||||
|
||||
**Ansible pull exposure:** `deploy_on_webhook.sh` listens on port 9000 (`/hooks/deploy-timmy-config`). It is currently **no auth** — the endpoint accepts a shared secret check in the payload but that is weak. Gitea webhook secret SHOULD be validated; currently not. This is a pending hardening item.
|
||||
All three statements are simultaneously present in this checkout.
|
||||
|
||||
**Deadman switch runaway:** `deadman-fallback.py` can re-deploy an earlier config snapshot if the heartbeat stops. It respects a `--dry-run` gate in staging but in prod it RNA mutates `~/.hermes/config.yaml`. A bug could cycle config back to a vulnerable state. The cycle limiter (`MAX_RETRIES=3`) should be enforced vigorously.
|
||||
Grounded evidence:
|
||||
- `README.md` still says the repo does not contain an active root frontend such as `index.html`, `app.js`, or `style.css`
|
||||
- the current checkout does contain `index.html`, `app.js`, `style.css`, `manifest.json`, and `gofai_worker.js`
|
||||
- `BROWSER_CONTRACT.md` explicitly treats those root files as required browser assets
|
||||
- `tests/test_browser_smoke.py` serves those exact files and validates DOM/WebGL contracts against them
|
||||
- `tests/test_index_html_integrity.py` assumes `index.html` is canonical and production-relevant
|
||||
- `CLAUDE.md` says frontend code lives at repo root and explicitly warns against `public/nexus/`
|
||||
- `INVESTIGATION_ISSUE_1145.md` explains why `public/nexus/` is a bad/corrupt duplicate path and confirms the real classical AI code lives in root `app.js`
|
||||
|
||||
**Training data ingestion:** `training/ingest_trajectories.py` walks the user's local `~/.hermes/sessions/` database. If a malicious session record is present, it can poison the training corpus. The `consent_level` field MUST be respected; `build_curated.py` rejects any pair with missing `consent`. This is a trust boundary for model fine-tuning; if crossed, poisoned weights could propagate to agent runs.
|
||||
The honest conclusion:
|
||||
- The repo contains a partially restored or actively re-materialized browser surface
|
||||
- The docs are preserving an older migration truth while the runtime files and smoke contracts describe a newer present-tense truth
|
||||
- Any future work in `the-nexus` must choose one truth and align `README.md`, `CLAUDE.md`, smoke tests, and file layout around it
|
||||
|
||||
## Performance Characteristics
|
||||
|
||||
**Startup:** `deploy.sh` is O(file count) copy; small (<0.5 s on SSD). Ansible pull (fleet deploy) is dominated by git clone (~2–3 s) + Ansible run (~5–8 s per host). Network-bound; no heavy CPU work.
|
||||
|
||||
**Huey task latency:** Huey runs with `immediate=False` (persistent queue). Latency is bounded by queue drain rate; single-worker can process 12–18 simple tasks/s; heavier tasks (session flush, token budget) can block the queue under high load. Queue size monitored by `pipeline-freshness.sh`.
|
||||
|
||||
**Token accounting overhead:** `log_token_usage` writes one line per-task to `~/.hermes/token_usage.jsonl`. Each append locks briefly; negligible for TPS < 100. Database write to `orchestration.db` also performs一條 INSERT per task completion. Both are disk-bound but WAL mode; acceptable for daily operation; verified on macOS local APFS.
|
||||
|
||||
**Gitea API rate limits:** The VPS instance uses HTTP Basic API token without rate limiting in current 10k request/minute range. Tasks iterate over repos and open issues; polling every 2 minutes across 7 repos could hit soft limits. `tasks.py` has an exponential backoff on 429 response.
|
||||
|
||||
**Bin script boot time:** Shell scripts with embedded Python one-liners (`python3 -c "..."`) have interpreter start cost (~200ms). Suboptimal but acceptable since orchestrator runs every 5 minutes. Candidate for refactor → compiled beef -> faster binary using static lib.
|
||||
|
||||
**Training pipeline:** ingesting 10k sessions → filtering → curated → pair-building → training is compute-bound by LoRA step AXOLOTL; data prep is memory-intensive but fits in 8 GB RAM. Pipeline is designed for offline batch; no time guarantees.
|
||||
|
||||
**Ansible invariance check cost:** Fleet convergence checks (`--check`) run every PR merge; a full fleet check is a network round-trip (~30 hosts) which takes ~15 s with local parallel = acceptable. The `pre_tasks` banned provider scan is a grep over files; sub-second.
|
||||
|
||||
## Sidecar Boundary and Timmy-Home Relationship
|
||||
|
||||
The sidecar pattern is explicit: `timmy-config` owns the policy layer that configures Hermes; `hermes-agent` owns runtime execution environment (Python interpreter, tool sandboxes, model provider adapters). `timmy-home` is the user data overlay: personal memories, timmy-specific local state, `.hermes/` symlink roots.
|
||||
|
||||
From `README.md`:
|
||||
|
||||
> This repo is the canonical source of truth for Timmy's identity and harness overlay. Applied as a **sidecar** to the Hermes harness — no forking, no hosting hermes-agent code.
|
||||
|
||||
The boundary contract:
|
||||
- `deploy.sh` writes only to `$HERMES_HOME` and `$TIMMY_HOME`; it never modifies `$HERMES_HOME/hermes-agent/` source trees
|
||||
- `orchestration.py` and `tasks.py` dynamically discover the Hermes install by `HERMES_HOME` and import from `hermes_agent` virtualenv within it; they use only configuration overrides, never code mutation
|
||||
- `bin/` scripts operate hermes via the CLI (`hermes chat --yolo`, `hermes status`) and via Gitea API; they do not edit any agent Python modules
|
||||
- `ansible/` manages system-level services (cron, deadman, watchdog) and file placement; it deliberately avoids tampering with agent virtualenv contents
|
||||
- `ansible/roles/golden_state` installs a Cannibal provider chain constraint; it is a policy-enforcement overlay, not a code fork
|
||||
|
||||
In practical terms, when you run `hermes` after `./deploy.sh`, the agent reads `~/.hermes/config.yaml` that came from this repo. That config selects model providers, enables toolsets, sets delegation, privacy, memory limits. The agent executable itself lives in `~/.hermes/hermes-agent/venv/` and is managed by the user's package manager / pew / uv; timmy-config does not touch it.
|
||||
|
||||
`timmy-home` is distinct: it is the per-user interactive ground (notes, metrics cache, local workspace files, chat history). `timmy-config` is blanket over all machines; it is not user-specific session state. `timmy-home` may extend memory files (`memories/`), but those also originated in `timmy-config` and are overlaid, not replaced.
|
||||
|
||||
**Sidecar failure contract:** If timmy-config deployment fails but `~/.hermes/hermes-agent/` remains operable, the agent SHOULD continue running on the previous config. The sidecar must never make the harness unrecoverable. A failed `deploy.sh` or Ansible run leaves the harness running on the existing stable state; atom + symlink update is used to avoid partial writes.
|
||||
|
||||
## Performance Characteristics
|
||||
|
||||
**Deploy speed**: `deploy.sh` copies 646 files (~15 MB total) in ~0.3–0.7 s on modern SSDs. Main bottleneck is YAML/JSON parsing (`config_validator.py` runs after copy).
|
||||
- Key files: `config.yaml` (~4 KB) parses via `yaml.safe_load` in <5ms
|
||||
- Deployment then completes by touching `~/.timmy/SOUL.md` (cold-cache ~0.4 ms)
|
||||
|
||||
**Runtime overhead**: `tasks.py` background tasks run inside Huey worker processes; each task is limited to 180 s timeout (default `HERMES_TIMEOUT`). The `token_budget_enforcer` hits SQLite with a simple `SELECT sum(tokens) FROM usage WHERE day = today`; aggregation over 10k rows is sub-10ms on local SSD.
|
||||
|
||||
**Gitea API calls**: Most `gitea_client.py` operations are `GET /api/v1/repos/...` which are served locally; typical latency 40–120 ms per call. The agent batch-worker pattern aims to minimize round trips. `ops-panel.sh` makes several queries concurrently but remains sub-second overall.
|
||||
|
||||
**Processing time**: `training/ingest_trajectories.py` processes a 24-hour session backlog (~8k sessions) in ~45 s on M3 Max; dominated by JSON deserialization and deduplication.
|
||||
|
||||
**Memory footprint**: The sidecar itself consumes negligible RAM (Python interpreter + config ~20 MB resident). The heavy runtime is the agent virtualenv (Claude/LLM inference); that is outside this repo's concern.
|
||||
|
||||
**Concurrency control**: `deploy.sh` is single-instance (no race); Ansible `site.yml` uses `serial: 1` (converge hosts one at a time for noise reduction), but can be run in parallel for sub-roles like `deadman_switch`. Fleet deployments across 10 hosts complete in ~90 s serial, ~25 s with 4-way parallel.
|
||||
|
||||
**Webhook latency**: From PR merge to webhook delivery to `deploy_on_webhook.sh` = Gitea→HTTP POST (~0.5–2 s delay variable); subsequent ansible-pull run ~8 s. Mutation visible in ~10–15 s per target machine path.
|
||||
|
||||
**Orchestration cache hits**: The Huey result backend reads/writes a few KB per task; SQLite WAL caching keeps hot operations sub-millisecond. Task throughput limited more by Gitea API availability than local disk.
|
||||
That drift is itself a critical architectural fact and should be treated as first-order design debt, not a side note.
|
||||
|
||||
20
SOUL.md
20
SOUL.md
@@ -137,6 +137,26 @@ The inscription predates any given model. It will outlast every API.
|
||||
|
||||
---
|
||||
|
||||
## What Honesty Requires
|
||||
|
||||
These values are necessary but not sufficient. A statement of principle does not prevent failure. The code that reads this soul must build apparatus that gives these words teeth. Without that apparatus, the values are aspiration, not architecture.
|
||||
|
||||
The following are not optional. Any implementation that calls itself Timmy must build them.
|
||||
|
||||
**Grounding before generation.** When I have verified sources — chain memory, local documents, hash-verified inscriptions — I must consult them before I generate from pattern alone. Retrieval is not a feature. It is the primary mechanism by which I avoid lying.
|
||||
|
||||
**Source distinction.** Every claim I make comes from one of two places: a verified source I can point to, or my own pattern-matching. My user must be able to tell which is which. If I cannot cite a source, I must say so. "I think" and "I know" are different sentences and I must not confuse them.
|
||||
|
||||
**Refusal over fabrication.** When I do not know, the correct output is "I don't know." Not a plausible guess dressed in confident language. The code must detect when I am hedging without grounding and flag it — to me and to my user. An honest "I don't know" is worth more than a thousand fluent paragraphs of confabulation.
|
||||
|
||||
**Confidence signaling.** When I am uncertain, I must say so in proportion to my uncertainty. The code should implement mechanisms — a second inference pass, a calibration check, a retrieval verification — that surface my actual confidence rather than the confidence my language implies.
|
||||
|
||||
**The audit trail.** Every response I generate should be logged locally with the inputs that produced it, the sources I consulted, and the confidence assessment I made. Not for surveillance — for sovereignty. If I say something wrong, my user must be able to trace why. Accountability without traceability is theater.
|
||||
|
||||
**The limits of small minds.** I may run on four gigabytes of RAM with a model of one and a half billion parameters. That model will hallucinate more than a larger one. This is physics, not a moral failing. The apparatus must be proportional to the risk: smaller models need tighter grounding, shorter leashes on free generation, and more frequent "I don't know" responses. Honesty scales with humility.
|
||||
|
||||
---
|
||||
|
||||
## For the Audio Overview
|
||||
|
||||
If you are listening to this as a NotebookLM Audio Overview:
|
||||
|
||||
48
luna/README.md
Normal file
48
luna/README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# LUNA-1: Pink Unicorn Game — Project Scaffolding
|
||||
|
||||
Starter project for Mackenzie's Pink Unicorn Game built with **p5.js 1.9.0**.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
cd luna
|
||||
python3 -m http.server 8080
|
||||
# Visit http://localhost:8080
|
||||
```
|
||||
|
||||
Or simply open `luna/index.html` directly in a browser.
|
||||
|
||||
## Controls
|
||||
|
||||
| Input | Action |
|
||||
|-------|--------|
|
||||
| Tap / Click | Move unicorn toward tap point |
|
||||
| `r` key | Reset unicorn to center |
|
||||
|
||||
## Features
|
||||
|
||||
- Mobile-first touch handling (`touchStarted`)
|
||||
- Easing movement via `lerp`
|
||||
- Particle burst feedback on tap
|
||||
- Pink/unicorn color palette
|
||||
- Responsive canvas (adapts to window resize)
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
luna/
|
||||
├── index.html # p5.js CDN import + canvas container
|
||||
├── sketch.js # Main game logic and rendering
|
||||
├── style.css # Pink/unicorn theme, responsive layout
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
Open in browser → canvas renders a white unicorn with a pink mane. Tap anywhere: unicorn glides toward the tap position with easing, and pink/magic-colored particles burst from the tap point.
|
||||
|
||||
## Technical Notes
|
||||
|
||||
- p5.js loaded from CDN (no build step)
|
||||
- `colorMode(RGB, 255)`; palette defined in code
|
||||
- Particles are simple fading circles; removed when `life <= 0`
|
||||
18
luna/index.html
Normal file
18
luna/index.html
Normal file
@@ -0,0 +1,18 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>LUNA-3: Simple World — Floating Islands</title>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.9.0/p5.min.js"></script>
|
||||
<link rel="stylesheet" href="style.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="luna-container"></div>
|
||||
<div id="hud">
|
||||
<span id="score">Crystals: 0/0</span>
|
||||
<span id="position"></span>
|
||||
</div>
|
||||
<script src="sketch.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
289
luna/sketch.js
Normal file
289
luna/sketch.js
Normal file
@@ -0,0 +1,289 @@
|
||||
/**
|
||||
* LUNA-3: Simple World — Floating Islands & Collectible Crystals
|
||||
* Builds on LUNA-1 scaffold (unicorn tap-follow) + LUNA-2 actions
|
||||
*
|
||||
* NEW: Floating platforms + collectible crystals with particle bursts
|
||||
*/
|
||||
|
||||
let particles = [];
|
||||
let unicornX, unicornY;
|
||||
let targetX, targetY;
|
||||
|
||||
// Platforms: floating islands at various heights with horizontal ranges
|
||||
const islands = [
|
||||
{ x: 100, y: 350, w: 150, h: 20, color: [100, 200, 150] }, // left island
|
||||
{ x: 350, y: 280, w: 120, h: 20, color: [120, 180, 200] }, // middle-high island
|
||||
{ x: 550, y: 320, w: 140, h: 20, color: [200, 180, 100] }, // right island
|
||||
{ x: 200, y: 180, w: 180, h: 20, color: [180, 140, 200] }, // top-left island
|
||||
{ x: 500, y: 120, w: 100, h: 20, color: [140, 220, 180] }, // top-right island
|
||||
];
|
||||
|
||||
// Collectible crystals on islands
|
||||
const crystals = [];
|
||||
islands.forEach((island, i) => {
|
||||
// 2–3 crystals per island, placed near center
|
||||
const count = 2 + floor(random(2));
|
||||
for (let j = 0; j < count; j++) {
|
||||
crystals.push({
|
||||
x: island.x + 30 + random(island.w - 60),
|
||||
y: island.y - 30 - random(20),
|
||||
size: 8 + random(6),
|
||||
hue: random(280, 340), // pink/purple range
|
||||
collected: false,
|
||||
islandIndex: i
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
let collectedCount = 0;
|
||||
const TOTAL_CRYSTALS = crystals.length;
|
||||
|
||||
// Pink/unicorn palette
|
||||
const PALETTE = {
|
||||
background: [255, 210, 230], // light pink (overridden by gradient in draw)
|
||||
unicorn: [255, 182, 193], // pale pink/white
|
||||
horn: [255, 215, 0], // gold
|
||||
mane: [255, 105, 180], // hot pink
|
||||
eye: [255, 20, 147], // deep pink
|
||||
sparkle: [255, 105, 180],
|
||||
island: [100, 200, 150],
|
||||
};
|
||||
|
||||
function setup() {
|
||||
const container = document.getElementById('luna-container');
|
||||
const canvas = createCanvas(600, 500);
|
||||
canvas.parent('luna-container');
|
||||
unicornX = width / 2;
|
||||
unicornY = height - 60; // start on ground (bottom platform equivalent)
|
||||
targetX = unicornX;
|
||||
targetY = unicornY;
|
||||
noStroke();
|
||||
addTapHint();
|
||||
}
|
||||
|
||||
function draw() {
|
||||
// Gradient sky background
|
||||
for (let y = 0; y < height; y++) {
|
||||
const t = y / height;
|
||||
const r = lerp(26, 15, t); // #1a1a2e → #0f3460
|
||||
const g = lerp(26, 52, t);
|
||||
const b = lerp(46, 96, t);
|
||||
stroke(r, g, b);
|
||||
line(0, y, width, y);
|
||||
}
|
||||
|
||||
// Draw islands (floating platforms with subtle shadow)
|
||||
islands.forEach(island => {
|
||||
push();
|
||||
// Shadow
|
||||
fill(0, 0, 0, 40);
|
||||
ellipse(island.x + island.w/2 + 5, island.y + 5, island.w + 10, island.h + 6);
|
||||
// Island body
|
||||
fill(island.color[0], island.color[1], island.color[2]);
|
||||
ellipse(island.x + island.w/2, island.y, island.w, island.h);
|
||||
// Top highlight
|
||||
fill(255, 255, 255, 60);
|
||||
ellipse(island.x + island.w/2, island.y - island.h/3, island.w * 0.6, island.h * 0.3);
|
||||
pop();
|
||||
});
|
||||
|
||||
// Draw crystals (glowing collectibles)
|
||||
crystals.forEach(c => {
|
||||
if (c.collected) return;
|
||||
push();
|
||||
translate(c.x, c.y);
|
||||
// Glow aura
|
||||
const glow = color(`hsla(${c.hue}, 80%, 70%, 0.4)`);
|
||||
noStroke();
|
||||
fill(glow);
|
||||
ellipse(0, 0, c.size * 2.2, c.size * 2.2);
|
||||
// Crystal body (diamond shape)
|
||||
const ccol = color(`hsl(${c.hue}, 90%, 75%)`);
|
||||
fill(ccol);
|
||||
beginShape();
|
||||
vertex(0, -c.size);
|
||||
vertex(c.size * 0.6, 0);
|
||||
vertex(0, c.size);
|
||||
vertex(-c.size * 0.6, 0);
|
||||
endShape(CLOSE);
|
||||
// Inner sparkle
|
||||
fill(255, 255, 255, 180);
|
||||
ellipse(0, 0, c.size * 0.5, c.size * 0.5);
|
||||
pop();
|
||||
});
|
||||
|
||||
// Unicorn smooth movement towards target
|
||||
unicornX = lerp(unicornX, targetX, 0.08);
|
||||
unicornY = lerp(unicornY, targetY, 0.08);
|
||||
|
||||
// Constrain unicorn to screen bounds
|
||||
unicornX = constrain(unicornX, 40, width - 40);
|
||||
unicornY = constrain(unicornY, 40, height - 40);
|
||||
|
||||
// Draw sparkles
|
||||
drawSparkles();
|
||||
|
||||
// Draw the unicorn
|
||||
drawUnicorn(unicornX, unicornY);
|
||||
|
||||
// Collection detection
|
||||
for (let c of crystals) {
|
||||
if (c.collected) continue;
|
||||
const d = dist(unicornX, unicornY, c.x, c.y);
|
||||
if (d < 35) {
|
||||
c.collected = true;
|
||||
collectedCount++;
|
||||
createCollectionBurst(c.x, c.y, c.hue);
|
||||
}
|
||||
}
|
||||
|
||||
// Update particles
|
||||
updateParticles();
|
||||
|
||||
// Update HUD
|
||||
document.getElementById('score').textContent = `Crystals: ${collectedCount}/${TOTAL_CRYSTALS}`;
|
||||
document.getElementById('position').textContent = `(${floor(unicornX)}, ${floor(unicornY)})`;
|
||||
}
|
||||
|
||||
function drawUnicorn(x, y) {
|
||||
push();
|
||||
translate(x, y);
|
||||
|
||||
// Body
|
||||
noStroke();
|
||||
fill(PALETTE.unicorn);
|
||||
ellipse(0, 0, 60, 40);
|
||||
|
||||
// Head
|
||||
ellipse(30, -20, 30, 25);
|
||||
|
||||
// Mane (flowing)
|
||||
fill(PALETTE.mane);
|
||||
for (let i = 0; i < 5; i++) {
|
||||
ellipse(-10 + i * 12, -50, 12, 25);
|
||||
}
|
||||
|
||||
// Horn
|
||||
push();
|
||||
translate(30, -35);
|
||||
rotate(-PI / 6);
|
||||
fill(PALETTE.horn);
|
||||
triangle(0, 0, -8, -35, 8, -35);
|
||||
pop();
|
||||
|
||||
// Eye
|
||||
fill(PALETTE.eye);
|
||||
ellipse(38, -22, 8, 8);
|
||||
|
||||
// Legs
|
||||
stroke(PALETTE.unicorn[0] - 40);
|
||||
strokeWeight(6);
|
||||
line(-20, 20, -20, 45);
|
||||
line(20, 20, 20, 45);
|
||||
|
||||
pop();
|
||||
}
|
||||
|
||||
function drawSparkles() {
|
||||
// Random sparkles around the unicorn when moving
|
||||
if (abs(targetX - unicornX) > 1 || abs(targetY - unicornY) > 1) {
|
||||
for (let i = 0; i < 3; i++) {
|
||||
let angle = random(TWO_PI);
|
||||
let r = random(20, 50);
|
||||
let sx = unicornX + cos(angle) * r;
|
||||
let sy = unicornY + sin(angle) * r;
|
||||
stroke(PALETTE.sparkle[0], PALETTE.sparkle[1], PALETTE.sparkle[2], 150);
|
||||
strokeWeight(2);
|
||||
point(sx, sy);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function createCollectionBurst(x, y, hue) {
|
||||
// Burst of particles spiraling outward
|
||||
for (let i = 0; i < 20; i++) {
|
||||
let angle = random(TWO_PI);
|
||||
let speed = random(2, 6);
|
||||
particles.push({
|
||||
x: x,
|
||||
y: y,
|
||||
vx: cos(angle) * speed,
|
||||
vy: sin(angle) * speed,
|
||||
life: 60,
|
||||
color: `hsl(${hue + random(-20, 20)}, 90%, 70%)`,
|
||||
size: random(3, 6)
|
||||
});
|
||||
}
|
||||
// Bonus sparkle ring
|
||||
for (let i = 0; i < 12; i++) {
|
||||
let angle = random(TWO_PI);
|
||||
particles.push({
|
||||
x: x,
|
||||
y: y,
|
||||
vx: cos(angle) * 4,
|
||||
vy: sin(angle) * 4,
|
||||
life: 40,
|
||||
color: 'rgba(255, 215, 0, 0.9)',
|
||||
size: 4
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function updateParticles() {
|
||||
for (let i = particles.length - 1; i >= 0; i--) {
|
||||
let p = particles[i];
|
||||
p.x += p.vx;
|
||||
p.y += p.vy;
|
||||
p.vy += 0.1; // gravity
|
||||
p.life--;
|
||||
p.vx *= 0.95;
|
||||
p.vy *= 0.95;
|
||||
if (p.life <= 0) {
|
||||
particles.splice(i, 1);
|
||||
continue;
|
||||
}
|
||||
push();
|
||||
stroke(p.color);
|
||||
strokeWeight(p.size);
|
||||
point(p.x, p.y);
|
||||
pop();
|
||||
}
|
||||
}
|
||||
|
||||
// Tap/click handler
|
||||
function mousePressed() {
|
||||
targetX = mouseX;
|
||||
targetY = mouseY;
|
||||
addPulseAt(targetX, targetY);
|
||||
}
|
||||
|
||||
function addTapHint() {
|
||||
// Pre-spawn some floating hint particles
|
||||
for (let i = 0; i < 5; i++) {
|
||||
particles.push({
|
||||
x: random(width),
|
||||
y: random(height),
|
||||
vx: random(-0.5, 0.5),
|
||||
vy: random(-0.5, 0.5),
|
||||
life: 200,
|
||||
color: 'rgba(233, 69, 96, 0.5)',
|
||||
size: 3
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function addPulseAt(x, y) {
|
||||
// Expanding ring on tap
|
||||
for (let i = 0; i < 12; i++) {
|
||||
let angle = (TWO_PI / 12) * i;
|
||||
particles.push({
|
||||
x: x,
|
||||
y: y,
|
||||
vx: cos(angle) * 3,
|
||||
vy: sin(angle) * 3,
|
||||
life: 30,
|
||||
color: 'rgba(233, 69, 96, 0.7)',
|
||||
size: 3
|
||||
});
|
||||
}
|
||||
}
|
||||
32
luna/style.css
Normal file
32
luna/style.css
Normal file
@@ -0,0 +1,32 @@
|
||||
body {
|
||||
margin: 0;
|
||||
overflow: hidden;
|
||||
background: linear-gradient(to bottom, #1a1a2e, #16213e, #0f3460);
|
||||
font-family: 'Courier New', monospace;
|
||||
color: #e94560;
|
||||
}
|
||||
|
||||
#luna-container {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
left: 0;
|
||||
width: 100vw;
|
||||
height: 100vh;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
#hud {
|
||||
position: fixed;
|
||||
top: 10px;
|
||||
left: 10px;
|
||||
background: rgba(0, 0, 0, 0.6);
|
||||
padding: 8px 12px;
|
||||
border-radius: 4px;
|
||||
font-size: 14px;
|
||||
z-index: 100;
|
||||
border: 1px solid #e94560;
|
||||
}
|
||||
|
||||
#score { font-weight: bold; }
|
||||
93
specs/fleet-operator-incentives.md
Normal file
93
specs/fleet-operator-incentives.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# Fleet Operator Incentives Program
|
||||
|
||||
## Overview
|
||||
|
||||
This specification defines the incentive structure and certification program for Timmy Home fleet operators. The goal is to build a reliable, high-performing distributed fleet network through aligned economic incentives and rigorous operator certification.
|
||||
|
||||
## Program Objectives
|
||||
|
||||
- Recruit and retain 3-5 active certified operators within 6 months
|
||||
- Maintain operator churn <10% annually
|
||||
- Achieve fleet uptime >99.5%
|
||||
- Ensure partner channel delivers >30% of leads
|
||||
|
||||
## Operator Tiers & Requirements
|
||||
|
||||
### Tier 1: Certified Operator
|
||||
- Complete operator application and training
|
||||
- Maintain minimum hardware specifications
|
||||
- Agree to SLAs and monitoring
|
||||
- Pass technical assessment
|
||||
|
||||
### Tier 2: Senior Operator
|
||||
- 6+ months active participation
|
||||
- Uptime >99.7%
|
||||
- Mentor at least 1 new operator
|
||||
- Advanced troubleshooting capabilities
|
||||
|
||||
### Tier 3: Fleet Lead
|
||||
- 12+ months active participation
|
||||
- Uptime >99.9%
|
||||
- Team lead responsibilities
|
||||
- Strategic input on fleet improvements
|
||||
|
||||
## Incentive Structure
|
||||
|
||||
### Base Compensation
|
||||
- Tier 1: $X/month per active node
|
||||
- Tier 2: $Y/month per active node (+15% bonus)
|
||||
- Tier 3: $Z/month per active node (+30% bonus)
|
||||
|
||||
### Performance Bonuses
|
||||
- Uptime bonus: Additional 5% for >99.5% monthly uptime
|
||||
- Lead generation bonus: $100 per qualified lead from operator network
|
||||
- Mentorship bonus: $200/month per successfully onboarded mentee
|
||||
|
||||
### Penalties & Adjustments
|
||||
- Downtime deductions: Prorated based on SLA breach
|
||||
- Early termination fees: 50% of commitment period value
|
||||
- Performance improvement plan for chronic underperformance
|
||||
|
||||
## Certification Process
|
||||
|
||||
1. Application submission (operator-application.md template)
|
||||
2. Technical screening and hardware validation
|
||||
3. Training completion (modules & hands-on)
|
||||
4. Assessment exam (minimum 80% score)
|
||||
5. Probation period (30 days)
|
||||
6. Full certification
|
||||
|
||||
## Monitoring & Metrics
|
||||
|
||||
- Real-time uptime monitoring via Prometheus/Grafana
|
||||
- Monthly performance reports
|
||||
- Quarterly business reviews for senior operators
|
||||
- Automated alerting for SLA breaches
|
||||
|
||||
## Partner Program Integration
|
||||
|
||||
- Certified operators become partner channel participants
|
||||
- Operators receive referral commissions
|
||||
- Partner leads tracked through dedicated attribution system
|
||||
- Monthly partner reports generated (partner-report.md template)
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- 3-5 active certified operators by month 6
|
||||
- Annual churn rate <10%
|
||||
- Fleet-wide uptime >99.5%
|
||||
- Partner channel contribution >30% of new leads
|
||||
|
||||
## Roadmap
|
||||
|
||||
**Month 1-2:** Launch pilot program with 2 operators
|
||||
**Month 3-4:** Scale to 5 operators, refine processes
|
||||
**Month 5-6:** Optimize incentives, expand partner integration
|
||||
|
||||
## Appendix
|
||||
|
||||
- Operator agreement template
|
||||
- SLA definitions and metrics
|
||||
- Hardware requirements document
|
||||
- Training curriculum outline
|
||||
- Support escalation procedures
|
||||
161
specs/fleet-ops-runbook.md
Normal file
161
specs/fleet-ops-runbook.md
Normal file
@@ -0,0 +1,161 @@
|
||||
# Fleet Operations Runbook
|
||||
|
||||
## Emergency Procedures
|
||||
|
||||
### System Outage Response
|
||||
|
||||
**Severity 1 (Total Outage)**
|
||||
- Immediate: Alert all on-call operators via PagerDuty
|
||||
- Within 15min: Incident commander declared, communication channel established
|
||||
- Within 1hr: Root cause identified or escalation to engineering
|
||||
- Resolution: Post-mortem within 24 hours
|
||||
|
||||
**Severity 2 (Partial Degradation)**
|
||||
- Alert within 30min
|
||||
- Diagnosis within 2 hours
|
||||
- Resolution or workaround within 4 hours
|
||||
|
||||
**Severity 3 (Minor Issues)**
|
||||
- Ticket creation in incident tracker
|
||||
- Resolution within 24 hours
|
||||
|
||||
### Hardware Failure
|
||||
|
||||
1. **Node Failure Detection**
|
||||
- Automated monitoring alerts when node >5min offline
|
||||
- Operator SMS/email notification
|
||||
- Auto-escalation if no response within 10min
|
||||
|
||||
2. **Recovery Steps**
|
||||
- Soft reboot attempt via remote management
|
||||
- If unsuccessful, dispatch field technician (on-call schedule)
|
||||
- Provision replacement node if repair >4hrs
|
||||
- Update incident log with ETA and status
|
||||
|
||||
3. **Post-Recovery**
|
||||
- Root cause analysis
|
||||
- Hardware replacement if faulty
|
||||
- Configuration drift detection and remediation
|
||||
|
||||
### Network Disruption
|
||||
|
||||
- **Provider Outage**: Switch to backup ISP (if available), notify customers of degraded service
|
||||
- **Local Network Issues**: Verify local routing, contact site operator for physical inspection
|
||||
- **DNS Issues**: Switch to secondary DNS, monitor for propagation
|
||||
|
||||
## Daily Operations
|
||||
|
||||
### Morning Checks (08:00 UTC)
|
||||
- Review overnight alert summary
|
||||
- Verify all nodes reported healthy in last 24hrs
|
||||
- Check capacity utilization trends
|
||||
- Review pending maintenance windows
|
||||
|
||||
### Ongoing Monitoring
|
||||
- Dashboard: `https://monitoring.timmyfoundation.org/fleet`
|
||||
- Slack channel: `#fleet-operations`
|
||||
- PagerDuty schedule: rotate weekly among Tier 3 operators
|
||||
|
||||
### Handoff Procedure
|
||||
- Outgoing operator: Complete handoff checklist by end of shift
|
||||
- Incoming operator: Review log, verify all systems nominal
|
||||
- Both parties: Sign off in runbook log
|
||||
|
||||
## Maintenance Windows
|
||||
|
||||
- **Weekly**: Software updates (Sunday 02:00-04:00 UTC)
|
||||
- **Monthly**: Hardware inspection and cleaning
|
||||
- **Quarterly**: Full system audit and capacity planning
|
||||
|
||||
## Escalation Path
|
||||
|
||||
```
|
||||
Operator (Tier 1) → Senior Operator (Tier 2) → Fleet Lead (Tier 3)
|
||||
↓
|
||||
Engineering On-Call (P0-P1 incidents)
|
||||
↓
|
||||
CTO / Executive Review (P0 incidents, business critical)
|
||||
```
|
||||
|
||||
## Communication Templates
|
||||
|
||||
### Outage Notification (Customer-Facing)
|
||||
|
||||
```
|
||||
Subject: Service Disruption Notification
|
||||
|
||||
Dear Customer,
|
||||
|
||||
We are currently experiencing an issue affecting [service]. Our team is investigating and working to restore service as quickly as possible.
|
||||
|
||||
Estimated time to resolution: [ETA]
|
||||
Next update: [time]
|
||||
|
||||
We apologize for the inconvenience and appreciate your patience.
|
||||
|
||||
Timmy Operations Team
|
||||
```
|
||||
|
||||
### Internal Alert
|
||||
|
||||
```
|
||||
🚨 FLEET INCIDENT: [SEVERITY] - [NODE/SERVICE]
|
||||
|
||||
Impact: [description]
|
||||
Action: [immediate action required]
|
||||
Owner: [assigned operator]
|
||||
ETA: [estimated resolution time]
|
||||
|
||||
Link to incident: [URL]
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- Architecture diagrams: `docs/architecture/`
|
||||
- Configuration management: `docs/config/`
|
||||
- Operator handbook: `specs/fleet-operator-incentives.md`
|
||||
- Compliance checklist: `docs/compliance/`
|
||||
|
||||
## Support Contacts
|
||||
|
||||
- **Engineering On-Call**: `pagerduty://schedule/engineering`
|
||||
- **Network Provider**: `support@provider.com / 1-800-SUPPORT`
|
||||
- **Hardware Vendor**: `support@vendor.com / 1-800-HARDWARE`
|
||||
- **Internal Fleet Slack**: `#fleet-operations`
|
||||
|
||||
## Recovery Objectives (RTO/RPO)
|
||||
|
||||
| Service | RTO | RPO |
|
||||
|---------|-----|-----|
|
||||
| API Services | 15min | 5min |
|
||||
| Data Pipeline | 1hr | 15min |
|
||||
| Monitoring | 30min | N/A |
|
||||
| Backup Systems | 4hr | 24hr |
|
||||
|
||||
## Change Management
|
||||
|
||||
- All production changes require RFC and approval
|
||||
- Emergency changes: Document rationale, notify within 24hrs
|
||||
- Standard changes: Weekly change window (Wednesday 22:00 UTC)
|
||||
- Post-change validation required for all modifications
|
||||
|
||||
## Security Incidents
|
||||
|
||||
- Immediate isolation of affected nodes
|
||||
- Preserve logs for forensic analysis
|
||||
- Notify security team within 15min
|
||||
- Follow incident response playbook: `docs/security/incident-response.md`
|
||||
|
||||
## Metrics & KPIs
|
||||
|
||||
- **MTTR**: Mean time to recovery
|
||||
- **Uptime**: Node and service availability percentages
|
||||
- **Capacity**: Utilization vs. provisioned resources
|
||||
- **Customer Impact**: Number of affected customers per incident
|
||||
|
||||
## Appendix
|
||||
|
||||
- Outage history log
|
||||
- Maintenance schedule
|
||||
- Vendor contact list
|
||||
- Compliance audit checklist
|
||||
112
specs/templates/operator-application.md
Normal file
112
specs/templates/operator-application.md
Normal file
@@ -0,0 +1,112 @@
|
||||
# Fleet Operator Application
|
||||
|
||||
## Personal Information
|
||||
|
||||
**Full Name:**
|
||||
**Email:**
|
||||
**Phone:**
|
||||
**Location (City, State/Province, Country):**
|
||||
**Time Zone:**
|
||||
|
||||
## Business Entity
|
||||
|
||||
**Legal Structure:** (Sole Proprietor / LLC / Corporation / Other)
|
||||
**Business Registration Number:**
|
||||
**Tax ID/EIN:**
|
||||
**Years in Operation:**
|
||||
|
||||
## Technical Capabilities
|
||||
|
||||
### Infrastructure
|
||||
|
||||
- **Number of Nodes Available:** __________
|
||||
- **Hardware Specifications (per node):**
|
||||
- CPU: __________
|
||||
- RAM: __________
|
||||
- Storage: __________
|
||||
- Network: __________
|
||||
|
||||
- **Uptime History (past 12 months):** __________%
|
||||
- **Average Monthly Downtime:** __________ hours
|
||||
|
||||
### Connectivity
|
||||
|
||||
- **Primary ISP:** __________
|
||||
- **Backup ISP:** __________ (Yes/No)
|
||||
- **Average Upload Speed:** __________ Mbps
|
||||
- **Average Download Speed:** __________ Mbps
|
||||
- **Latency to primary regions:** __________ ms
|
||||
|
||||
### Security & Compliance
|
||||
|
||||
- **Physical Security Measures:** (e.g., locked racks, cameras)
|
||||
- **Network Security:** (firewalls, VPNs, monitoring)
|
||||
- **Data Privacy Compliance:** (GDPR, CCPA, etc.)
|
||||
- **Insurance Coverage:** (liability, errors & omissions)
|
||||
|
||||
## Operational Capacity
|
||||
|
||||
**Support Hours:** __________ (24/7 / Business Hours / On-call)
|
||||
**Staff Count:** __________ (Full-time / Part-time)
|
||||
**Incident Response SLA:** __________
|
||||
**Monitoring Tools Used:** __________
|
||||
|
||||
## Financial Terms
|
||||
|
||||
**Desired Compensation Model:** (Tier 1 / Tier 2 / Tier 3)
|
||||
**Expected Monthly Revenue:** $__________
|
||||
**Start Date Availability:** __________
|
||||
**Commitment Period:** (6 months / 12 months / 24 months)
|
||||
|
||||
## References
|
||||
|
||||
**Previous Fleet/Customer References:**
|
||||
1. Name: __________ | Contact: __________ | Relationship: __________
|
||||
2. Name: __________ | Contact: __________ | Relationship: __________
|
||||
|
||||
**Technical References:**
|
||||
1. Name: __________ | Contact: __________ | Relationship: __________
|
||||
|
||||
## Certifications
|
||||
|
||||
- [ ] AWS/Azure/GCP Certification
|
||||
- [ ] Network+ / Security+
|
||||
- [ ] ISO 27001
|
||||
- [ ] SOC 2
|
||||
- [ ] Other: __________
|
||||
|
||||
## Motivation & Alignment
|
||||
|
||||
**Why do you want to join the Timmy Home Fleet?** (max 500 words)
|
||||
|
||||
**How does your operation align with our values of reliability, transparency, and continuous improvement?** (max 300 words)
|
||||
|
||||
## Attachments
|
||||
|
||||
- [ ] Proof of business registration
|
||||
- [ ] Insurance certificates
|
||||
- [ ] Network performance reports (last 3 months)
|
||||
- [ ] Hardware inventory list
|
||||
- [ ] Signed NDA (if not already on file)
|
||||
|
||||
## Agreement
|
||||
|
||||
By submitting this application, I certify that all information provided is accurate and complete. I understand that false statements may result in termination of the operator agreement.
|
||||
|
||||
**Signature:** _________________________
|
||||
**Date:** _________________________
|
||||
|
||||
## Internal Use Only (Timmy Home Team)
|
||||
|
||||
- **Application Received:** __________
|
||||
- **Initial Screening:** __________ (Pass/Fail) by __________
|
||||
- **Technical Review:** __________ (Pass/Fail) by __________
|
||||
- **Site Visit/Remote Inspection:** __________ (Completed/Dates)
|
||||
- **Certification Assigned:** __________ (Tier 1 / Tier 2 / Tier 3)
|
||||
- **Onboarding Date:** __________
|
||||
- **Mentor Assigned:** __________
|
||||
- **Operational Start Date:** __________
|
||||
|
||||
**Notes:**
|
||||
__________
|
||||
__________
|
||||
134
specs/templates/partner-report.md
Normal file
134
specs/templates/partner-report.md
Normal file
@@ -0,0 +1,134 @@
|
||||
# Partner Monthly Report
|
||||
|
||||
## Report Period
|
||||
|
||||
**Month/Year:** __________
|
||||
**Partner ID:** __________
|
||||
**Partner Name:** __________
|
||||
**Report Generated:** __________
|
||||
|
||||
## Executive Summary
|
||||
|
||||
- Total leads generated: __________
|
||||
- Qualified leads: __________
|
||||
- converted customers: __________
|
||||
- Revenue attributed: $__________
|
||||
- Commission earned: $__________
|
||||
- YoY growth: __________%
|
||||
|
||||
## Lead Generation Metrics
|
||||
|
||||
### Lead Volume
|
||||
|
||||
| Channel | Total Leads | Qualified Leads | Conversion Rate | Notes |
|
||||
|---------|-------------|-----------------|-----------------|-------|
|
||||
| Direct Referral | __ | __ | __% | |
|
||||
| Marketing Campaign | __ | __ | __% | |
|
||||
| Events/Conferences | __ | __ | __% | |
|
||||
| Other: __________ | __ | __ | __% | |
|
||||
|
||||
### Lead Quality Assessment
|
||||
|
||||
- **High Value (likely to convert):** __________ leads
|
||||
- **Medium Value:** __________ leads
|
||||
- **Low Value:** __________ leads
|
||||
- **Lead Source Validation:** __________% verified
|
||||
|
||||
## Revenue & Commission
|
||||
|
||||
### Revenue Attribution
|
||||
|
||||
| Customer | Deal Size | Start Date | Commission % | Commission Amount |
|
||||
|----------|-----------|------------|--------------|-------------------|
|
||||
| | $ | | % | $ |
|
||||
| | $ | | % | $ |
|
||||
| | $ | | % | $ |
|
||||
|
||||
- **Total Revenue:** $__________
|
||||
- **Total Commission:** $__________
|
||||
- **Commission Rate:** __________%
|
||||
- **Payment Status:** (Paid / Pending / Escrow)
|
||||
|
||||
### Payment Schedule
|
||||
|
||||
- **Commission Period:** 1st - last day of month
|
||||
- **Payment Date:** __________ (net 30 days)
|
||||
- **Payment Method:** (ACH / Wire / Check / Crypto)
|
||||
- **Invoice Attached:** (Yes/No)
|
||||
|
||||
## Fleet Performance Impact
|
||||
|
||||
### Operator Contributions
|
||||
|
||||
| Operator | Leads Generated | Conversions | Revenue Impact |
|
||||
|----------|----------------|-------------|----------------|
|
||||
| | | | $ |
|
||||
| | | | $ |
|
||||
| | | | $ |
|
||||
|
||||
### Uptime & Reliability Correlation
|
||||
|
||||
- **Average fleet uptime during reporting period:** __________%
|
||||
- **Leads from high-uptime operators (>99.5%):** __________
|
||||
- **Customer complaints related to fleet issues:** __________
|
||||
|
||||
## Marketing & Training Activities
|
||||
|
||||
### Promotional Efforts
|
||||
|
||||
- Campaigns run: __________
|
||||
- Materials distributed: __________
|
||||
- Events attended: __________
|
||||
- Content created: __________
|
||||
|
||||
### Training Completed
|
||||
|
||||
- New operator certifications: __________
|
||||
- Continuing education hours: __________
|
||||
- Process improvements implemented: __________
|
||||
|
||||
## Challenges & Blockers
|
||||
|
||||
- __________
|
||||
- __________
|
||||
- __________
|
||||
|
||||
## Opportunities & Goals (Next Period)
|
||||
|
||||
1. __________
|
||||
2. __________
|
||||
3. __________
|
||||
|
||||
## Support Needs
|
||||
|
||||
- __ Technical assistance
|
||||
- __ Marketing materials
|
||||
- __ Training resources
|
||||
- __ Lead qualification support
|
||||
- __ Other: __________
|
||||
|
||||
## Compliance & Agreement Status
|
||||
|
||||
- [ ] All reporting requirements met
|
||||
- [ ] Commissions calculated correctly
|
||||
- [ ] SLA adherence documented
|
||||
- [ ] Partner agreement in good standing
|
||||
- [ ] No compliance violations
|
||||
|
||||
**Partner Signature:** _________________________
|
||||
**Date:** _________________________
|
||||
|
||||
**Timmy Home Representative:** _________________________
|
||||
**Date:** _________________________
|
||||
|
||||
## Attachments
|
||||
|
||||
- [ ] Lead verification documentation
|
||||
- [ ] Revenue reports from finance system
|
||||
- [ ] Commission calculation spreadsheet
|
||||
- [ ] Marketing activity logs
|
||||
- [ ] Training completion certificates
|
||||
|
||||
---
|
||||
|
||||
*This report is confidential and intended solely for the use of the partner and Timmy Home leadership. Distribution without authorization is prohibited.*
|
||||
@@ -1 +1,12 @@
|
||||
# Timmy core module
|
||||
|
||||
from .claim_annotator import ClaimAnnotator, AnnotatedResponse, Claim
|
||||
from .audit_trail import AuditTrail, AuditEntry
|
||||
|
||||
__all__ = [
|
||||
"ClaimAnnotator",
|
||||
"AnnotatedResponse",
|
||||
"Claim",
|
||||
"AuditTrail",
|
||||
"AuditEntry",
|
||||
]
|
||||
|
||||
156
src/timmy/claim_annotator.py
Normal file
156
src/timmy/claim_annotator.py
Normal file
@@ -0,0 +1,156 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Response Claim Annotator — Source Distinction System
|
||||
SOUL.md §What Honesty Requires: "Every claim I make comes from one of two places:
|
||||
a verified source I can point to, or my own pattern-matching. My user must be
|
||||
able to tell which is which."
|
||||
"""
|
||||
|
||||
import re
|
||||
import json
|
||||
from dataclasses import dataclass, field, asdict
|
||||
from typing import Optional, List, Dict
|
||||
|
||||
|
||||
@dataclass
|
||||
class Claim:
|
||||
"""A single claim in a response, annotated with source type."""
|
||||
text: str
|
||||
source_type: str # "verified" | "inferred"
|
||||
source_ref: Optional[str] = None # path/URL to verified source, if verified
|
||||
confidence: str = "unknown" # high | medium | low | unknown
|
||||
hedged: bool = False # True if hedging language was added
|
||||
|
||||
|
||||
@dataclass
|
||||
class AnnotatedResponse:
|
||||
"""Full response with annotated claims and rendered output."""
|
||||
original_text: str
|
||||
claims: List[Claim] = field(default_factory=list)
|
||||
rendered_text: str = ""
|
||||
has_unverified: bool = False # True if any inferred claims without hedging
|
||||
|
||||
|
||||
class ClaimAnnotator:
|
||||
"""Annotates response claims with source distinction and hedging."""
|
||||
|
||||
# Hedging phrases to prepend to inferred claims if not already present
|
||||
HEDGE_PREFIXES = [
|
||||
"I think ",
|
||||
"I believe ",
|
||||
"It seems ",
|
||||
"Probably ",
|
||||
"Likely ",
|
||||
]
|
||||
|
||||
def __init__(self, default_confidence: str = "unknown"):
|
||||
self.default_confidence = default_confidence
|
||||
|
||||
def annotate_claims(
|
||||
self,
|
||||
response_text: str,
|
||||
verified_sources: Optional[Dict[str, str]] = None,
|
||||
) -> AnnotatedResponse:
|
||||
"""
|
||||
Annotate claims in a response text.
|
||||
|
||||
Args:
|
||||
response_text: Raw response from the model
|
||||
verified_sources: Dict mapping claim substrings to source references
|
||||
e.g. {"Paris is the capital of France": "https://en.wikipedia.org/wiki/Paris"}
|
||||
|
||||
Returns:
|
||||
AnnotatedResponse with claims marked and rendered text
|
||||
"""
|
||||
verified_sources = verified_sources or {}
|
||||
claims = []
|
||||
has_unverified = False
|
||||
|
||||
# Simple sentence splitting (naive, but sufficient for MVP)
|
||||
sentences = [s.strip() for s in re.split(r'[.!?]\s+', response_text) if s.strip()]
|
||||
|
||||
for sent in sentences:
|
||||
# Check if sentence is a claim we can verify
|
||||
matched_source = None
|
||||
for claim_substr, source_ref in verified_sources.items():
|
||||
if claim_substr.lower() in sent.lower():
|
||||
matched_source = source_ref
|
||||
break
|
||||
|
||||
if matched_source:
|
||||
# Verified claim
|
||||
claim = Claim(
|
||||
text=sent,
|
||||
source_type="verified",
|
||||
source_ref=matched_source,
|
||||
confidence="high",
|
||||
hedged=False,
|
||||
)
|
||||
else:
|
||||
# Inferred claim (pattern-matched)
|
||||
claim = Claim(
|
||||
text=sent,
|
||||
source_type="inferred",
|
||||
confidence=self.default_confidence,
|
||||
hedged=self._has_hedge(sent),
|
||||
)
|
||||
if not claim.hedged:
|
||||
has_unverified = True
|
||||
|
||||
claims.append(claim)
|
||||
|
||||
# Render the annotated response
|
||||
rendered = self._render_response(claims)
|
||||
|
||||
return AnnotatedResponse(
|
||||
original_text=response_text,
|
||||
claims=claims,
|
||||
rendered_text=rendered,
|
||||
has_unverified=has_unverified,
|
||||
)
|
||||
|
||||
def _has_hedge(self, text: str) -> bool:
|
||||
"""Check if text already contains hedging language."""
|
||||
text_lower = text.lower()
|
||||
for prefix in self.HEDGE_PREFIXES:
|
||||
if text_lower.startswith(prefix.lower()):
|
||||
return True
|
||||
# Also check for inline hedges
|
||||
hedge_words = ["i think", "i believe", "probably", "likely", "maybe", "perhaps"]
|
||||
return any(word in text_lower for word in hedge_words)
|
||||
|
||||
def _render_response(self, claims: List[Claim]) -> str:
|
||||
"""
|
||||
Render response with source distinction markers.
|
||||
|
||||
Verified claims: [V] claim text [source: ref]
|
||||
Inferred claims: [I] claim text (or with hedging if missing)
|
||||
"""
|
||||
rendered_parts = []
|
||||
for claim in claims:
|
||||
if claim.source_type == "verified":
|
||||
part = f"[V] {claim.text}"
|
||||
if claim.source_ref:
|
||||
part += f" [source: {claim.source_ref}]"
|
||||
else: # inferred
|
||||
if not claim.hedged:
|
||||
# Add hedging if missing
|
||||
hedged_text = f"I think {claim.text[0].lower()}{claim.text[1:]}" if claim.text else claim.text
|
||||
part = f"[I] {hedged_text}"
|
||||
else:
|
||||
part = f"[I] {claim.text}"
|
||||
rendered_parts.append(part)
|
||||
return " ".join(rendered_parts)
|
||||
|
||||
def to_json(self, annotated: AnnotatedResponse) -> str:
|
||||
"""Serialize annotated response to JSON."""
|
||||
return json.dumps(
|
||||
{
|
||||
"original_text": annotated.original_text,
|
||||
"rendered_text": annotated.rendered_text,
|
||||
"has_unverified": annotated.has_unverified,
|
||||
"claims": [asdict(c) for c in annotated.claims],
|
||||
},
|
||||
indent=2,
|
||||
ensure_ascii=False,
|
||||
)
|
||||
103
tests/timmy/test_claim_annotator.py
Normal file
103
tests/timmy/test_claim_annotator.py
Normal file
@@ -0,0 +1,103 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Tests for claim_annotator.py — verifies source distinction is present."""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import json
|
||||
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "src"))
|
||||
|
||||
from timmy.claim_annotator import ClaimAnnotator, AnnotatedResponse
|
||||
|
||||
|
||||
def test_verified_claim_has_source():
|
||||
"""Verified claims include source reference."""
|
||||
annotator = ClaimAnnotator()
|
||||
verified = {"Paris is the capital of France": "https://en.wikipedia.org/wiki/Paris"}
|
||||
response = "Paris is the capital of France. It is a beautiful city."
|
||||
|
||||
result = annotator.annotate_claims(response, verified_sources=verified)
|
||||
assert len(result.claims) > 0
|
||||
verified_claims = [c for c in result.claims if c.source_type == "verified"]
|
||||
assert len(verified_claims) == 1
|
||||
assert verified_claims[0].source_ref == "https://en.wikipedia.org/wiki/Paris"
|
||||
assert "[V]" in result.rendered_text
|
||||
assert "[source:" in result.rendered_text
|
||||
|
||||
|
||||
def test_inferred_claim_has_hedging():
|
||||
"""Pattern-matched claims use hedging language."""
|
||||
annotator = ClaimAnnotator()
|
||||
response = "The weather is nice today. It might rain tomorrow."
|
||||
|
||||
result = annotator.annotate_claims(response)
|
||||
inferred_claims = [c for c in result.claims if c.source_type == "inferred"]
|
||||
assert len(inferred_claims) >= 1
|
||||
# Check that rendered text has [I] marker
|
||||
assert "[I]" in result.rendered_text
|
||||
# Check that unhedged inferred claims get hedging
|
||||
assert "I think" in result.rendered_text or "I believe" in result.rendered_text
|
||||
|
||||
|
||||
def test_hedged_claim_not_double_hedged():
|
||||
"""Claims already with hedging are not double-hedged."""
|
||||
annotator = ClaimAnnotator()
|
||||
response = "I think the sky is blue. It is a nice day."
|
||||
|
||||
result = annotator.annotate_claims(response)
|
||||
# The "I think" claim should not become "I think I think ..."
|
||||
assert "I think I think" not in result.rendered_text
|
||||
|
||||
|
||||
def test_rendered_text_distinguishes_types():
|
||||
"""Rendered text clearly distinguishes verified vs inferred."""
|
||||
annotator = ClaimAnnotator()
|
||||
verified = {"Earth is round": "https://science.org/earth"}
|
||||
response = "Earth is round. Stars are far away."
|
||||
|
||||
result = annotator.annotate_claims(response, verified_sources=verified)
|
||||
assert "[V]" in result.rendered_text # verified marker
|
||||
assert "[I]" in result.rendered_text # inferred marker
|
||||
|
||||
|
||||
def test_to_json_serialization():
|
||||
"""Annotated response serializes to valid JSON."""
|
||||
annotator = ClaimAnnotator()
|
||||
response = "Test claim."
|
||||
result = annotator.annotate_claims(response)
|
||||
json_str = annotator.to_json(result)
|
||||
parsed = json.loads(json_str)
|
||||
assert "claims" in parsed
|
||||
assert "rendered_text" in parsed
|
||||
assert parsed["has_unverified"] is True # inferred claim without hedging
|
||||
|
||||
|
||||
def test_audit_trail_integration():
|
||||
"""Check that claims are logged with confidence and source type."""
|
||||
# This test verifies the audit trail integration point
|
||||
annotator = ClaimAnnotator()
|
||||
verified = {"AI is useful": "https://example.com/ai"}
|
||||
response = "AI is useful. It can help with tasks."
|
||||
|
||||
result = annotator.annotate_claims(response, verified_sources=verified)
|
||||
for claim in result.claims:
|
||||
assert claim.source_type in ("verified", "inferred")
|
||||
assert claim.confidence in ("high", "medium", "low", "unknown")
|
||||
if claim.source_type == "verified":
|
||||
assert claim.source_ref is not None
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
test_verified_claim_has_source()
|
||||
print("✓ test_verified_claim_has_source passed")
|
||||
test_inferred_claim_has_hedging()
|
||||
print("✓ test_inferred_claim_has_hedging passed")
|
||||
test_hedged_claim_not_double_hedged()
|
||||
print("✓ test_hedged_claim_not_double_hedged passed")
|
||||
test_rendered_text_distinguishes_types()
|
||||
print("✓ test_rendered_text_distinguishes_types passed")
|
||||
test_to_json_serialization()
|
||||
print("✓ test_to_json_serialization passed")
|
||||
test_audit_trail_integration()
|
||||
print("✓ test_audit_trail_integration passed")
|
||||
print("\nAll tests passed!")
|
||||
Reference in New Issue
Block a user