Refactor: rename framework files to dot-prefixed lowercase, fix onboarding references, validate VRAM detection
- Rename AGENT.md -> .agent.md, RULES.md -> .rules.md, ONBOARDING.md -> .onboarding.md - Rename BUG_REPORT.md -> .bug_report.md, ADVERSARIAL_BUG_REPORT.md -> .adversarial_bug_report.md, VERDICT.md -> .verdict.md - Fix onboarding.md references to use new .onboarding.md path - Fix stop-hook-pattern.md reference to use .onboarding.md - Update README.md, config.md, install.sh, update.sh, prompts/*, references/* - VRAM detection script validated and working
This commit is contained in:
@@ -10,10 +10,10 @@ Before you can use the framework in any project, you must install the core logic
|
||||
|
||||
```bash
|
||||
# Clone the framework into the global config directory
|
||||
git clone [INSERT_FRAMEWORK_REPO_URL_HERE] ~/.agent-framework
|
||||
git clone [INSERT_FRAMEWORK_REPO_URL_HERE] ~/.automaton
|
||||
|
||||
# Enter the directory
|
||||
cd ~/.agent-framework
|
||||
cd ~/.automaton
|
||||
|
||||
# Make the installation script executable and run it
|
||||
chmod +x install.sh
|
||||
@@ -26,7 +26,7 @@ chmod +x install.sh
|
||||
When the framework is updated, you can update your global installation:
|
||||
|
||||
```bash
|
||||
cd ~/.agent-framework
|
||||
cd ~/.automaton
|
||||
./update.sh
|
||||
```
|
||||
|
||||
@@ -50,14 +50,14 @@ If you want the agent to handle the configuration for you, navigate to your proj
|
||||
|
||||
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.
|
||||
2. Create the `./.automaton/` 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.
|
||||
If you prefer to set it up manually, create a `.automaton/` directory in your project root and add:
|
||||
- `.agent.md`: Project-specific configuration (Mode, rules, etc.).
|
||||
- `.rules.md`: Project-specific constraints and past failure modes.
|
||||
|
||||
---
|
||||
|
||||
@@ -84,7 +84,7 @@ The default mode is **Autopilot: Enabled**. The Orchestrator automatically drive
|
||||
- **Continue**: "orchestrate" or "continue" (the Orchestrator finds the most advanced task and drives it)
|
||||
|
||||
#### VRAM Configuration
|
||||
For low-VRAM systems (8GB, 16GB), set your VRAM limits in `~/.agent-framework/config.md`:
|
||||
For low-VRAM systems (8GB, 16GB), set your VRAM limits in `~/.automaton/config.md`:
|
||||
|
||||
```markdown
|
||||
## VRAM Configuration
|
||||
@@ -111,7 +111,7 @@ For low-VRAM systems (8GB, 16GB), set your VRAM limits in `~/.agent-framework/co
|
||||
```
|
||||
|
||||
#### Model Configuration
|
||||
When using a local LLM or a specific API model, set the model in `~/.agent-framework/config.md`:
|
||||
When using a local LLM or a specific API model, set the model in `~/.automaton/config.md`:
|
||||
|
||||
```markdown
|
||||
## Model Configuration
|
||||
@@ -140,7 +140,7 @@ When you run "Decompose the X task", the Orchestrator will:
|
||||
Sub-tasks run independently through the full lifecycle. The parent task is complete only when ALL sub-tasks pass.
|
||||
|
||||
#### Manual mode (opt-in)
|
||||
Set `Autopilot: Disabled` in your project's `.agent-framework/AGENT.md` if you prefer to manually run each phase. The Orchestrator reports the current state and tells you the next command. Then run phases by saying things like:
|
||||
Set `Autopilot: Disabled` in your project's `.automaton/.agent.md` if you prefer to manually run each phase. The Orchestrator reports the current state and tells you the next command. Then run phases by saying things like:
|
||||
- "Research add user authentication" — starts a new task
|
||||
- "Decompose the add-user-auth task" — breaks into VRAM-sized sub-tasks (optional)
|
||||
- "Design the add-user-auth task" — designs the architecture (optional)
|
||||
@@ -164,9 +164,9 @@ When a task is decomposed, the Orchestrator creates sub-tasks under `tasks/{pare
|
||||
- The parent task is NOT complete until ALL sub-tasks pass
|
||||
|
||||
## Key Components
|
||||
- `AGENT.md`: Project-specific agent behavior (Autopilot mode, routing rules).
|
||||
- `.agent.md`: Project-specific agent behavior (Autopilot mode, routing rules).
|
||||
- `config.md`: Global framework settings (VRAM, model, system requirements).
|
||||
- `RULES.md`: Living document of project constraints and past failure modes.
|
||||
- `.rules.md`: Living document of project constraints and past failure modes.
|
||||
- `prompts/`: Specialized system prompts for each phase (Research, Design, Test Design, Implement, Bug Finder, Adversarial Bug Finder, Doc Review, Referee, Decompose, etc.).
|
||||
- `workflow.md`: The state machine governing the Autopilot lifecycle.
|
||||
- `test_design.md`: Produces a TEST_PLAN.md — an explicit test specification before implementation.
|
||||
@@ -178,15 +178,15 @@ When a task is decomposed, the Orchestrator creates sub-tasks under `tasks/{pare
|
||||
|
||||
The framework uses a **layered approach** to file management, with a clear precedence:
|
||||
|
||||
1. **Project overrides** (highest precedence): `{project}/.agent-framework/` — contains project-specific customizations
|
||||
2. **Global framework** (default): `~/.agent-framework/` — contains the base framework files
|
||||
1. **Project overrides** (highest precedence): `{project}/.automaton/` — contains project-specific customizations
|
||||
2. **Global framework** (default): `~/.automaton/` — contains the base framework files
|
||||
|
||||
**Precedence rule**: If a file exists in the project's `.agent-framework/` directory, the Orchestrator reads it from there. If it doesn't exist, the Orchestrator reads it from the global `~/.agent-framework/` directory.
|
||||
**Precedence rule**: If a file exists in the project's `.automaton/` directory, the Orchestrator reads it from there. If it doesn't exist, the Orchestrator reads it from the global `~/.automaton/` directory.
|
||||
|
||||
### What files belong in each layer?
|
||||
|
||||
- **Project's `.agent-framework/`**: AGENT.md (project-specific settings like Autopilot mode, rules override), RULES.md (project-specific constraints)
|
||||
- **Global `~/.agent-framework/`**: All prompt files, contracts, scripts, config.md, workflow.md
|
||||
- **Project's `.automaton/`**: .agent.md (project-specific settings like Autopilot mode, rules override), .rules.md (project-specific constraints)
|
||||
- **Global `~/.automaton/`**: All prompt files, contracts, scripts, config.md, workflow.md
|
||||
|
||||
### Upgrading
|
||||
|
||||
@@ -195,7 +195,7 @@ When you upgrade the global framework (e.g., after pushing bug fixes), existing
|
||||
> "Upgrade the agent-framework for this project."
|
||||
|
||||
The agent will:
|
||||
1. Compare the project's `.agent-framework/` files with the global `~/.agent-framework/` files
|
||||
1. Compare the project's `.automaton/` files with the global `~/.automaton/` files
|
||||
2. **Customized files** — If the project has customized a file (differs from global), **keep the project's version**
|
||||
3. **Outdated files** — If the project's file is identical to the old global version, **update from global**
|
||||
4. **New files** — If the global framework has new files, **add them to the project**
|
||||
|
||||
Reference in New Issue
Block a user