English
Overview
eyeful reviews code changes with a group of agents. A planner groups the change, the experts each group needs review it in parallel. When eyeful finds the project's test commands, it then has a test written for each reported bug and runs it; otherwise a judge reads the findings. The result reaches a person as review comments.
Status
- Works: local reviews.
eyeful review,provider,connect,commitand the desktop app run the whole workflow with your own coding agent (Running locally). - In progress: the evaluation, whose tooling is built and whose experiment has not run (Evaluation). Cloud reviews run each pull request in a GitHub Actions job and verify in a sandbox container per review (Running in the cloud).
- Planned: the L1 tools and the experts' own tools (Roadmap).
Limits
- It is not a testing tool. It writes one test per finding and runs the project's own suite. It does not generate a suite or measure coverage (Relation to CI).
- It does not see a running interface. The usability expert reads markup and component code; nothing renders a page (Experts).
- A review without findings proves nothing. It finds what a model notices in the changed files, and two reviews of one change can differ.
- It reports only what the change introduces. Flaws the base commit had, and anything outside the repository, are left out.
- It proves only what a unit-sized test can show. Performance, timing between threads, and behaviour that needs a database or a browser are read by the judge and never run.
- It does not approve or merge (A review).
- Locally there is no sandbox. Its agents run as the user (Running locally).
Documents
How a review works:
| Document | Covers |
|---|---|
| A review, end to end | Stages, results, the review standard, rules, gaps |
| Planning and triage | The CI check, triage, large changes, the plan |
| Levels | Who decides how closely to look, the budget |
| Experts | Each expert's standards, skills and tools |
| Evidence and verification | The verifier, oracles, the judge, SARIF |
| Review feedback | Comment format, the ranked report, rounds |
| Running locally | Desktop and CLI, the snapshot, agents, local risks |
| Questions and answers | What is reviewed, large changes, changing files |
| References | Standards and borrowed projects |
| Principles | The author's eight working principles |
How eyeful is measured: Evaluation.
How the code is built:
| Document | Covers |
|---|---|
| Architecture | Components, the workflow, layout |
| Local development | Setup, commands, code generation |
| Code style and review | Coding rules and how changes are reviewed |
The cloud, which is separate. A pull request is reviewed in a GitHub Actions job and verified in its own sandbox:
| Document | Covers |
|---|---|
| Running in the cloud | Pull requests, agents and models, the sandbox |
| The action | Components, layout, lifecycle |
| Review lifecycle | Triggers, who may start a review, re-runs |
| Deployment | The workflow, secrets, the model provider |
Every setting is in Configuration. What comes next: the Roadmap.
Each document owns one topic and describes what the code does now; planned work is marked. English is the source and zh/ is the translation.
