Skip to content

Commit 7c8e3ff

Browse files
Improve Codelayer README documentation
Transform the Codelayer README from a basic technical summary to comprehensive, professional documentation that better serves first-time users. The rewrite includes: - Clean, professional structure with table of contents - Detailed explanation of Codelayer's purpose and philosophy - Connection to HumanLayer's human-in-the-loop approach - Comprehensive usage examples and workflows - Professional agent descriptions and contributing guidelines Follows the style and tone of HumanLayer's documentation to maintain consistency and readability. 🤖 Generated with Codebuff Co-Authored-By: Codebuff <noreply@codebuff.com>
1 parent 2d2cf7e commit 7c8e3ff

1 file changed

Lines changed: 129 additions & 20 deletions

File tree

.agents/codelayer/README.md

Lines changed: 129 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,145 @@
1-
# Codelayer Agent Collection
1+
# Codelayer
22

3-
This folder contains the Codelayer collection of specialized agents. Each agent in this collection is designed to work together as part of a cohesive system.
3+
Codelayer is a collection of specialized AI agents designed to enhance software development workflows through intelligent codebase analysis, research, and navigation. Built with inspiration from [HumanLayer](https://github.com/humanlayer/humanlayer)'s human-in-the-loop philosophy, Codelayer provides targeted assistance for understanding and working with complex codebases.
44

5-
## Agents
5+
## Table of contents
66

7-
- `codelayer-base.ts` - The foundational agent for the Codelayer collection
8-
- `codebase-analyzer.ts` - Analyzes codebase implementation details
9-
- `codebase-locator.ts` - Locates files and directories relevant to features
10-
- `codebase-pattern-finder.ts` - Finds similar implementations and usage patterns
11-
- `thoughts-analyzer.ts` - Analyzes thoughts documents for insights
12-
- `thoughts-locator.ts` - Discovers relevant documents in thoughts/ directory
13-
- `web-search-researcher.ts` - Comprehensive web research specialist
7+
- [Getting Started](#getting-started)
8+
- [Why Codelayer?](#why-codelayer)
9+
- [Available Agents](#available-agents)
10+
- [Usage Examples](#usage-examples)
11+
- [Advanced Usage](#advanced-usage)
12+
- [Contributing](#contributing)
1413

1514
## Getting Started
1615

17-
To use any Codelayer agent:
18-
1916
```bash
17+
# Start with the base coordinator agent
2018
codebuff --agent codelayer-base
19+
20+
# Or use a specialized agent directly
21+
codebuff --agent codebase-locator
22+
codebuff --agent codebase-analyzer
23+
```
24+
25+
## Why Codelayer?
26+
27+
Modern software development involves navigating increasingly complex codebases with intricate dependencies, patterns, and architectures. While generic AI assistants can provide general programming help, they often lack the specialized focus needed for deep codebase understanding.
28+
29+
Codelayer addresses this by providing a suite of specialized agents, each optimized for specific development tasks:
30+
31+
- **Codebase Navigation**: Rapidly locate files, components, and implementations across large projects
32+
- **Architecture Analysis**: Understand data flow, execution paths, and system interactions
33+
- **Pattern Discovery**: Find similar implementations and usage examples within your codebase
34+
- **Research Integration**: Combine internal documentation with external best practices
35+
36+
### Connection to HumanLayer
37+
38+
Like [HumanLayer](https://github.com/humanlayer/humanlayer), Codelayer emphasizes **human-in-the-loop workflows**. Rather than making autonomous changes, these agents focus on providing comprehensive analysis and insights that enhance human decision-making. This approach ensures:
39+
40+
- **Transparency**: Clear explanations of findings and methodologies
41+
- **Verification**: Human oversight of all recommendations and analysis
42+
- **Augmentation**: Tools that enhance rather than replace developer expertise
43+
- **Safety**: No automated modifications without explicit human approval
44+
45+
## Available Agents
46+
47+
### `codelayer-base`
48+
Central coordinator that routes requests to appropriate specialized agents based on task requirements.
49+
50+
### `codebase-locator`
51+
Locates files, directories, and components using natural language queries. Equivalent to an intelligent search tool that understands development context.
52+
53+
### `codebase-analyzer`
54+
Provides detailed analysis of implementations, including execution flow, data transformations, and architectural patterns.
55+
56+
### `codebase-pattern-finder`
57+
Identifies similar implementations and usage patterns within the codebase, useful for maintaining consistency and understanding conventions.
58+
59+
### `thoughts-locator`
60+
Searches project documentation, notes, and thoughts directories for relevant context and historical decisions.
61+
62+
### `thoughts-analyzer`
63+
Extracts insights from documentation and notes, focusing on architectural decisions and implementation constraints.
64+
65+
### `web-search-researcher`
66+
Conducts comprehensive web research for best practices, documentation, and current industry approaches relevant to development tasks.
67+
68+
## Usage Examples
69+
70+
### Codebase Navigation
71+
```bash
72+
codebuff --agent codebase-locator
73+
# Query: "Find all files related to user authentication"
74+
```
75+
76+
### Implementation Analysis
77+
```bash
78+
codebuff --agent codebase-analyzer
79+
# Query: "How does the webhook processing system work?"
80+
```
81+
82+
### Pattern Research
83+
```bash
84+
codebuff --agent codebase-pattern-finder
85+
# Query: "Show me how error handling is implemented across the codebase"
86+
```
87+
88+
### External Research
89+
```bash
90+
codebuff --agent web-search-researcher
91+
# Query: "Best practices for API rate limiting in Node.js applications"
2192
```
2293

23-
## Purpose
94+
## Advanced Usage
95+
96+
### Sequential Agent Workflows
97+
98+
For complex analysis tasks, agents can be chained together:
2499

25-
The Codelayer collection is designed to provide specialized functionality for comprehensive codebase analysis, research, and development support. The agents work together to provide deep insights into code structure, patterns, and documentation.
100+
```bash
101+
# 1. Locate relevant files
102+
codebuff --agent codebase-locator
103+
"Find authentication middleware files"
104+
105+
# 2. Analyze implementation details
106+
codebuff --agent codebase-analyzer
107+
"Analyze JWT token validation in auth/middleware.js"
26108

27-
## Adding New Agents
109+
# 3. Research best practices
110+
codebuff --agent web-search-researcher
111+
"Current JWT security best practices 2024"
112+
```
28113

29-
When adding new agents to this collection:
114+
### Coordinated Analysis
30115

31-
1. Use the publisher: `codelayer`
116+
The base agent can coordinate multiple specialized agents for comprehensive analysis:
117+
118+
```bash
119+
codebuff --agent codelayer-base
120+
"Provide a complete analysis of the payment processing system, including implementation details, test coverage, and current best practices"
121+
```
122+
123+
## Contributing
124+
125+
Contributions to Codelayer are welcome. When adding new agents:
126+
127+
### Guidelines
128+
129+
1. Use the `codelayer` publisher namespace
32130
2. Import shared types from `../types/agent-definition`
33-
3. Update this README with the new agent
34-
4. Follow established naming conventions
131+
3. Follow established naming conventions
132+
4. Update this README with agent descriptions
133+
5. Focus on specialized functionality rather than general-purpose capabilities
134+
135+
### Design Principles
136+
137+
- **Specialization**: Each agent should excel at a specific domain
138+
- **Transparency**: Provide clear explanations of analysis methods
139+
- **Consistency**: Maintain structured, predictable output formats
140+
- **Collaboration**: Design agents to work effectively together
141+
- **Human-centric**: Augment rather than replace human decision-making
142+
143+
## License
35144

36-
Each agent should have a clear, specific purpose within the Codelayer ecosystem.
145+
Codelayer agents are part of the Codebuff project and follow the same licensing terms.

0 commit comments

Comments
 (0)