tegwick
b257b3c906
- Add make install-global target with intelligent installation methods - Support pipx (recommended), pip --user, and fallback options - Resolve issue where kaizen-agentic was only available in local venv - Update documentation to clearly explain 4 installation options: - Development mode (local venv) - Global installation (any directory) - Local package testing (local venv) - Future PyPI installation - CLI now available globally from any directory after make install-global Fixes the core issue where users couldn't access kaizen-agentic from other repos. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
118 lines
3.8 KiB
Markdown
118 lines
3.8 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 # Required for each session
|
|
```
|
|
|
|
**Global Installation (Available from any directory):**
|
|
```bash
|
|
git clone https://github.com/kaizen-agentic/kaizen-agentic.git
|
|
cd kaizen-agentic
|
|
make setup-complete
|
|
python3 -m build && make install-global
|
|
# No virtual environment activation needed
|
|
```
|
|
|
|
**Local Package Testing:**
|
|
```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 # Required for each session
|
|
```
|
|
|
|
**From PyPI (Coming Soon):**
|
|
```bash
|
|
pip install kaizen-agentic # Available after v1.0.0 publication
|
|
# or
|
|
pipx install kaizen-agentic # Recommended for global CLI tools
|
|
```
|
|
|
|
### 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
|
|
``` |