Skip to content

Commit f2b1210

Browse files
committed
docs(runtime): resolve F-01 document runnable validated setup
1 parent 4975e0b commit f2b1210

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,27 +48,32 @@ This repo already carries more engineering evidence than the old README surfaced
4848
- `tests/test_phase4_approval.py` proves destructive writes and externally visible commands are classified and paused behind approval.
4949
- `tests/test_phase4_validation.py` checks that changed files produce a proportionate validation ladder including `git diff --check`, Python compile checks, unit discovery, and JavaScript syntax checks.
5050
- `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-
- `.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.
51+
- `.github/workflows/ci.yml` installs the declared environment and runs the full suite, Python compilation, dependency consistency, and JavaScript syntax checks on Windows and Linux.
5252

5353
## Quickstart
5454

55-
The checked-in snapshot is immediately useful for architecture review and for running the same dependency-light contract tests used by CI:
55+
The checked-in snapshot supports a clean-clone local dashboard and full validation workflow:
5656

5757
```powershell
5858
git clone https://github.com/Coding-Autopilot-System/autogen.git
5959
Set-Location autogen
6060
61-
python -m pip install pytest
62-
python -m pytest tests/test_phase5_ui_contract.py tests/test_phase5_operator_views.py -v
61+
python -m venv .venv
62+
.\.venv\Scripts\python.exe -m pip install -r requirements.txt
63+
Copy-Item .env.example .env
64+
65+
.\.venv\Scripts\python.exe main.py providers
66+
.\.venv\Scripts\python.exe main.py dashboard --host 127.0.0.1 --port 8000
6367
```
6468

65-
Those tests inspect the checked-in operator-workbench assets and require only Python plus `pytest`.
69+
Run the complete regression suite before changing runtime behavior:
6670

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.
71+
```powershell
72+
.\.venv\Scripts\python.exe -m pytest -q --tb=short
73+
```
6874

6975
## 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.
76+
`maf_starter/config.py` is the source of truth for the active MAF configuration contract. Copy `.env.example` to `.env`, set only the providers you intend to use, and never commit API keys. The legacy dashboard launcher also reads `AUTOGEN_*` settings through `autogen_starter/config.py`.
7277

7378
Minimal provider and workspace settings:
7479

@@ -88,7 +93,8 @@ MAF_REPO_ROOT=C:\path\to\target-repository
8893
| `MAF_ROUTE_LANE` | No | `auto` | Routing lane used to select task depth and provider order. |
8994
| `MAF_REQUESTED_PROVIDER`, `MAF_REQUESTED_MODEL` | No | None | Optional explicit provider/model selection. |
9095
| `MAF_FALLBACK_CHAIN` | No | Built-in Gemini/API/CLI chain | Comma-separated fallback steps. |
91-
| `ANTHROPIC_API_KEY`, `ANTHROPIC_MODEL` | No | No key; `claude-sonnet-4-6` model | Enables the optional Anthropic fallback when its package is installed. |
96+
| ANTHROPIC_API_KEY, ANTHROPIC_MODEL | No | No key; claude-sonnet-4-6 model | Enables the optional Anthropic fallback when its package is installed. |
97+
| `AUTOGEN_CORS_ORIGINS` | No | Explicit loopback origins | Comma-separated origins allowed to call the local dashboard API; wildcard CORS is rejected. |
9298
| `GEMINI_CLI_COMMAND`, `CLAUDE_CLI_COMMAND`, `CODEX_CLI_COMMAND` | No | `gemini.cmd`, `claude`, `codex.cmd` | Executable names used by optional local CLI fallbacks. |
9399

94100
Additional optional model-candidate and CLI-model overrides are defined directly in `maf_starter/config.py`.

0 commit comments

Comments
 (0)