Integrate TDD and Grill with Docs into Design, Implementation, and Verification workflows
This commit is contained in:
@@ -2,8 +2,48 @@
|
||||
|
||||
A contract-based operating system for LLM agents, designed to enforce disciplined engineering workflows.
|
||||
|
||||
## Core Philosophy
|
||||
The framework prevents agents from "hallucinating" features or jumping into code without a plan. It enforces a strict separation between **Planning (Research)** and **Execution (Implementation)**, mediated by a **Verification** loop.
|
||||
## 1. Global Framework Installation (One-time setup)
|
||||
|
||||
Before you can use the framework in any project, you must install the core logic into your local environment.
|
||||
|
||||
**Run these commands in your terminal:**
|
||||
|
||||
```bash
|
||||
# Clone the framework into the global config directory
|
||||
git clone [INSERT_FRAMEWORK_REPO_URL_HERE] ~/.agent-framework
|
||||
|
||||
# Enter the directory
|
||||
cd ~/.agent-framework
|
||||
|
||||
# Make the installation script executable and run it
|
||||
chmod +x install.sh
|
||||
./install.sh
|
||||
```
|
||||
*Note: This creates the "brain" of the framework (prompts, state machines, and rules) in your home directory.*
|
||||
|
||||
---
|
||||
|
||||
## 2. Project Setup (Per project)
|
||||
|
||||
Once the framework is installed globally, you must "onboard" every individual project you work on.
|
||||
|
||||
### Option A: The Agent-Driven Way (Recommended)
|
||||
If you want the agent to handle the configuration for you, navigate to your project root and run:
|
||||
|
||||
> *"Onboard this project into the agent-framework."*
|
||||
|
||||
The agent will automatically:
|
||||
1. Detect your project type (New, Existing, or Upgrade).
|
||||
2. Create the `./.agent-framework/` directory.
|
||||
3. Generate your `AGENT.md` and `RULES.md` files.
|
||||
4. Initiate the "Exploration Ritual" to understand your codebase.
|
||||
|
||||
### Option B: The Manual Way
|
||||
If you prefer to set it up manually, create a `.agent-framework/` directory in your project root and add:
|
||||
- `AGENT.md`: Project-specific configuration (Mode, rules, etc.).
|
||||
- `RULES.md`: Project-specific constraints and past failure modes.
|
||||
|
||||
---
|
||||
|
||||
## The Autopilot Workflow
|
||||
The framework features an **Autopilot** mode that allows the agent to drive a project to completion with minimal intervention.
|
||||
@@ -20,17 +60,11 @@ Add `Autopilot: Enabled` to your project's `.agent-framework/AGENT.md` and use t
|
||||
|
||||
> *"Initialize Autopilot for this project. Scan the tasks/ directory and report the current status of all tasks and the recommended next actions."*
|
||||
|
||||
The agent will then:
|
||||
- Scan the `tasks/` directory.
|
||||
- Identify the current phase of every task based on existing artifacts.
|
||||
- Recommend the next command to progress each task.
|
||||
- Automatically move to the next phase once the current one's artifacts are produced.
|
||||
|
||||
## Key Components
|
||||
- `AGENT.md`: Project-specific configuration and mode selection.
|
||||
- `RULES.md`: Living document of project constraints and past failure modes.
|
||||
- `prompts/`: Specialized system prompts for each phase (Research, Implement, Bug Finder, etc.).
|
||||
- `workflow.md`: The state machine governing the Autopilot lifecycle.
|
||||
|
||||
## Installation
|
||||
Clone the repository and set up your project following the instructions in `ONBOARDING.md`.
|
||||
## Contact & Support
|
||||
[Insert Contact Info]
|
||||
|
||||
Reference in New Issue
Block a user