Files
kaizen-agentic/docs/CLI_CHEAT_SHEET.md
tegwick 38965c1d4a Implement hybrid agent distribution system
Complete implementation of the agent distribution framework including:

CORE INFRASTRUCTURE:
- AgentRegistry: Agent discovery, categorization, and dependency management
- AgentInstaller: Agent installation, updates, and removal with safety measures
- ProjectInitializer: Template-based project initialization with agent integration
- CLI Tool: Comprehensive kaizen-agentic command-line interface

DISTRIBUTION FEATURES:
- Python package distribution with console script entry point
- Agent categorization (project-management, development-process, code-quality, etc.)
- Project templates (python-basic, python-web, python-cli, python-data, comprehensive)
- Dependency resolution and validation
- Idempotent operations with backup and rollback support

CLI COMMANDS:
- kaizen-agentic init: Initialize new projects with agents
- kaizen-agentic install/update/remove: Manage agents in existing projects
- kaizen-agentic list/status/validate: Discovery and maintenance
- kaizen-agentic templates: Project template management

INTEGRATION & DOCUMENTATION:
- Makefile targets for agent management (list-agents, update-agents, etc.)
- Automatic Claude Code configuration updates (CLAUDE.md)
- Comprehensive documentation (GETTING_STARTED, AGENT_DISTRIBUTION, CLI_CHEAT_SHEET)
- Multi-language build system integration examples
- Complete test coverage for all components

PACKAGE STRUCTURE:
- Console script: kaizen-agentic command available globally
- Package data: All agents included for distribution
- Dependencies: click, pyyaml for CLI and parsing
- Testing: Comprehensive test suite for registry and installer

This enables sharing specialized AI agents across projects with easy installation,
updates, and management through both CLI and integrated Makefile targets.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-19 02:31:15 +02:00

197 lines
4.8 KiB
Markdown

# Kaizen Agentic CLI Cheat Sheet
Quick reference for the `kaizen-agentic` command-line tool.
## Installation
```bash
pip install kaizen-agentic
```
## Core Commands
### Project Initialization
```bash
# New project with default template
kaizen-agentic init my-project
# New project with specific template
kaizen-agentic init web-app --template python-web
# New project with custom agents
kaizen-agentic init cli-tool --agents todo-keeper,tdd-workflow,claude-documentation
# Initialize in specific directory
kaizen-agentic init my-project --parent-dir ~/projects
```
### Agent Management
```bash
# List available agents
kaizen-agentic list
kaizen-agentic list --category project-management
kaizen-agentic list --verbose
# Install agents
kaizen-agentic install todo-keeper changelog-keeper
kaizen-agentic install tdd-workflow --target ~/my-project
kaizen-agentic install code-refactoring --no-backup --no-docs
# Update agents
kaizen-agentic update # Update all installed
kaizen-agentic update todo-keeper # Update specific agents
# Remove agents
kaizen-agentic remove old-agent-name
# Project status
kaizen-agentic status # Show current project status
kaizen-agentic validate # Validate agent installation
```
### Information
```bash
# List templates
kaizen-agentic templates
# Show help
kaizen-agentic --help
kaizen-agentic install --help # Command-specific help
# Version
kaizen-agentic --version
```
## Common Workflows
### Setting Up New Python Web Project
```bash
kaizen-agentic init my-web-app --template python-web
cd my-web-app
make setup-complete
make test
```
### Adding Agents to Existing Project
```bash
cd existing-project
kaizen-agentic install todo-keeper changelog-keeper
kaizen-agentic status
```
### Maintaining Agents
```bash
# Weekly maintenance
kaizen-agentic update
kaizen-agentic validate
# Check what's installed
kaizen-agentic status
```
### Team Onboarding
```bash
git clone team-repo
cd team-repo
pip install kaizen-agentic
kaizen-agentic status # See what agents are used
cat CLAUDE.md # Read agent documentation
```
## Agent Categories
| Category | Example Agents | Use Cases |
|----------|----------------|-----------|
| `project-management` | todo-keeper, changelog-keeper | Task tracking, documentation |
| `development-process` | tdd-workflow, requirements-engineering | Development methodology |
| `code-quality` | code-refactoring, datamodel-optimization | Code improvement |
| `infrastructure` | setup-repository, testing-efficiency | Project setup, tooling |
| `testing` | test-maintenance, tdd-workflow | Test management |
| `documentation` | claude-documentation, contributing-keeper | Documentation management |
## Templates
| Template | Agents Included | Best For |
|----------|----------------|----------|
| `python-basic` | setup-repository, todo-keeper, changelog-keeper | Simple Python projects |
| `python-web` | Basic + tdd-workflow, code-refactoring, contributing-keeper | Web applications |
| `python-cli` | Basic + testing-efficiency, claude-documentation | Command-line tools |
| `python-data` | Basic + datamodel-optimization, requirements-engineering | Data science |
| `comprehensive` | All available agents | Complex projects |
## Integration Commands
### Without Makefile
```bash
# Direct CLI usage when Makefile targets aren't available
kaizen-agentic status # Instead of: make list-agents
kaizen-agentic update # Instead of: make update-agents
kaizen-agentic validate # Instead of: make validate-agents
```
### With Build Tools
**npm/package.json:**
```json
{
"scripts": {
"agents:status": "kaizen-agentic status",
"agents:update": "kaizen-agentic update"
}
}
```
**Make targets (auto-added):**
```bash
make list-agents # List installed agents
make update-agents # Update agents
make validate-agents # Validate agents
make agent-status # Show detailed status
```
## Troubleshooting
### Common Issues
```bash
# Command not found
pip install kaizen-agentic
# No agents directory
kaizen-agentic install todo-keeper
# Validation errors
kaizen-agentic validate
kaizen-agentic remove problematic-agent
kaizen-agentic install problematic-agent
```
### Getting Help
```bash
kaizen-agentic --help # General help
kaizen-agentic COMMAND --help # Command help
kaizen-agentic status # Check current state
kaizen-agentic validate # Validate setup
```
## Quick Examples
**Start a data science project:**
```bash
kaizen-agentic init ml-project --template python-data
cd ml-project && make setup-complete
```
**Add testing workflow to existing project:**
```bash
kaizen-agentic install tdd-workflow testing-efficiency
```
**Update all agents monthly:**
```bash
kaizen-agentic update && kaizen-agentic validate
```
**Check what agents a project uses:**
```bash
kaizen-agentic status
cat CLAUDE.md # Detailed info
```