Repo-aware directive generator that personalizes strategic analysis to your working style
Project description
OpenAgent
I built this to replace the need for a more expensive AI ChatBot as my Directive Writer for my IDE Coding Agent. It nearly works using OpenRouter.
OpenAgent reads your codebase and generates strategic recommendations shaped to your architectural preferences and development style.
Quick Start
# Install
pip install openagent
# First time setup - personalize your experience
openagent init
# Generate personalized strategic analysis
openagent analyze
# Check repository structure
openagent inventory
What It Does
OpenAgent is a repo-aware directive generator that:
- Reads your actual codebase - understands your files, structure, and patterns
- Personalizes recommendations - uses your SOUL.md profile to shape advice to your style
- Generates strategic directives - creates actionable improvement plans
- Advises, doesn't execute - you maintain full control over all decisions
Who It's For
Developers who want to understand their codebase better:
- Solo developers working on complex projects
- Teams needing architectural guidance
- Developers transitioning between projects
- Anyone wanting strategic improvement recommendations
How It Works
1. Personalize Your Experience
openagent init
- 8-question interview captures your working style
- Creates SOUL.md with your preferences
- Shapes all future directive generation
2. Get Strategic Analysis
openagent analyze
- Analyzes your repository structure
- Considers your SOUL.md preferences
- Generates personalized recommendations
3. Take Action
OpenAgent provides clear, actionable directives. You decide what to implement.
Key Features
- Repo-aware analysis - Understands your actual code structure
- Personalized recommendations - Shaped to your working style
- Strategic guidance - Focuses on what matters most for your project
- Advisory mode only - Never executes code, always advises
- CLI-driven - Simple command-line interface
Installation
# Install with pip
pip install openagent
# Or with uv
uv add openagent
Usage Examples
Basic Analysis
# Analyze current repository
openagent analyze
# Check repository structure
openagent inventory
# See system health
openagent health
Personalized Workflow
# Setup your profile
openagent init
# Get personalized advice
openagent analyze --context "Preparing for v2.0 release"
# Monitor costs
openagent costs
What OpenAgent Analyzes
- Repository Structure: File organization, architecture patterns
- Code Quality: Maintainability, complexity, technical debt
- Documentation: Completeness, consistency, alignment
- Dependencies: Security, versions, conflicts
- Test Coverage: Gaps, organization, quality metrics
- Strategic Opportunities: Missing components, improvements
Architecture
Built with:
- Google ADK for LLM orchestration
- Multi-Agent System for specialized analysis
- Personalization Engine via SOUL.md integration
- Rich CLI for developer experience
Development Status
See docs/state/current.md for current implementation status.
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests for new functionality
- Ensure all tests pass
- Submit a pull request
License
MIT License - see LICENSE file for details.
Support
- Documentation: docs/ directory
- Issues: GitHub Issues
- Discussions: GitHub Discussions MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openagent_directive-0.2.2.tar.gz.
File metadata
- Download URL: openagent_directive-0.2.2.tar.gz
- Upload date:
- Size: 364.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b59aa28120dcd5543d697dc46879b95aa233ffb9f213fe2977bde9bad202c75d
|
|
| MD5 |
d31dc8b4939912c8760e231cc3fb2a82
|
|
| BLAKE2b-256 |
0fe2fb20641fec57daa245d9da49b26c606e340aeeae153ec7427505ff65d5a9
|
File details
Details for the file openagent_directive-0.2.2-py3-none-any.whl.
File metadata
- Download URL: openagent_directive-0.2.2-py3-none-any.whl
- Upload date:
- Size: 129.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2af2c6d1f525fdc88548243719867019e730268df1bdd070a8dc67d2b1a1aff
|
|
| MD5 |
7bfc8d66805f2e424abbb482c6e8ca47
|
|
| BLAKE2b-256 |
e93202f677d27b19d12fc2081217935693b0f5542769680222e090ef056223bf
|