You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43Lines changed: 43 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,49 @@ This repo already carries more engineering evidence than the old README surfaced
50
50
-`tests/test_phase5_ui_contract.py` and `tests/test_phase5_operator_views.py` lock the operator UI to timeline, routing, artifact, and specialist-view contracts.
51
51
-`.github/workflows/ci.yml` currently runs the static UI contract suite in CI; the broader local suite demonstrates the intended validation model even though the automation surface is still narrow.
52
52
53
+
## Quickstart
54
+
55
+
The checked-in snapshot is immediately useful for architecture review and for running the same dependency-light contract tests used by CI:
Those tests inspect the checked-in operator-workbench assets and require only Python plus `pytest`.
66
+
67
+
This snapshot does **not** currently include a dependency manifest, `.env.example`, application launcher, or all modules imported by the legacy dashboard path. As a result, there is no supported clean-clone command for launching the full MAF runtime or dashboard from this branch. Treat the runtime code as implementation evidence until its packaging and bootstrap files are restored.
68
+
69
+
## Configuration
70
+
71
+
`maf_starter/config.py` is the source of truth for the active MAF configuration contract. It reads process environment variables and, when present, a repo-root `.env` file. No `.env.example` is checked in, so create a local `.env` only when integrating the runtime into an environment that supplies the missing dependencies and entrypoint. Never commit API keys.
72
+
73
+
Minimal provider and workspace settings:
74
+
75
+
```dotenv
76
+
GEMINI_API_KEY=your-gemini-api-key
77
+
MAF_REPO_ROOT=C:\path\to\target-repository
78
+
```
79
+
80
+
| Variable | Required | Default | Purpose |
81
+
|----------|----------|---------|---------|
82
+
|`MAF_API_KEY` or `GEMINI_API_KEY`| Yes for MAF agent construction | None | API key used by the OpenAI-compatible Gemini client; `MAF_API_KEY` takes precedence. |
83
+
|`MAF_MODEL` or `GEMINI_MODEL`| No |`gemini-2.5-flash`| Primary model; the `MAF_*` name takes precedence. |
84
+
|`MAF_BASE_URL` or `GEMINI_BASE_URL`| No | Gemini OpenAI-compatible endpoint | Provider base URL; the `MAF_*` name takes precedence. |
85
+
|`MAF_REPO_ROOT`| No | Repository root | Repository exposed to bounded repo tools. The path must exist. |
86
+
|`MAF_ENTITIES_DIR`| No |`entities`| Entity discovery directory. |
87
+
|`MAF_CHECKPOINT_DIR`| No |`state\maf-checkpoints`| File-backed checkpoint location. |
88
+
|`MAF_ROUTE_LANE`| No |`auto`| Routing lane used to select task depth and provider order. |
|`ANTHROPIC_API_KEY`, `ANTHROPIC_MODEL`| No | No key; `claude-sonnet-4-6` model | Enables the optional Anthropic fallback when its package is installed. |
92
+
|`GEMINI_CLI_COMMAND`, `CLAUDE_CLI_COMMAND`, `CODEX_CLI_COMMAND`| No |`gemini.cmd`, `claude`, `codex.cmd`| Executable names used by optional local CLI fallbacks. |
93
+
94
+
Additional optional model-candidate and CLI-model overrides are defined directly in `maf_starter/config.py`.
95
+
53
96
## Why This Is A Strong Hiring Signal
54
97
55
98
This project demonstrates more than framework familiarity. It shows judgment about:
0 commit comments