tegwick
63dacda163
- Add Option B: From Local Package installation instructions - Include make install-local target in both README.md and GETTING_STARTED.md - Provide clear path for testing PyPI-equivalent installation locally - Maintains development, local package, and future PyPI installation options 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
107 lines
3.5 KiB
Markdown
107 lines
3.5 KiB
Markdown
# Kaizen Agentic
|
|
|
|
AI agent development framework embracing continuous improvement through specialized agents and comprehensive development workflows.
|
|
|
|
This project embraces the Japanese concept of "kaizen" (continuous improvement) applied to AI agent development. Every coding subagent becomes part of an optimization loop where performance is measured, patterns are analyzed, and specifications are refined over time.
|
|
|
|
## Quick Start
|
|
|
|
### Install the Package
|
|
|
|
**From Source (Development):**
|
|
```bash
|
|
git clone https://github.com/kaizen-agentic/kaizen-agentic.git
|
|
cd kaizen-agentic
|
|
make setup-complete
|
|
make agents-install-cli
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
**From Local Package (Test Installation):**
|
|
```bash
|
|
git clone https://github.com/kaizen-agentic/kaizen-agentic.git
|
|
cd kaizen-agentic
|
|
make setup-complete
|
|
python3 -m build && make install-local
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
**From PyPI (Coming Soon):**
|
|
```bash
|
|
pip install kaizen-agentic # Available after v1.0.0 publication
|
|
```
|
|
|
|
### Your First Project (New Users)
|
|
**👋 New to Kaizen Agentic?** Follow our [Hello World Tutorial](docs/HELLO_WORLD_TUTORIAL.md) for a complete step-by-step guide.
|
|
|
|
### Create a Project (Experienced Users)
|
|
```bash
|
|
# Create a new project with AI agents
|
|
kaizen-agentic init my-project --template python-web
|
|
cd my-project
|
|
|
|
# Set up development environment
|
|
make setup-complete
|
|
|
|
# Start coding with agent assistance!
|
|
make help # See all available commands
|
|
```
|
|
|
|
### Add Agents to Existing Project
|
|
```bash
|
|
# Navigate to your project
|
|
cd your-existing-project
|
|
|
|
# Install relevant agents
|
|
kaizen-agentic install keepaTodofile keepaChangelog tdd-workflow
|
|
|
|
# Check what was installed
|
|
kaizen-agentic status
|
|
```
|
|
|
|
## Features
|
|
|
|
- **16+ Specialized Agents**: Project management, testing, code quality, documentation
|
|
- **CLI Tool**: Easy agent installation and management (`kaizen-agentic`)
|
|
- **Project Templates**: Pre-configured setups for different project types
|
|
- **Claude Code Integration**: Seamless integration with Claude Code workflows
|
|
- **Comprehensive Testing**: Full test coverage with multiple testing strategies
|
|
- **Standards Compliance**: Follows PythonVibes and industry best practices
|
|
|
|
## Available Agents
|
|
|
|
### Project Management
|
|
- **keepaTodofile**: Manages TODO.md files following Keep a Todofile format
|
|
- **keepaChangelog**: Maintains CHANGELOG.md files following Keep a Changelog format
|
|
- **keepaContributingfile**: Creates and updates CONTRIBUTING.md files
|
|
- **project-management**: General project management and coordination
|
|
|
|
### Development Process
|
|
- **tdd-workflow**: Test-driven development workflow guidance
|
|
- **requirements-engineering**: Requirements analysis and documentation
|
|
- **test-maintenance**: Test suite maintenance and optimization
|
|
|
|
### Code Quality
|
|
- **code-refactoring**: Code improvement and refactoring guidance
|
|
- **optimization**: Agent definition optimization and improvement
|
|
- **datamodel-optimization**: Data model design and optimization
|
|
|
|
### Infrastructure
|
|
- **setupRepository**: Repository initialization and standards compliance
|
|
- **claude-documentation**: Claude Code configuration and documentation
|
|
- **tooling-optimization**: Repository tooling usage optimization
|
|
|
|
[View complete agent list](docs/AGENT_DISTRIBUTION.md#agent-categories)
|
|
|
|
## Project Templates
|
|
|
|
```bash
|
|
# Available templates
|
|
kaizen-agentic templates
|
|
|
|
# python-basic: Basic Python project setup
|
|
# python-web: Web application development
|
|
# python-cli: Command-line tool development
|
|
# python-data: Data science and analysis
|
|
# comprehensive: All available agents
|
|
``` |