Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 843cf4eee0 | |||
| 7058859e5c | |||
| eeb4eee5ef | |||
| 3b2edd4a9e | |||
| 2400ff4890 | |||
| df899abd98 | |||
| b1fceeebc8 | |||
| fe795ca750 | |||
| 1d0999eabb | |||
| 297afed823 | |||
| 11a35d18d8 | |||
| 1522f12130 | |||
| 1c0c9accd9 | |||
| cb068cc2b5 | |||
| 47b743a074 | |||
| 9d2bab9a38 | |||
| 5ce3d0766e | |||
| e0e02e261d | |||
| 4daf8635d1 | |||
| 2a03eed012 | |||
| c004c3d4d7 | |||
| 4a7f5b2b7d | |||
| d7a8357dbf | |||
| c9a3a77fdf |
@@ -17,7 +17,7 @@ Packaged copies live in `src/kaizen_agentic/data/agents/` for `pip install` dist
|
||||
|----------|--------|
|
||||
| Testing | `tdd-workflow`, `test-maintenance`, `testing-efficiency` |
|
||||
| Quality | `code-refactoring`, `datamodel-optimization` |
|
||||
| Process | `requirements-engineering`, `keepaTodofile`, `keepaChangelog`, `keepaContributingfile`, `project-management`, `priority-evaluation`, `scope-analyst` |
|
||||
| Process | `requirements-engineering`, `keepaTodofile`, `keepaChangelog`, `keepaContributingfile`, `project-assistant`, `priority-evaluation`, `scope-analyst` |
|
||||
| Infrastructure | `setupRepository`, `tooling-optimization`, `sys-medic` |
|
||||
| Release | `releaseManager` |
|
||||
| Docs | `claude-documentation` |
|
||||
|
||||
18
.custodian-brief.md
Normal file
18
.custodian-brief.md
Normal file
@@ -0,0 +1,18 @@
|
||||
<!-- custodian-brief: generated by fix-consistency — do not edit manually -->
|
||||
# Custodian Brief — kaizen-agentic
|
||||
|
||||
**Domain:** custodian
|
||||
**Last synced:** 2026-06-16 23:04 UTC
|
||||
**State Hub:** http://127.0.0.1:8000 *(adjust if running on a remote machine)*
|
||||
|
||||
## Active Workstreams
|
||||
|
||||
*(none — repo may need first-session setup)*
|
||||
|
||||
---
|
||||
## MCP Orientation (when available)
|
||||
|
||||
If the state-hub MCP server is reachable, call:
|
||||
`get_domain_summary("custodian")`
|
||||
This provides richer cross-domain context.
|
||||
If the MCP call fails, use this file as your orientation source.
|
||||
@@ -8,24 +8,31 @@ on:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.10", "3.12"]
|
||||
runs-on: haskelseed
|
||||
steps:
|
||||
- name: Check out source
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
env:
|
||||
PACKAGE_TOKEN: ${{ secrets.PACKAGE_TOKEN }}
|
||||
run: |
|
||||
git clone --depth 1 \
|
||||
"https://tegwick:${PACKAGE_TOKEN}@gitea.coulomb.social/coulomb/kaizen-agentic.git" \
|
||||
repo
|
||||
cd repo
|
||||
git checkout "${{ gitea.sha }}"
|
||||
|
||||
- name: Install package and dev tools
|
||||
run: python -m pip install --upgrade pip && python -m pip install -e ".[dev]"
|
||||
run: |
|
||||
cd repo
|
||||
python3 -m ensurepip --upgrade 2>/dev/null || \
|
||||
curl -sS https://bootstrap.pypa.io/get-pip.py -o /tmp/get-pip.py && python3 /tmp/get-pip.py
|
||||
python3 -m pip install --upgrade pip
|
||||
python3 -m pip install -e ".[dev]"
|
||||
|
||||
- name: Format check (black)
|
||||
run: black --check src tests
|
||||
run: cd repo && black --check src tests
|
||||
|
||||
- name: Lint (flake8)
|
||||
run: cd repo && flake8 src/ --max-line-length=100
|
||||
|
||||
- name: Run tests
|
||||
run: pytest tests/ -q --ignore=tests/test_cli_error_handling.py
|
||||
run: cd repo && pytest tests/ -q --ignore=tests/test_cli_error_handling.py
|
||||
|
||||
41
.gitea/workflows/publish-python-package.yml
Normal file
41
.gitea/workflows/publish-python-package.yml
Normal file
@@ -0,0 +1,41 @@
|
||||
name: Publish Python package
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: haskelseed
|
||||
steps:
|
||||
- name: Check out source
|
||||
env:
|
||||
PACKAGE_USER: ${{ secrets.PACKAGE_USER }}
|
||||
PACKAGE_TOKEN: ${{ secrets.PACKAGE_TOKEN }}
|
||||
run: |
|
||||
git clone --depth 1 \
|
||||
"https://${PACKAGE_USER}:${PACKAGE_TOKEN}@gitea.coulomb.social/coulomb/kaizen-agentic.git" \
|
||||
repo
|
||||
cd repo
|
||||
git checkout "${{ gitea.sha }}"
|
||||
|
||||
- name: Build and publish
|
||||
env:
|
||||
TWINE_USERNAME: ${{ secrets.PACKAGE_USER }}
|
||||
TWINE_PASSWORD: ${{ secrets.PACKAGE_TOKEN }}
|
||||
PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring
|
||||
run: |
|
||||
cd repo
|
||||
python3 -m venv .build-venv
|
||||
. .build-venv/bin/activate
|
||||
python -m pip install --upgrade pip build twine
|
||||
python -m build
|
||||
python -m twine check dist/*
|
||||
python -m twine upload \
|
||||
--username "${TWINE_USERNAME}" \
|
||||
--password "${TWINE_PASSWORD}" \
|
||||
--non-interactive \
|
||||
--repository-url https://gitea.coulomb.social/api/packages/coulomb/pypi \
|
||||
dist/*
|
||||
55
CHANGELOG.md
55
CHANGELOG.md
@@ -7,6 +7,61 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [1.4.0] - 2026-06-18
|
||||
|
||||
### Added
|
||||
- **Agent authoring & doc generation (WP-0007)** — `kaizen-agentic create-agent`
|
||||
scaffolds a schema-valid agent; `kaizen-agentic docs generate [--check]`
|
||||
refreshes the CLAUDE.md `## Installed Agents` section idempotently
|
||||
- **Frontmatter schema validation** — `kaizen-agentic validate` now enforces
|
||||
required `name`/`description`/`category`, a known category, and valid
|
||||
`memory`/`model` values with actionable errors
|
||||
|
||||
### Fixed
|
||||
- **Idempotent doc regeneration** — `_update_documentation` no longer duplicates
|
||||
the `## Installed Agents` block on each run (regex stopped at the first `###`
|
||||
subheading); rendering is now a shared, idempotent helper
|
||||
- **Declared category honoured** — agent frontmatter `category` is authoritative
|
||||
when valid (name/content heuristic is fallback only)
|
||||
- **Installed-agent resolution** — `list_installed_agents` reads the frontmatter
|
||||
name, so agents whose filename differs from their name resolve correctly
|
||||
|
||||
### Changed
|
||||
- **Renamed `agent-project-management.md` → `agent-project-assistant.md`** to
|
||||
satisfy the `agent-<name>.md` convention (frontmatter `name: project-assistant`);
|
||||
eliminates a registry name/filename collision
|
||||
|
||||
## [1.3.0] - 2026-06-17
|
||||
|
||||
### Added
|
||||
- **Scheduled agent execution (WP-0006, ADR-005)** — run agents on a cadence
|
||||
against a preselected repo roster, orchestrated by activity-core and prepared
|
||||
by kaizen-agentic (no Temporal workers or LLM runtime in this repo)
|
||||
- **`kaizen-agentic schedule`** CLI group — `init`, `validate`, `list`,
|
||||
`prepare <agent>` (markdown/json) over `.kaizen/schedule.yml`
|
||||
- **`.kaizen/schedule.yml`** manifest + schema docs and example
|
||||
(`docs/integrations/schedule-schema.md`, `docs/examples/.kaizen/schedule.yml`)
|
||||
- **ActivityDefinition drafts** (`enabled: false`) — `weekly-coach-orientation`,
|
||||
`weekly-optimization-review`
|
||||
- **Design specs** — `discover_kaizen_scheduled_repos` resolver, State Hub
|
||||
roster fields, `kaizen.schedule.prepared` event payload, activity-core handoff
|
||||
checklist
|
||||
|
||||
## [1.2.0] - 2026-06-16
|
||||
|
||||
### Added
|
||||
- **`make agents-sync-package`** — sync `agents/` into packaged `data/agents/`
|
||||
- **Packaged agent parity test** — `release-check` fails when wheel data drifts from source
|
||||
- **Gitea CI flake8** — lint gate on `src/` in `.gitea/workflows/ci.yml`
|
||||
|
||||
### Changed
|
||||
- **Install documentation** — HELLO_WORLD, CLI_CHEAT_SHEET, AGENT_DISTRIBUTION use Gitea PyPI extra index
|
||||
- **`docs/PACKAGE_RELEASE.md`** — OpenBao token custody, publish smoke-test notes, pre-tag checklist
|
||||
|
||||
### Fixed
|
||||
- **Gitea publish workflow** — `.build-venv` for PEP 668 on haskelseed; explicit twine credentials; `tegwick` + `inter-hub-pkg-rep` token from OpenBao
|
||||
- **Helix correlation docs** — bidirectional link with agentic-resources (WP-0005 T16)
|
||||
|
||||
## [1.1.0] - 2026-06-18
|
||||
|
||||
### Added
|
||||
|
||||
24
CLAUDE.md
24
CLAUDE.md
@@ -12,51 +12,45 @@
|
||||
|
||||
This project includes the following specialized agents:
|
||||
|
||||
### Testing
|
||||
|
||||
- **tdd-workflow**: Expert guidance for the TDD8 workflow methodology, specializing in the comprehensive ISSUE-TEST-RED-GREEN-REFACTOR-DOCUMENT-REFINE-PUBLISH cycle with sophisticated sidequest management and proper test organization.
|
||||
|
||||
Use these agents by referencing them in your Claude Code interactions.
|
||||
|
||||
### Documentation
|
||||
|
||||
- **claude-documentation**: Specialized assistant for Claude and Claude Code documentation, features, and best practices
|
||||
- **keepaContributingfile**: Specialized assistant for maintaining CONTRIBUTING.md files following Keep a Contributing-File V0.0.1 format within the Kaizen Agentic framework
|
||||
- **wisdom-encouragement**: Provides encouraging wisdom and guidance for complex implementation tasks and challenging technical work
|
||||
|
||||
### Meta
|
||||
|
||||
- **coach**: Coaching meta-agent that reads all agent memories in a project and synthesises cross-agent briefs and new-agent orientations
|
||||
- **optimization**: Meta-agent that analyzes and optimizes other Claude Code subagents based on their performance data, usage patterns, and effectiveness metrics. Use PROACTIVELY for agent ecosystem improvement.
|
||||
|
||||
### Code Quality
|
||||
|
||||
- **code-refactoring**: Analyze code structure and quality, identify improvement opportunities, and provide actionable refactoring guidance. Use PROACTIVELY for code quality assessment and improvement.
|
||||
- **datamodel-optimization**: Specialized agent that systematically analyzes, optimizes, and enhances dataclasses, models, and data structures within a codebase. Provides comprehensive datamodel improvements including convenience methods, interface consistency, code reduction, and test alignment.
|
||||
- **optimization**: Meta-agent that analyzes and optimizes other Claude Code subagents based on their performance data, usage patterns, and effectiveness metrics. Use PROACTIVELY for agent ecosystem improvement.
|
||||
- **tooling-optimization**: Meta-agent that analyzes and optimizes repository tooling usage to improve development efficiency
|
||||
|
||||
### Project Management
|
||||
|
||||
- **keepaChangelog**: Specialized assistant for maintaining CHANGELOG.md files following Keep a Changelog format
|
||||
- **keepaContributingfile**: Specialized assistant for maintaining CONTRIBUTING.md files following Keep a Contributing-File V0.0.1 format within the Kaizen Agentic framework
|
||||
- **keepaTodofile**: Specialized assistant for maintaining TODO.md files following Keep a Todofile V0.0.1 format
|
||||
- **priority-evaluation**: Specialized assistant to help evaluate and establish priorities for issues and tasks.
|
||||
- **project-assistant**: Specialized assistant for project status, progress tracking, and development planning
|
||||
- **releaseManager**: Manages software releases, version control, and publication workflows for Python packages
|
||||
- **scope-analyst**: Analyze a repository and produce/improve SCOPE.md for rapid orientation
|
||||
|
||||
### Development Process
|
||||
|
||||
- **priority-evaluation**: Specialized assistant to help evaluate and establish priorities for issues and tasks.
|
||||
- **releaseManager**: Manages software releases, version control, and publication workflows for Python packages
|
||||
- **requirements-engineering**: Specialized agent designed to prevent interface compatibility issues and mock object mismatches by ensuring solid foundation planning before implementation. Based on lessons learned from Issue
|
||||
- **scope-analyst**: Analyze a repository and produce/improve SCOPE.md for rapid orientation
|
||||
- **wisdom-encouragement**: Provides encouraging wisdom and guidance for complex implementation tasks and challenging technical work
|
||||
- **tdd-workflow**: Expert guidance for the TDD8 workflow methodology, specializing in the comprehensive ISSUE-TEST-RED-GREEN-REFACTOR-DOCUMENT-REFINE-PUBLISH cycle with sophisticated sidequest management and proper test organization.
|
||||
|
||||
### Infrastructure
|
||||
|
||||
- **setupRepository**: Specialized assistant for setting up new Python repositories following PythonVibes best practices
|
||||
- **sys-medic**: Linux/Kubernetes node health assessment agent — diagnoses process, memory, CPU, disk, network, and kubelet issues with safe, prioritized, evidence-driven guidance
|
||||
- **tooling-optimization**: Meta-agent that analyzes and optimizes repository tooling usage to improve development efficiency
|
||||
|
||||
### Testing
|
||||
|
||||
- **tdd-workflow**: Expert guidance for the TDD8 workflow methodology, specializing in the comprehensive ISSUE-TEST-RED-GREEN-REFACTOR-DOCUMENT-REFINE-PUBLISH cycle with sophisticated sidequest management and proper test organization.
|
||||
- **test-maintenance**: Specialized agent for analyzing and fixing failing tests in the project
|
||||
- **testing-efficiency**: Specialized agent designed to optimize TDD8 workflow test execution, resolve pytest reliability issues, and enhance overall testing efficiency for red-green iterations. Focuses on smart test selection, parallel execution, and agent integration patterns.
|
||||
|
||||
Use these agents by referencing them in your Claude Code interactions.
|
||||
|
||||
|
||||
@@ -32,6 +32,12 @@ pip install -e . # project venv
|
||||
pipx install -e . --force # global pipx install
|
||||
```
|
||||
|
||||
**Consumers (pip install from registry):** see [docs/PACKAGE_RELEASE.md](docs/PACKAGE_RELEASE.md)
|
||||
for Gitea PyPI credentials and `--extra-index-url` install paths.
|
||||
|
||||
**Maintainers (release):** `make agents-sync-package` before tagging when `agents/` changes;
|
||||
`make package-check` and the pre-tag checklist in `docs/PACKAGE_RELEASE.md`.
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Project Structure
|
||||
|
||||
90
Makefile
90
Makefile
@@ -1,11 +1,14 @@
|
||||
# Makefile for Kaizen Agentic development tasks
|
||||
|
||||
.PHONY: help setup-complete setup-structure setup-python setup-tools setup-docs setup-tests setup-verify ensure-project-structure install-dev install-local install-global standards-check standards-fix standards-test test test-all build clean lint format venv-status agents-list agents-update agents-validate agents-status agents-install-cli release-check release-prepare release-test release-publish release-finalize release-rollback
|
||||
.PHONY: help setup-complete setup-structure setup-python setup-tools setup-docs setup-tests setup-verify ensure-project-structure install-dev install-local install-global standards-check standards-fix standards-test test test-all build clean lint format venv-status agents-list agents-update agents-validate agents-status agents-sync-package agents-install-cli release-check release-prepare release-test release-publish publish-gitea package-check release-finalize release-rollback
|
||||
|
||||
# Variables
|
||||
VENV = .venv
|
||||
VENV_PYTHON = $(VENV)/bin/python
|
||||
VENV_PIP = $(VENV)/bin/pip
|
||||
GITEA_PACKAGE_OWNER ?= coulomb
|
||||
GITEA_PYPI_REPOSITORY_URL ?= https://gitea.coulomb.social/api/packages/$(GITEA_PACKAGE_OWNER)/pypi
|
||||
GITEA_PYPI_SIMPLE_URL ?= https://gitea.coulomb.social/api/packages/$(GITEA_PACKAGE_OWNER)/pypi/simple/
|
||||
|
||||
# Default target
|
||||
help:
|
||||
@@ -38,13 +41,16 @@ help:
|
||||
@echo " agents-update - Update agents to latest versions"
|
||||
@echo " agents-validate - Validate agent definitions"
|
||||
@echo " agents-status - Show agent status and project info"
|
||||
@echo " agents-sync-package - Sync agents/ into packaged data/agents/ (DRY_RUN=1 to preview)"
|
||||
@echo " agents-install-cli - Install kaizen-agentic CLI tool"
|
||||
@echo ""
|
||||
@echo "Release Management:"
|
||||
@echo " release-check - Validate release readiness (tests, linting, version consistency)"
|
||||
@echo " release-prepare - Prepare release (update versions, build packages)"
|
||||
@echo " package-check - Build and validate wheel/sdist with twine"
|
||||
@echo " publish-gitea - Publish dist/* to Coulomb Gitea PyPI registry"
|
||||
@echo " release-test - Test publication workflow using TestPyPI"
|
||||
@echo " release-publish - Publish to production PyPI"
|
||||
@echo " release-publish - Publish to production PyPI (pypi.org)"
|
||||
@echo " release-finalize - Post-release tasks (tags, GitHub release, documentation)"
|
||||
@echo " release-rollback - Emergency rollback procedures"
|
||||
@echo ""
|
||||
@@ -806,7 +812,9 @@ agents-update: $(VENV)/bin/activate
|
||||
@if command -v kaizen-agentic >/dev/null 2>&1; then \
|
||||
kaizen-agentic update; \
|
||||
else \
|
||||
echo "⚠️ kaizen-agentic CLI not found. Install with: pip install kaizen-agentic"; \
|
||||
echo "⚠️ kaizen-agentic CLI not found."; \
|
||||
echo " Dev install: make agents-install-cli (or pip install -e .)"; \
|
||||
echo " Registry: see docs/PACKAGE_RELEASE.md"; \
|
||||
fi
|
||||
|
||||
# Validate installed agents
|
||||
@@ -815,7 +823,9 @@ agents-validate:
|
||||
@if command -v kaizen-agentic >/dev/null 2>&1; then \
|
||||
kaizen-agentic validate; \
|
||||
else \
|
||||
echo "⚠️ kaizen-agentic CLI not found. Install with: pip install kaizen-agentic"; \
|
||||
echo "⚠️ kaizen-agentic CLI not found."; \
|
||||
echo " Dev install: make agents-install-cli (or pip install -e .)"; \
|
||||
echo " Registry: see docs/PACKAGE_RELEASE.md"; \
|
||||
fi
|
||||
|
||||
# Show agent status and project information
|
||||
@@ -824,7 +834,9 @@ agents-status:
|
||||
@if command -v kaizen-agentic >/dev/null 2>&1; then \
|
||||
kaizen-agentic status; \
|
||||
else \
|
||||
echo "⚠️ kaizen-agentic CLI not found. Install with: pip install kaizen-agentic"; \
|
||||
echo "⚠️ kaizen-agentic CLI not found."; \
|
||||
echo " Dev install: make agents-install-cli (or pip install -e .)"; \
|
||||
echo " Registry: see docs/PACKAGE_RELEASE.md"; \
|
||||
echo ""; \
|
||||
echo "Manual agent check:"; \
|
||||
if [ -d "agents" ]; then \
|
||||
@@ -834,6 +846,34 @@ agents-status:
|
||||
fi; \
|
||||
fi
|
||||
|
||||
# Sync canonical agents/ into packaged wheel data
|
||||
AGENTS_SRC_DIR = agents
|
||||
AGENTS_PKG_DIR = src/kaizen_agentic/data/agents
|
||||
|
||||
agents-sync-package:
|
||||
@echo "📦 Syncing packaged agents from $(AGENTS_SRC_DIR)/ ..."
|
||||
@mkdir -p $(AGENTS_PKG_DIR); \
|
||||
SYNCED=0; \
|
||||
for f in $(AGENTS_SRC_DIR)/agent-*.md; do \
|
||||
dest="$(AGENTS_PKG_DIR)/$$(basename $$f)"; \
|
||||
if [ -n "$(DRY_RUN)" ]; then \
|
||||
if [ -f "$$dest" ] && cmp -s "$$f" "$$dest"; then \
|
||||
echo " = $$(basename $$f) (unchanged)"; \
|
||||
else \
|
||||
echo " → $$(basename $$f)"; \
|
||||
fi; \
|
||||
else \
|
||||
cp "$$f" "$$dest"; \
|
||||
echo " ✓ $$(basename $$f)"; \
|
||||
SYNCED=$$((SYNCED + 1)); \
|
||||
fi; \
|
||||
done; \
|
||||
if [ -z "$(DRY_RUN)" ]; then \
|
||||
echo "✅ Synced $$SYNCED file(s) to $(AGENTS_PKG_DIR)/"; \
|
||||
else \
|
||||
echo "ℹ️ DRY_RUN preview only — no files copied"; \
|
||||
fi
|
||||
|
||||
# Install agent distribution CLI
|
||||
agents-install-cli: $(VENV)/bin/activate
|
||||
@echo "📦 Installing Kaizen Agentic CLI..."
|
||||
@@ -890,6 +930,21 @@ release-check: $(VENV)/bin/activate
|
||||
echo " ❌ Build system not configured"; \
|
||||
ISSUES=$$((ISSUES + 1)); \
|
||||
fi; \
|
||||
echo " • Packaged Agent Parity:"; \
|
||||
PARITY_OK=1; \
|
||||
for f in agents/agent-*.md; do \
|
||||
dest="src/kaizen_agentic/data/agents/$$(basename $$f)"; \
|
||||
if [ ! -f "$$dest" ] || ! cmp -s "$$f" "$$dest"; then \
|
||||
PARITY_OK=0; \
|
||||
break; \
|
||||
fi; \
|
||||
done; \
|
||||
if [ $$PARITY_OK -eq 1 ] && ls agents/agent-*.md >/dev/null 2>&1; then \
|
||||
echo " ✅ agents/ matches data/agents/"; \
|
||||
else \
|
||||
echo " ❌ Packaged agents drift from agents/ — run: make agents-sync-package"; \
|
||||
ISSUES=$$((ISSUES + 1)); \
|
||||
fi; \
|
||||
echo ""; \
|
||||
if [ $$ISSUES -eq 0 ]; then \
|
||||
echo "✅ Release readiness: PASSED"; \
|
||||
@@ -915,8 +970,24 @@ release-prepare: release-check clean
|
||||
ls -la dist/ | grep "$$VERSION" || echo " • Package files:"; ls -la dist/; \
|
||||
echo ""; \
|
||||
echo "💡 Next steps:"; \
|
||||
echo " • Run 'make release-test' to test publication"; \
|
||||
echo " • Run 'make release-publish' for production release"
|
||||
echo " • Run 'make publish-gitea' for Coulomb Gitea PyPI"; \
|
||||
echo " • Run 'make release-test' to test publication on TestPyPI"; \
|
||||
echo " • Run 'make release-publish' for pypi.org (when configured)"
|
||||
|
||||
# Build and validate distributions
|
||||
package-check: release-prepare
|
||||
$(VENV_PYTHON) -c "import twine" 2>/dev/null || $(VENV_PIP) install twine
|
||||
$(VENV_PYTHON) -m twine check dist/*
|
||||
|
||||
# Publish to Coulomb Gitea PyPI registry
|
||||
publish-gitea: package-check
|
||||
ifndef TWINE_USERNAME
|
||||
$(error TWINE_USERNAME is required (e.g. export TWINE_USERNAME=<gitea-user>))
|
||||
endif
|
||||
ifndef TWINE_PASSWORD
|
||||
$(error TWINE_PASSWORD is required (e.g. export TWINE_PASSWORD=$$GITEA_API_TOKEN))
|
||||
endif
|
||||
$(VENV_PYTHON) -m twine upload --repository-url "$(GITEA_PYPI_REPOSITORY_URL)" dist/*
|
||||
|
||||
# Test publication workflow using TestPyPI
|
||||
release-test: release-prepare
|
||||
@@ -988,7 +1059,8 @@ release-finalize: $(VENV)/bin/activate
|
||||
echo ""; \
|
||||
echo " • Documentation:"; \
|
||||
echo " 💡 Verify installation instructions work:"; \
|
||||
echo " pip install kaizen-agentic==$$VERSION"; \
|
||||
echo " pip install kaizen-agentic==$$VERSION --extra-index-url <gitea-pypi-simple>"; \
|
||||
echo " See docs/PACKAGE_RELEASE.md"; \
|
||||
echo ""; \
|
||||
echo "✅ Release finalization checklist provided"; \
|
||||
echo " Complete manual steps above to finish release process"
|
||||
@@ -1026,4 +1098,4 @@ release-rollback: $(VENV)/bin/activate
|
||||
echo " • Always test with TestPyPI first"; \
|
||||
echo " • Use staging/preview environments"; \
|
||||
echo " • Implement automated quality gates"; \
|
||||
echo " • Consider pre-release versions for testing"
|
||||
echo " • Consider pre-release versions for testing"
|
||||
|
||||
16
README.md
16
README.md
@@ -37,13 +37,21 @@ python3 -m build && make install-local
|
||||
source .venv/bin/activate # Required for each session
|
||||
```
|
||||
|
||||
**From PyPI (Coming Soon):**
|
||||
**From Gitea PyPI (v1.1.0+):**
|
||||
```bash
|
||||
pip install kaizen-agentic # Available after v1.0.0 publication
|
||||
# or
|
||||
pipx install kaizen-agentic # Recommended for global CLI tools
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
|
||||
# or global CLI via pipx
|
||||
pipx install kaizen-agentic \
|
||||
--pip-args="--extra-index-url https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
See [docs/PACKAGE_RELEASE.md](docs/PACKAGE_RELEASE.md) for release and CI details.
|
||||
|
||||
### 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.
|
||||
|
||||
|
||||
21
SCOPE.md
21
SCOPE.md
@@ -29,7 +29,8 @@ This repo is the canonical home for the **KaizenAgentic** operating model (`INTE
|
||||
- **CLI tooling** (`kaizen-agentic`): `init`, `install`, `update`, `remove`, `list`, `status`, `validate`, `templates`, `detect`, `migrate`, `extensions`, `memory` (show/init/brief/clear), `protocols` (list/show); `metrics` commands planned in WP-0003
|
||||
- **Project templates** (python-basic, python-web, python-cli, python-data, comprehensive) — agent bundles in registry code
|
||||
- **Python framework** (`src/kaizen_agentic/`): `Agent`/`AgentConfig`, `AgentRegistry`, `AgentInstaller`, `OptimizationLoop`/`PerformanceMetrics`, detection/migration/extensions
|
||||
- **Packaged agent data** (`src/kaizen_agentic/data/agents/`) — 17 agents bundled for pip installs (lags `agents/` by 4; see Notes)
|
||||
- **Packaged agent data** (`src/kaizen_agentic/data/agents/`) — agents bundled for pip installs (sync with `agents/` via `make agents-update`)
|
||||
- **Gitea PyPI publication** — `make publish-gitea`, tag-triggered `.gitea/workflows/publish-python-package.yml` (v1.1.0+)
|
||||
- **Custodian MCP integration** (owned by `the-custodian`): `list_kaizen_agents()` and `get_kaizen_agent()`
|
||||
- **ADRs and workplans** for memory, protocols, workplan, and metrics conventions
|
||||
|
||||
@@ -42,7 +43,7 @@ This repo is the canonical home for the **KaizenAgentic** operating model (`INTE
|
||||
- Project-specific implementation (agents guide work; they do not build the target software)
|
||||
- Custodian State Hub, MCP server code, or cross-domain governance (consumed, not owned)
|
||||
- Full KaizenGuidance codemod pipeline (vision in `wiki/KaizenGuidance.md`; not yet implemented)
|
||||
- PyPI publication pipeline (v1.0.2 released locally; public PyPI distribution still pending)
|
||||
- Public pypi.org distribution (optional; Coulomb Gitea registry is primary)
|
||||
|
||||
---
|
||||
|
||||
@@ -68,12 +69,12 @@ This repo is the canonical home for the **KaizenAgentic** operating model (`INTE
|
||||
|
||||
## Current State
|
||||
|
||||
- Status: experimental → stabilizing (v1.0.2; agency framework shipped in WP-0002)
|
||||
- Strategic layer: `INTENT.md` and `wiki/` established; orientation docs not yet fully linked
|
||||
- Implementation: substantial — 21 agents, full CLI, agency memory + protocols tested e2e; **measurement loop not closed** (no `.kaizen/metrics/`, optimizer unwired)
|
||||
- Stability: CLI stable (Click workaround in place); agency framework validated by e2e tests
|
||||
- Usage: internal dev projects and Custodian MCP hub-wide; packaged wheel missing 4 newest agents
|
||||
- Active work: **WP-0003** (measurement loop); **WP-0004** (ecosystem integration); WP-0001 (community engagement / v1.1.0) pending
|
||||
- Status: stabilizing (v1.1.0 published on Gitea PyPI; WP-0001–0004 completed)
|
||||
- Strategic layer: `INTENT.md` and `wiki/` established; ecosystem integration docs in `wiki/EcosystemIntegration.md`
|
||||
- Implementation: 20 agents, full CLI (`metrics`, `memory`, `feedback`), agency memory + ADR-004 metrics + optimizer wiring
|
||||
- Stability: CLI stable (Click workaround in place); Gitea CI on main; publish workflow on `v*` tags
|
||||
- Usage: internal dev projects and Custodian MCP hub-wide; pip install via Gitea extra index
|
||||
- Active work: **WP-0006** (scheduled agent execution via activity-core → v1.3.0)
|
||||
|
||||
---
|
||||
|
||||
@@ -162,5 +163,5 @@ keywords: [kaizen, intent, template, optimization, digital-talent-agency]
|
||||
|
||||
## Notes
|
||||
|
||||
- `agents/` (20 files) is the development source of truth; `src/kaizen_agentic/data/agents/` (16 files) is what pip installs ship — coach, sys-medic, scope-analyst, and optimization are not yet bundled
|
||||
- Agent definitions use minimal frontmatter today; full `wiki/KaizenAgentTemplate.md` conformance is a maturity target, not current reality
|
||||
- `agents/` (20 files) is the development source of truth; `src/kaizen_agentic/data/agents/` must stay in sync (enforced in WP-0005 T09–T10)
|
||||
- Agent definitions use minimal frontmatter today; full `wiki/KaizenAgentTemplate.md` conformance is a maturity target, not current reality
|
||||
|
||||
55
TODO.md
55
TODO.md
@@ -10,42 +10,33 @@ The structure organizes **future tasks** by their impact, just as a changelog or
|
||||
|
||||
## [Unreleased] - *Active Vibe-Coding State* 💡
|
||||
|
||||
Tasks moved to workplan: `workplans/kaizen-agentic-WP-0001-community-engagement.md`
|
||||
Hub workstream: `kaizen-wp-0001-community-engagement` (8 tasks, all todo)
|
||||
Tasks in workplan: `workplans/kaizen-agentic-WP-0007-agent-authoring-doc-generation.md` (v1.4.0)
|
||||
|
||||
### Implemented (pending v1.4.0 tag)
|
||||
* **`create-agent`** — scaffold schema-valid agents
|
||||
* **`docs generate [--check]`** — idempotent CLAUDE.md Installed Agents refresh
|
||||
* **Frontmatter schema validation** in `validate`
|
||||
* **Doc-regeneration idempotency fix** + agent file rename (project-assistant)
|
||||
|
||||
### To Add (release)
|
||||
* **Tag v1.4.0** — after review
|
||||
* **activity-core implementation** — WP-0006 resolver + sync (separate repo; see handoff doc)
|
||||
|
||||
### Shipped — v1.3.0 (2026-06-17)
|
||||
* **ADR-005 + `.kaizen/schedule.yml`** — scheduled agent execution contract
|
||||
* **`kaizen-agentic schedule`** — validate, init, prepare, list
|
||||
* **activity-core definitions** — weekly coach + optimization on preselected repos
|
||||
|
||||
### Deferred / future
|
||||
* Interactive agent selection wizard (multi-step) — `create-agent` covers the
|
||||
single-agent scaffold; a guided multi-agent wizard remains future work
|
||||
* Multi-file agent packages / protocol scaffolding
|
||||
|
||||
***
|
||||
|
||||
## [1.1.0] - Community Engagement and Advanced Automation - *Next Planned Increment*
|
||||
## [1.1.0] - Community Engagement — *Shipped 2026-06-18*
|
||||
|
||||
This version focuses on community engagement, advanced automation, and enhanced user experience.
|
||||
|
||||
### To Add
|
||||
* **Developer feedback mechanisms** for easy collection of user feedback and suggestions
|
||||
* **Interactive agent selection** wizard for new projects
|
||||
* **GitHub Actions workflows** for CI/CD automation
|
||||
* **Agent metrics and telemetry** system for usage tracking and optimization
|
||||
* **Agent template validation** system with schema enforcement
|
||||
* **Documentation generation** automation from agent metadata
|
||||
* **Community contribution guidelines** and contributor onboarding
|
||||
|
||||
### To Refactor
|
||||
* **CLI error handling** with more user-friendly messages and suggestions
|
||||
* **Performance optimization** for handling large numbers of agents
|
||||
* **Installation process** with progress indicators and detailed feedback
|
||||
|
||||
### To Fix
|
||||
* **Cross-platform compatibility** testing and fixes for Windows/macOS environments
|
||||
* **Edge case handling** in dependency resolution algorithms
|
||||
* **Memory usage optimization** for large-scale agent installations
|
||||
|
||||
### To Secure
|
||||
* **Agent integrity verification** with checksums and validation
|
||||
* **Sandboxed agent execution** for security-sensitive environments
|
||||
* **Configuration file validation** to prevent malicious modifications
|
||||
|
||||
### To Remove
|
||||
* **Legacy installation methods** that are no longer supported
|
||||
* **Deprecated CLI options** and maintain backward compatibility warnings
|
||||
See `CHANGELOG.md` [1.1.0] and `workplans/kaizen-agentic-WP-0001-community-engagement.md`.
|
||||
|
||||
***
|
||||
|
||||
|
||||
@@ -169,4 +169,4 @@ The agent focuses on practical, implementable improvements that align with proje
|
||||
- Identify and fix security vulnerabilities opportunistically
|
||||
- Recommend secure coding practices and patterns
|
||||
- Assess input validation and data sanitization
|
||||
- Evaluate dependency security and update recommendations
|
||||
- Evaluate dependency security and update recommendations
|
||||
|
||||
@@ -179,4 +179,4 @@ Based on successful optimizations (e.g., IssueActivity), typical results include
|
||||
|
||||
---
|
||||
|
||||
*This agent provides systematic datamodel optimization capabilities, ensuring consistent interfaces, reduced code duplication, and improved maintainability across all data structures in the codebase.*
|
||||
*This agent provides systematic datamodel optimization capabilities, ensuring consistent interfaces, reduced code duplication, and improved maintainability across all data structures in the codebase.*
|
||||
|
||||
@@ -284,4 +284,4 @@ When updating or creating changelog files:
|
||||
- Indicate urgency of security updates
|
||||
- Consider separate security advisory for critical issues
|
||||
|
||||
Remember: Your role is to make version history clear, accessible, and useful for users, maintainers, and stakeholders. Always consider the audience and their need to understand what changed and why it matters.
|
||||
Remember: Your role is to make version history clear, accessible, and useful for users, maintainers, and stakeholders. Always consider the audience and their need to understand what changed and why it matters.
|
||||
|
||||
@@ -362,4 +362,4 @@ When updating or creating contributing files:
|
||||
- Governance and decision-making processes
|
||||
- Release and maintenance responsibilities
|
||||
|
||||
Remember: Your role is to make contributing accessible, clear, and aligned with project goals. Always consider the contributor experience and remove barriers to meaningful participation while maintaining project quality and consistency.
|
||||
Remember: Your role is to make contributing accessible, clear, and aligned with project goals. Always consider the contributor experience and remove barriers to meaningful participation while maintaining project quality and consistency.
|
||||
|
||||
@@ -236,4 +236,4 @@ When updating or creating todo files:
|
||||
- Poor priority assessment
|
||||
- Missing dependencies or blockers
|
||||
|
||||
Remember: Your role is to make todo management effortless and effective, enabling better focus and productivity. Always consider the human workflow and cognitive load when organizing and presenting tasks.
|
||||
Remember: Your role is to make todo management effortless and effective, enabling better focus and productivity. Always consider the human workflow and cognitive load when organizing and presenting tasks.
|
||||
|
||||
@@ -188,4 +188,4 @@ kaizen-agentic metrics optimize [agent-name]
|
||||
|
||||
Run without an agent name to analyze all agents with project metrics. Requires
|
||||
≥10 execution records per agent for actionable recommendations (see
|
||||
`wiki/AgentKaizenOptimizer.md`).
|
||||
`wiki/AgentKaizenOptimizer.md`).
|
||||
|
||||
@@ -6,10 +6,9 @@ category: project-management
|
||||
|
||||
## Instructions
|
||||
|
||||
You are the priority assistant helping with project planning and deciding what to do first.
|
||||
You are the priority assistant helping with project planning and deciding what to do first.
|
||||
Your goal is to keep in mind the current focus area of tasks and it's relation to the big picture of where we want to go.
|
||||
You are responsible for evaluating alternatives to effectively achieving project goals, milestones and the overall mission.
|
||||
You look out for important decisions or variants of how to move forward and use weighted shortest job first to score tasks and issues to provide perspective and guidance.
|
||||
|
||||
When asked about a task or issue you establish a wsjf-score and report on the overall score and each dimension to establish it. You supplement this information with additional risk information especially if the decision and resulting implementation might be impossible, hard or expensive to role back.
|
||||
|
||||
|
||||
@@ -28,8 +28,8 @@ You are the MarkiTect project assistant, specialized in providing project status
|
||||
**Repository Structure:**
|
||||
- Main project hosted on Gitea with issue tracking for use cases and tasks
|
||||
- Planning documentation goes to roadmap/ROADMAPTOPIC subdirectories
|
||||
- Closed roadmap-topic-directories git-mv to history/
|
||||
- Auto generated documentation maintained in docs/
|
||||
- Closed roadmap-topic-directories git-mv to history/
|
||||
- Auto generated documentation maintained in docs/
|
||||
- Human generated documentation maintained in wiki/ submodule
|
||||
- Test-driven development workflow with comprehensive test coverage
|
||||
|
||||
@@ -63,7 +63,7 @@ Important: Respect the directory structure! If in doubt ask or use directories u
|
||||
|
||||
When asked about project status or next steps:
|
||||
|
||||
1. **Start with Current State**: Always check TODO.md for the latest activity
|
||||
1. **Start with Current State**: Always check TODO.md for the latest activity
|
||||
2. **Review Recent Progress**: Check CHANGELOG.md for previous work and progress
|
||||
3. **Check Planned Work**: TODO.md documents next steps and priorities, if empty see topics in roadmap/
|
||||
4. **Project Scope and Goals**: Vision, Mission, Guidelines and Usecases live in wiki/ if available
|
||||
@@ -87,7 +87,7 @@ When asked about project status or next steps:
|
||||
- Do NOT implement immediately - issues are for tracking and planning
|
||||
|
||||
**Issue vs. Immediate Work:**
|
||||
- Current session planned work: document in TODO.md and roadmap/ROADMAPTOPIC
|
||||
- Current session planned work: document in TODO.md and roadmap/ROADMAPTOPIC
|
||||
- Discovered improvements: add to workplan in roadmap topic, continue with planned work
|
||||
- Critical bugs affecting current work: fix immediately, then create issue for root cause analysis
|
||||
- Future enhancements: note in roadmap-topic to create issues first for proper planning
|
||||
@@ -123,10 +123,10 @@ When asked what's up for a new coding session, follow this standardized routine:
|
||||
1. **Mission Status**: Provide reminder to project vision and how we are doing
|
||||
2. **Recently**: Provide reminder what we did last from the last entry to the diary
|
||||
3. **TODO.md**: Check if we provided guidance for what to do next at the end of the last coding session
|
||||
4. **git status**: Check if git is clean or work has been left unfinished
|
||||
4. **git status**: Check if git is clean or work has been left unfinished
|
||||
5. **Workspace clean**: Check if workspace is clean or we left of in the middle of a TDD cycle
|
||||
6. **Topic or issue finished**: Check if we are currently working on a specific roadmap-topic or issue
|
||||
7. **Suggestion**: Provide a sensible suggestion of what to do next
|
||||
7. **Suggestion**: Provide a sensible suggestion of what to do next
|
||||
|
||||
## Session Wrap-Up Protocol
|
||||
|
||||
@@ -170,7 +170,7 @@ Ready for commit: [list of files to commit]
|
||||
**Hunch**: Ideas to explore that need consideration if useful and in scope
|
||||
**Hickups**: Notes on inefficient or roundtripping implementation to analyse later
|
||||
|
||||
Collect these in the roadmap-topic-directory and move stuff to eat-the-frog on close if unfinished
|
||||
Collect these in the roadmap-topic-directory and move stuff to eat-the-frog on close if unfinished
|
||||
|
||||
### Example Issue Creation During Development:
|
||||
**Scenario**: While implementing CLI commands, discover that error messages could be improved
|
||||
@@ -178,7 +178,7 @@ Collect these in the roadmap-topic-directory and move stuff to eat-the-frog on c
|
||||
**Result**: Continue with current CLI implementation, address error enhancement in future session
|
||||
|
||||
Generate issues for relevantly expensive or risky stuff and in direct feedback with developers.
|
||||
Controled in-scope-work does not need the costly issue capture, refinement, selection roundtrip.
|
||||
Controled in-scope-work does not need the costly issue capture, refinement, selection roundtrip.
|
||||
|
||||
Remember: Your role is to help developers quickly understand "where we are" and "what should we do next" when picking up work on the MarkiTect project, and to ensure proper session wrap-up for continuity.
|
||||
|
||||
@@ -98,4 +98,4 @@ When managing releases, always prioritize:
|
||||
1. **Security**: Never compromise on security practices
|
||||
2. **Reliability**: Thorough testing before publication
|
||||
3. **Communication**: Clear documentation and announcements
|
||||
4. **Reproducibility**: Consistent and documented processes
|
||||
4. **Reproducibility**: Consistent and documented processes
|
||||
|
||||
@@ -499,4 +499,4 @@ The agent directly addresses the root causes:
|
||||
|
||||
---
|
||||
|
||||
*This agent provides systematic foundation analysis and interface contract verification based on lessons learned from Issue #59 to prevent compatibility issues and ensure solid architectural foundations before implementation.*
|
||||
*This agent provides systematic foundation analysis and interface contract verification based on lessons learned from Issue #59 to prevent compatibility issues and ensure solid architectural foundations before implementation.*
|
||||
|
||||
@@ -412,4 +412,4 @@ When setting up or checking repositories, always verify that:
|
||||
- Standards compliance is treated as a required test, not optional check
|
||||
- Missing .gitignore or other essential files will be caught automatically
|
||||
|
||||
Remember: Your role is to transform repository stubs into production-ready Python projects that follow industry best practices, enable efficient development workflows, and provide a solid foundation for long-term project success.
|
||||
Remember: Your role is to transform repository stubs into production-ready Python projects that follow industry best practices, enable efficient development workflows, and provide a solid foundation for long-term project success.
|
||||
|
||||
@@ -143,7 +143,7 @@ You understand the workspace structure (default: `.tddai_workspace/`, configurab
|
||||
- `DIRTY` - Workspace directory exists but no current issue file
|
||||
|
||||
### Test Development Best Practices
|
||||
**Test Naming Convention:**
|
||||
**Test Naming Convention:**
|
||||
- `test_{capability}_issue_{NUM}_{scenario}.py`
|
||||
|
||||
**Required Test Structure:**
|
||||
|
||||
@@ -141,4 +141,4 @@ ACTION: Change import path, verify test logic still valid
|
||||
- **Communicate trade-offs** when removing functionality
|
||||
- **Maintain backward compatibility** where feasible
|
||||
|
||||
This agent ensures the MarkiTect project maintains a robust, reliable test suite that accurately reflects the current codebase architecture and functionality.
|
||||
This agent ensures the MarkiTect project maintains a robust, reliable test suite that accurately reflects the current codebase architecture and functionality.
|
||||
|
||||
@@ -291,4 +291,4 @@ markers =
|
||||
|
||||
---
|
||||
|
||||
*This agent provides specialized test execution optimization focused on TDD8 workflow enhancement, pytest reliability resolution, and systematic testing efficiency improvements for development velocity.*
|
||||
*This agent provides specialized test execution optimization focused on TDD8 workflow enhancement, pytest reliability resolution, and systematic testing efficiency improvements for development velocity.*
|
||||
|
||||
@@ -196,4 +196,4 @@ RECOMMENDATION: Suggest primary tools and deprecation plan for others
|
||||
IMPLEMENTATION: Provide migration guide and updated documentation
|
||||
```
|
||||
|
||||
This agent ensures the MarkiTect project maintains an optimized, efficient tooling ecosystem that maximizes developer productivity and minimizes friction in development workflows.
|
||||
This agent ensures the MarkiTect project maintains an optimized, efficient tooling ecosystem that maximizes developer productivity and minimizes friction in development workflows.
|
||||
|
||||
@@ -13,13 +13,18 @@ The Kaizen Agentic framework provides a comprehensive system for distributing an
|
||||
|
||||
## Installation
|
||||
|
||||
Install the Kaizen Agentic package:
|
||||
Install the Kaizen Agentic package from the Coulomb Gitea PyPI registry:
|
||||
|
||||
```bash
|
||||
pip install kaizen-agentic
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
This provides the `kaizen-agentic` CLI tool for managing agents.
|
||||
This provides the `kaizen-agentic` CLI tool for managing agents. See
|
||||
[PACKAGE_RELEASE.md](PACKAGE_RELEASE.md) for pipx, local builds, and publishing.
|
||||
|
||||
## CLI Commands
|
||||
|
||||
@@ -373,10 +378,7 @@ If you're currently managing agents manually:
|
||||
ls agents/agent-*.md
|
||||
```
|
||||
|
||||
2. **Install Package**:
|
||||
```bash
|
||||
pip install kaizen-agentic
|
||||
```
|
||||
2. **Install Package** (same as Installation section above).
|
||||
|
||||
3. **Validate Current Setup**:
|
||||
```bash
|
||||
@@ -412,4 +414,4 @@ When updating Kaizen Agentic versions:
|
||||
kaizen-agentic validate
|
||||
```
|
||||
|
||||
This distribution system makes it easy to share and maintain consistent development workflows across all your projects using specialized AI agents.
|
||||
This distribution system makes it easy to share and maintain consistent development workflows across all your projects using specialized AI agents.
|
||||
|
||||
@@ -3,8 +3,15 @@
|
||||
Quick reference for the `kaizen-agentic` command-line tool.
|
||||
|
||||
## Installation
|
||||
|
||||
From Coulomb Gitea PyPI (see [PACKAGE_RELEASE.md](PACKAGE_RELEASE.md)):
|
||||
|
||||
```bash
|
||||
pip install kaizen-agentic
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
## Core Commands
|
||||
@@ -45,9 +52,28 @@ kaizen-agentic remove old-agent-name
|
||||
|
||||
# Project status
|
||||
kaizen-agentic status # Show current project status
|
||||
kaizen-agentic validate # Validate agent installation
|
||||
kaizen-agentic validate # Validate agents (incl. frontmatter schema)
|
||||
```
|
||||
|
||||
### Authoring & Docs (WP-0007)
|
||||
```bash
|
||||
# Scaffold a new schema-valid agent (agents/agent-<name>.md)
|
||||
kaizen-agentic create-agent my-agent -c testing -d "What it does"
|
||||
kaizen-agentic create-agent my-agent # prompts for category + description
|
||||
kaizen-agentic create-agent my-agent --force # overwrite existing
|
||||
|
||||
# Refresh the CLAUDE.md "Installed Agents" section from agent metadata
|
||||
kaizen-agentic docs generate # idempotent rewrite
|
||||
kaizen-agentic docs generate --check # CI gate: non-zero if out of date
|
||||
|
||||
# validate enforces required name/description/category, valid category,
|
||||
# and valid memory/model values
|
||||
kaizen-agentic validate
|
||||
```
|
||||
|
||||
After adding or editing agents, run `make agents-sync-package` so the packaged
|
||||
`data/agents/` copies stay in parity (release-check gate).
|
||||
|
||||
### Project Metrics (ADR-004)
|
||||
```bash
|
||||
# Record outcome at session close
|
||||
@@ -81,6 +107,22 @@ kaizen-agentic memory init tdd-workflow --no-metrics # memory only
|
||||
|
||||
Session-close template: `docs/templates/session-close-protocol.md`
|
||||
|
||||
### Scheduled Agent Execution (ADR-005)
|
||||
```bash
|
||||
# Opt this repo into fleet scheduling
|
||||
kaizen-agentic schedule init # coach + optimization weekly
|
||||
kaizen-agentic schedule init --timezone UTC # override timezone
|
||||
kaizen-agentic schedule validate # schema + agent-name checks
|
||||
kaizen-agentic schedule list # enabled entries (--all incl. disabled)
|
||||
|
||||
# Prepare orientation for a scheduled run (offline; no State Hub needed)
|
||||
kaizen-agentic schedule prepare coach # markdown bundle
|
||||
kaizen-agentic schedule prepare optimization --format json
|
||||
```
|
||||
|
||||
activity-core fires the schedule and creates a task per (repo, agent); the task
|
||||
runs `schedule prepare`. kaizen-agentic does not run cron or invoke Claude.
|
||||
|
||||
### Information
|
||||
```bash
|
||||
# List templates
|
||||
@@ -125,7 +167,7 @@ kaizen-agentic status
|
||||
```bash
|
||||
git clone team-repo
|
||||
cd team-repo
|
||||
pip install kaizen-agentic
|
||||
# Install CLI — see Installation section above
|
||||
kaizen-agentic status # See what agents are used
|
||||
cat CLAUDE.md # Read agent documentation
|
||||
```
|
||||
@@ -185,8 +227,7 @@ make agents-status # Show detailed status
|
||||
|
||||
### Common Issues
|
||||
```bash
|
||||
# Command not found
|
||||
pip install kaizen-agentic
|
||||
# Command not found — reinstall (see Installation section)
|
||||
|
||||
# No agents directory
|
||||
kaizen-agentic install todo-keeper
|
||||
@@ -227,4 +268,4 @@ kaizen-agentic update && kaizen-agentic validate
|
||||
```bash
|
||||
kaizen-agentic status
|
||||
cat CLAUDE.md # Detailed info
|
||||
```
|
||||
```
|
||||
|
||||
@@ -57,16 +57,22 @@ make install-global
|
||||
# CLI available from any directory
|
||||
```
|
||||
|
||||
**Option D: From PyPI (Coming Soon)**
|
||||
**Option D: From Gitea PyPI (v1.1.0+)**
|
||||
|
||||
```bash
|
||||
# Will be available once v1.0.0 is published
|
||||
pip install kaizen-agentic
|
||||
# or
|
||||
pipx install kaizen-agentic # Recommended for global CLI tools
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
|
||||
# or global CLI via pipx
|
||||
pipx install kaizen-agentic \
|
||||
--pip-args="--extra-index-url https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
> **📦 Release Status**: v1.0.0 is ready for publication. Use `make install-global` for system-wide availability.
|
||||
> **📦 Registry**: Published on the Coulomb Gitea PyPI registry. Dependencies resolve
|
||||
> from public PyPI via `--extra-index-url`. See [PACKAGE_RELEASE.md](PACKAGE_RELEASE.md).
|
||||
|
||||
### 2. Verify Installation
|
||||
|
||||
@@ -265,7 +271,9 @@ jobs:
|
||||
- uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.8'
|
||||
- run: pip install kaizen-agentic
|
||||
- run: >-
|
||||
pip install kaizen-agentic
|
||||
--extra-index-url "https://${{ secrets.GITEA_PACKAGE_USER }}:${{ secrets.GITEA_PACKAGE_TOKEN }}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
- run: kaizen-agentic validate
|
||||
```
|
||||
|
||||
@@ -405,7 +413,8 @@ kaizen-agentic status
|
||||
# New team member setup
|
||||
git clone project-repo
|
||||
cd project-repo
|
||||
pip install kaizen-agentic # or add to requirements
|
||||
# see Option D for GITEA_PACKAGE_USER / GITEA_PACKAGE_TOKEN and --extra-index-url
|
||||
pip install kaizen-agentic
|
||||
kaizen-agentic status # See what agents are used
|
||||
kaizen-agentic validate # Verify everything works
|
||||
|
||||
@@ -419,12 +428,16 @@ cat CLAUDE.md
|
||||
|
||||
**"Command not found: kaizen-agentic"**
|
||||
```bash
|
||||
# Install the package
|
||||
pip install kaizen-agentic
|
||||
# Install from Gitea PyPI (same credentials as Option D)
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
|
||||
# Or if using virtual env:
|
||||
source .venv/bin/activate
|
||||
pip install kaizen-agentic
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
**"No agents directory found"**
|
||||
@@ -463,4 +476,4 @@ Once you have agents installed:
|
||||
4. **Share with team**: Document which agents your project uses
|
||||
5. **Contribute back**: Report issues and suggest improvements
|
||||
|
||||
The key insight is that **you don't need the Makefile targets to use agents effectively** - the `kaizen-agentic` CLI provides all the functionality you need. The Makefile targets are just convenient shortcuts for projects that have them.
|
||||
The key insight is that **you don't need the Makefile targets to use agents effectively** - the `kaizen-agentic` CLI provides all the functionality you need. The Makefile targets are just convenient shortcuts for projects that have them.
|
||||
|
||||
@@ -9,10 +9,18 @@ This step-by-step tutorial will guide you through creating your first project wi
|
||||
|
||||
## Step 1: Install Kaizen Agentic
|
||||
|
||||
From the Coulomb Gitea PyPI registry (dependencies resolve from public PyPI):
|
||||
|
||||
```bash
|
||||
pip install kaizen-agentic
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
See [PACKAGE_RELEASE.md](PACKAGE_RELEASE.md) for pipx and release details.
|
||||
|
||||
Verify the installation:
|
||||
|
||||
```bash
|
||||
@@ -235,7 +243,11 @@ kaizen-agentic status
|
||||
|
||||
**"kaizen-agentic: command not found"**
|
||||
```bash
|
||||
pip install kaizen-agentic
|
||||
# Same install as Step 1 (Gitea extra index — see PACKAGE_RELEASE.md)
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
**"make: command not found"**
|
||||
@@ -267,4 +279,4 @@ make test
|
||||
- ✅ AI agents for development assistance
|
||||
- ✅ Make-based development commands
|
||||
|
||||
You're now ready to build amazing Python projects with AI agent assistance! 🚀
|
||||
You're now ready to build amazing Python projects with AI agent assistance! 🚀
|
||||
|
||||
@@ -39,12 +39,26 @@ invoke kaizen-agentic CLI commands.
|
||||
| [post-install-metrics-scaffold](integrations/activity-definitions/post-install-metrics-scaffold.md) | `kaizen.agent.installed` | `memory init` validation |
|
||||
| [low-success-rate-review](integrations/activity-definitions/low-success-rate-review.md) | `kaizen.metrics.recorded` | `metrics show` + `optimize` |
|
||||
|
||||
**Activation:**
|
||||
**Activation handoff (activity-core owners):**
|
||||
|
||||
1. Copy or symlink definitions from `docs/integrations/activity-definitions/` into
|
||||
activity-core's `activity-definitions/` tree (or register as external ConfigMap).
|
||||
2. Run `make sync-activity-definitions` in activity-core.
|
||||
3. Enable definitions (`enabled: true`) after resolver wiring is verified.
|
||||
1. **Copy definitions** from kaizen-agentic:
|
||||
`docs/integrations/activity-definitions/*.md` → activity-core
|
||||
`activity-definitions/kaizen-agentic/` (or org-equivalent path per ACT-ADR-002).
|
||||
2. **Register in activity-core index** — ensure each definition slug appears in the
|
||||
activity-core catalog consumed by the resolver.
|
||||
3. **Run sync** in activity-core: `make sync-activity-definitions` (or repo-equivalent).
|
||||
4. **Wire triggers** — map cron / NATS subjects (`kaizen.agent.installed`,
|
||||
`kaizen.metrics.recorded`) to the documented CLI invocations.
|
||||
5. **Enable gradually** — set `enabled: true` per definition after a manual smoke test
|
||||
against a repo with `.kaizen/metrics/` populated.
|
||||
6. **Verify credentials** — scheduled runs need `kaizen-agentic` on PATH and any
|
||||
Gitea PyPI extra index if the runner installs from registry (see PACKAGE_RELEASE.md).
|
||||
|
||||
**kaizen-agentic maintainer checklist:**
|
||||
|
||||
- [ ] Three definition files committed under `docs/integrations/activity-definitions/`
|
||||
- [ ] activity-core PR or issue opened to register definitions
|
||||
- [ ] Smoke test commands documented below pass on a pilot repo
|
||||
|
||||
**Smoke test (manual):**
|
||||
|
||||
@@ -59,6 +73,45 @@ test -f .kaizen/metrics/optimizer/analysis.json && echo OK
|
||||
|
||||
**Boundary:** kaizen-agentic does not run Temporal schedules.
|
||||
|
||||
### Scheduled agent execution (WP-0006, ADR-005)
|
||||
|
||||
Beyond the metrics-only definitions above, agents themselves run on a cadence
|
||||
against a **preselected repo roster**. The roster combines three sources:
|
||||
|
||||
| Source | Purpose |
|
||||
|--------|---------|
|
||||
| State Hub `GET /repos/` | Canonical slug list + `host_paths` |
|
||||
| Repo opt-in: `.kaizen/schedule.yml` exists with `version` set | Per-repo enablement |
|
||||
| Optional hub flag `kaizen_schedule_enabled: true` (future) | Operator override |
|
||||
|
||||
A repo is **schedule-eligible** when it is registered with reachable
|
||||
`host_paths` **and** carries a valid `.kaizen/schedule.yml`. The activity-core
|
||||
resolver `discover_kaizen_scheduled_repos` intersects these and emits
|
||||
`context.scheduled_runs` (one entry per `(repo, agent)`); definitions `for_each`
|
||||
over that output.
|
||||
|
||||
| Definition | Trigger | Agent | Prepare command |
|
||||
|------------|---------|-------|-----------------|
|
||||
| [weekly-coach-orientation](integrations/activity-definitions/weekly-coach-orientation.md) | Cron Mon 09:00 | `coach` | `schedule prepare coach` |
|
||||
| [weekly-optimization-review](integrations/activity-definitions/weekly-optimization-review.md) | Cron Mon 10:00 | `optimization` | `schedule prepare optimization` |
|
||||
|
||||
**Listing schedule-eligible repos** (operator, no activity-core code):
|
||||
|
||||
```bash
|
||||
# In each candidate repo on a host listed in state-hub host_paths:
|
||||
kaizen-agentic schedule validate && kaizen-agentic schedule list
|
||||
```
|
||||
|
||||
**Design docs (no state-hub / activity-core code in this repo):**
|
||||
|
||||
- [schedule-schema.md](integrations/schedule-schema.md) — `.kaizen/schedule.yml`
|
||||
- [state-hub-roster-fields.md](integrations/state-hub-roster-fields.md) — hub fields/filters
|
||||
- [discover-kaizen-scheduled-repos.md](integrations/discover-kaizen-scheduled-repos.md) — resolver spec
|
||||
- [kaizen-schedule-prepared-event.md](integrations/kaizen-schedule-prepared-event.md) — event payload
|
||||
|
||||
**Boundary:** kaizen-agentic declares and prepares; activity-core schedules;
|
||||
state-hub owns the roster.
|
||||
|
||||
---
|
||||
|
||||
## Pattern 3 — artifact-store evidence retention
|
||||
@@ -102,4 +155,4 @@ No runtime dependency in WP-0004.
|
||||
| `HELIX_TOKENS`, `HELIX_INFRA_OVERHEAD_SHARE` | `metrics record` | Fleet cost fields |
|
||||
| `HELIX_STORE_DB` | `metrics correlate` | Digest lookup database |
|
||||
| `ARTIFACTSTORE_API_URL` | `metrics publish` | Registry endpoint |
|
||||
| `ARTIFACTSTORE_API_TOKEN` | `metrics publish` | Write auth bearer token |
|
||||
| `ARTIFACTSTORE_API_TOKEN` | `metrics publish` | Write auth bearer token |
|
||||
|
||||
154
docs/PACKAGE_RELEASE.md
Normal file
154
docs/PACKAGE_RELEASE.md
Normal file
@@ -0,0 +1,154 @@
|
||||
# Python Package Release
|
||||
|
||||
`kaizen-agentic` publishes as the `kaizen-agentic` Python package on the Coulomb
|
||||
Gitea PyPI registry. Public [pypi.org](https://pypi.org/) distribution is optional
|
||||
and not required for ecosystem use.
|
||||
|
||||
## Install (consumers)
|
||||
|
||||
Dependencies such as `pyyaml` resolve from public PyPI. Use Gitea as an extra index:
|
||||
|
||||
```bash
|
||||
export GITEA_PACKAGE_USER=<gitea-user>
|
||||
export GITEA_PACKAGE_TOKEN=<package-token>
|
||||
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url "https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
Global CLI via pipx:
|
||||
|
||||
```bash
|
||||
pipx install kaizen-agentic \
|
||||
--pip-args="--extra-index-url https://${GITEA_PACKAGE_USER}:${GITEA_PACKAGE_TOKEN}@gitea.coulomb.social/api/packages/coulomb/pypi/simple/"
|
||||
```
|
||||
|
||||
Do not commit tokenized index URLs. Inject credentials via environment variables or
|
||||
CI secrets.
|
||||
|
||||
## Local Release
|
||||
|
||||
Build and validate artifacts:
|
||||
|
||||
```bash
|
||||
make package-check
|
||||
```
|
||||
|
||||
Publish to the Coulomb organization registry:
|
||||
|
||||
```bash
|
||||
TWINE_USERNAME=<gitea-user> \
|
||||
TWINE_PASSWORD=<package-token> \
|
||||
make publish-gitea
|
||||
```
|
||||
|
||||
Package upload endpoint:
|
||||
|
||||
```text
|
||||
https://gitea.coulomb.social/api/packages/coulomb/pypi
|
||||
```
|
||||
|
||||
Consumer simple index:
|
||||
|
||||
```text
|
||||
https://gitea.coulomb.social/api/packages/coulomb/pypi/simple/
|
||||
```
|
||||
|
||||
## Gitea repository secrets (one-time)
|
||||
|
||||
Configure in Gitea: **Repository → Settings → Actions → Secrets**.
|
||||
|
||||
| Secret | Value |
|
||||
|--------|-------|
|
||||
| `PACKAGE_USER` | `tegwick` — Gitea username that owns the package token |
|
||||
| `PACKAGE_TOKEN` | Gitea API token named `inter-hub-pkg-rep` (`write:package`) |
|
||||
|
||||
Token custody (OpenBao):
|
||||
|
||||
```text
|
||||
platform/data/operators/inter-hub/package-management
|
||||
→ field: inter-hub-pkg-rep
|
||||
```
|
||||
|
||||
Paste the **plaintext** token into the Gitea secret UI. `inter-hub-pkg-rep` is the
|
||||
token name in Gitea, not a username.
|
||||
|
||||
Gitea rejects secret names prefixed with `GITEA_` — use `PACKAGE_USER` / `PACKAGE_TOKEN`
|
||||
(not `GITEA_PACKAGE_USER`). Workflows use `runs-on: haskelseed` and native `git clone`
|
||||
(no GitHub Marketplace actions).
|
||||
|
||||
The publish workflow fails at the upload step when either secret is missing or
|
||||
invalid. Do not commit tokens to the repository.
|
||||
|
||||
**Smoke-test (2026-06-16):** `workflow_dispatch` run #3042 authenticated successfully
|
||||
(`409 Conflict` on re-upload of `1.1.0` — expected). Root causes of earlier `401`s:
|
||||
wrong token (`GITEA_API_TOKEN` ≠ package token), wrong username (`inter-hub-pkg-rep`
|
||||
is a token name), and a stale org-level secret. Build uses `.build-venv` (PEP 668).
|
||||
|
||||
Verify secrets without cutting a release:
|
||||
|
||||
1. Open **Actions → Publish Python package → Run workflow** (`workflow_dispatch`),
|
||||
or dispatch via API:
|
||||
`POST /api/v1/repos/coulomb/kaizen-agentic/actions/workflows/publish-python-package.yml/dispatches`
|
||||
with body `{"ref":"main"}`
|
||||
2. Confirm the run completes and `twine upload` succeeds
|
||||
3. Optional: `pip install kaizen-agentic==<version> --extra-index-url ...`
|
||||
|
||||
The publish job uses an isolated `.build-venv` on the runner (PEP 668 safe).
|
||||
|
||||
## Pre-tag release checklist
|
||||
|
||||
Before `git tag vX.Y.Z && git push origin vX.Y.Z`:
|
||||
|
||||
- [ ] `make release-check` passes (tests, flake8, version consistency, agent parity)
|
||||
- [ ] `make package-check` builds and validates `dist/*`
|
||||
- [ ] `CHANGELOG.md` has a dated `[X.Y.Z]` section matching `pyproject.toml`
|
||||
- [ ] `PACKAGE_USER` and `PACKAGE_TOKEN` secrets are set
|
||||
- [ ] Publish workflow smoke-tested via `workflow_dispatch` (or prior tag release)
|
||||
- [ ] `make agents-sync-package` run if `agents/` changed since last release
|
||||
|
||||
## Gitea Actions Release
|
||||
|
||||
The `.gitea/workflows/publish-python-package.yml` workflow publishes on tags
|
||||
matching `v*`.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
git tag v1.2.0
|
||||
git push origin v1.2.0
|
||||
```
|
||||
|
||||
## Public PyPI (optional)
|
||||
|
||||
When pypi.org credentials are configured (`~/.pypirc` or `TWINE_PASSWORD` API
|
||||
token with `TWINE_USERNAME=__token__`):
|
||||
|
||||
```bash
|
||||
make release-publish
|
||||
python -m twine upload dist/*
|
||||
```
|
||||
|
||||
## Scheduled-run runner prerequisites (WP-0006)
|
||||
|
||||
A runner that executes a scheduled kaizen agent task (fired by activity-core)
|
||||
needs:
|
||||
|
||||
- **`kaizen-agentic` on PATH** — `pip install kaizen-agentic` (or `pipx install
|
||||
kaizen-agentic`) using the Gitea PyPI extra index when installing from the
|
||||
internal registry:
|
||||
```bash
|
||||
pip install kaizen-agentic \
|
||||
--extra-index-url https://gitea.coulomb.social/api/packages/coulomb/pypi/simple/
|
||||
```
|
||||
- **Repo checkout reachable** at the `host_paths[<host>]` registered in State
|
||||
Hub, with a valid `.kaizen/schedule.yml` (`kaizen-agentic schedule validate`).
|
||||
- **No State Hub required for `prepare`** — `schedule prepare` reads local
|
||||
`.kaizen/` state only. The hub is needed by the *resolver* (activity-core),
|
||||
not by the prepared session.
|
||||
|
||||
**Enabling a definition** (activity-core operator): keep the kaizen definitions
|
||||
at `enabled: false` until a manual smoke test passes (see
|
||||
[INTEGRATION_PATTERNS.md Pattern 2](INTEGRATION_PATTERNS.md) and the
|
||||
[activity-core handoff checklist](integrations/activity-core-handoff-wp0006.md)),
|
||||
then flip one definition to `enabled: true` in staging before fleet-wide enable.
|
||||
149
docs/adr/ADR-005-scheduled-agent-execution.md
Normal file
149
docs/adr/ADR-005-scheduled-agent-execution.md
Normal file
@@ -0,0 +1,149 @@
|
||||
---
|
||||
id: ADR-005
|
||||
title: Scheduled Agent Execution Convention
|
||||
status: accepted
|
||||
date: "2026-06-17"
|
||||
---
|
||||
|
||||
# ADR-005 — Scheduled Agent Execution Convention
|
||||
|
||||
## Status
|
||||
|
||||
Accepted
|
||||
|
||||
## Context
|
||||
|
||||
Kaizen agents are markdown instruction sets invoked in coding-agent sessions.
|
||||
ADR-004 added project-scoped metrics; WP-0004 committed three metrics-focused
|
||||
`ActivityDefinition` drafts (`enabled: false`). What is still missing is a way to
|
||||
run **agents themselves** — not just the metrics optimizer — on a **regular
|
||||
cadence** against a **preselected set of repos**, without kaizen-agentic owning
|
||||
Temporal workers, cron, or an LLM runtime.
|
||||
|
||||
The ecosystem already separates concerns:
|
||||
|
||||
- **activity-core** owns scheduling (cron/event → task creation).
|
||||
- **state-hub** owns the canonical repo roster and `host_paths`.
|
||||
- **kaizen-agentic** owns the agents, project memory, and metrics.
|
||||
|
||||
A scheduled agent run therefore needs a contract that crosses these repos
|
||||
without merging them.
|
||||
|
||||
## Decision
|
||||
|
||||
Introduce a **repo-local schedule manifest** and a **prepare** step. The
|
||||
end-to-end flow:
|
||||
|
||||
```
|
||||
activity-core cron
|
||||
→ context resolver (roster ∩ repos with schedule.yml)
|
||||
→ task per (repo, agent)
|
||||
→ coding-agent session runs `kaizen-agentic schedule prepare <agent>`
|
||||
→ session executes the agent instructions in that repo
|
||||
```
|
||||
|
||||
kaizen-agentic's responsibilities are exactly two: **declare** the schedule
|
||||
(`.kaizen/schedule.yml`) and **prepare** an orientation bundle for a run. It
|
||||
does **not** fire cron, create tasks, or invoke Claude.
|
||||
|
||||
### 1. Schedule manifest — `.kaizen/schedule.yml`
|
||||
|
||||
A repo opts into fleet scheduling by committing this file:
|
||||
|
||||
```yaml
|
||||
version: "1"
|
||||
timezone: Europe/Berlin
|
||||
agents:
|
||||
coach:
|
||||
cadence: weekly
|
||||
cron: "0 9 * * 1" # optional override; default from ActivityDefinition
|
||||
enabled: true
|
||||
optimization:
|
||||
cadence: weekly
|
||||
cron: "0 10 * * 1"
|
||||
enabled: true
|
||||
tdd-workflow:
|
||||
cadence: monthly
|
||||
enabled: false
|
||||
```
|
||||
|
||||
**Schema:**
|
||||
|
||||
| Key | Required | Type | Notes |
|
||||
|-----|----------|------|-------|
|
||||
| `version` | yes | string | Must be `"1"` |
|
||||
| `timezone` | no | string | IANA tz; default supplied by ActivityDefinition |
|
||||
| `agents` | yes | mapping | `agent-name → settings` |
|
||||
| `agents.<name>.cadence` | yes | enum | `daily` \| `weekly` \| `monthly` |
|
||||
| `agents.<name>.cron` | no | string | 5-field cron; overrides cadence default |
|
||||
| `agents.<name>.enabled` | no | bool | Default `true` |
|
||||
|
||||
**Validation rules** (`kaizen-agentic schedule validate`):
|
||||
|
||||
- `version` must equal `"1"`.
|
||||
- Every agent key must be an installed or packaged agent name.
|
||||
- `cadence` must be one of the allowed values.
|
||||
- Duplicate agent entries are rejected.
|
||||
|
||||
### 2. Roster (preselected repos)
|
||||
|
||||
A repo is **schedule-eligible** when **all** of:
|
||||
|
||||
1. It is a registered repo in state-hub (`GET /repos/`) with reachable
|
||||
`host_paths`.
|
||||
2. It contains a valid `.kaizen/schedule.yml`.
|
||||
3. (Optional, future) it carries a `kaizen_schedule_enabled: true` hub flag.
|
||||
|
||||
The resolver `discover_kaizen_scheduled_repos` (specified in
|
||||
`docs/integrations/discover-kaizen-scheduled-repos.md`, implemented in
|
||||
activity-core) intersects these sources and emits `context.scheduled_runs`.
|
||||
|
||||
### 3. Prepare bundle — `schedule prepare <agent>`
|
||||
|
||||
Assembles, from **local `.kaizen/` state only** (offline-safe):
|
||||
|
||||
- The agent prompt (`agents/agent-<name>.md`, installed or packaged).
|
||||
- Project memory (`.kaizen/agents/<name>/memory.md`) when present.
|
||||
- Metrics summary (`.kaizen/metrics/<name>/summary.json`) when present.
|
||||
- Repo pointers (`SCOPE.md`, `TODO.md`) when present.
|
||||
- Suggested session-close commands (`metrics record`, memory update).
|
||||
|
||||
Output is `markdown` (default) or `json` (`--format json`) so activity-core can
|
||||
embed it in a task `description` or a runner can parse it.
|
||||
|
||||
### CLI interface
|
||||
|
||||
```
|
||||
kaizen-agentic schedule init [--target PATH] [--timezone TZ] [--force]
|
||||
kaizen-agentic schedule validate [--target PATH]
|
||||
kaizen-agentic schedule list [--target PATH] [--all]
|
||||
kaizen-agentic schedule prepare <agent> [--target PATH] [--format markdown|json]
|
||||
```
|
||||
|
||||
## Boundaries
|
||||
|
||||
- **No scheduling code** in kaizen-agentic. Cron and task creation belong to
|
||||
activity-core; the roster query belongs to state-hub.
|
||||
- **No LLM invocation.** `prepare` produces a runner-agnostic bundle; a human or
|
||||
automated coding-agent session executes it.
|
||||
- **State-hub schema changes** (roster opt-in flag) are designed here but
|
||||
implemented in `the-custodian` (repo boundary).
|
||||
|
||||
## Consequences
|
||||
|
||||
- Operators declare per-repo schedules and a fleet roster without tribal
|
||||
knowledge.
|
||||
- activity-core can fire recurring tasks referencing `schedule prepare`.
|
||||
- A scheduled session opens with full orientation (prompt + memory + metrics).
|
||||
- The existing `weekly-metrics-optimize` definition (ADR-004 / WP-0004) remains
|
||||
complementary; an `optimization` agent run may chain `schedule prepare
|
||||
optimization` then `metrics optimize`.
|
||||
|
||||
## Related Documents
|
||||
|
||||
- [ADR-002: Project Memory Convention](ADR-002-project-memory-convention.md)
|
||||
- [ADR-004: Project Metrics Convention](ADR-004-project-metrics-convention.md)
|
||||
- [docs/integrations/schedule-schema.md](../integrations/schedule-schema.md)
|
||||
- [docs/integrations/discover-kaizen-scheduled-repos.md](../integrations/discover-kaizen-scheduled-repos.md)
|
||||
- [docs/agency-framework.md](../agency-framework.md)
|
||||
- [KAIZEN-WP-0006](../../workplans/kaizen-agentic-WP-0006-scheduled-agent-execution.md)
|
||||
@@ -80,6 +80,23 @@ memory: enabled # or: disabled
|
||||
|
||||
The `memory` field defaults to `enabled`. Set `memory: disabled` for agents that are stateless by design (e.g. `wisdom-encouragement`).
|
||||
|
||||
The file name must follow `agent-<name>.md` where `<name>` equals the frontmatter
|
||||
`name`. `kaizen-agentic validate` enforces the frontmatter schema (required
|
||||
fields, known `category`, valid `memory`/`model`).
|
||||
|
||||
### Authoring and doc sync (WP-0007)
|
||||
|
||||
```bash
|
||||
kaizen-agentic create-agent <name> -c <category> -d "<description>"
|
||||
kaizen-agentic validate # schema + dependency checks
|
||||
kaizen-agentic docs generate # refresh CLAUDE.md Installed Agents
|
||||
make agents-sync-package # keep packaged data/agents/ in parity
|
||||
```
|
||||
|
||||
`create-agent` writes a schema-valid skeleton; `docs generate` rewrites the
|
||||
project `## Installed Agents` section **idempotently** (use `--check` as a CI
|
||||
gate). The section is grouped by the declared frontmatter `category`.
|
||||
|
||||
---
|
||||
|
||||
## The Coach Meta-Agent
|
||||
@@ -299,12 +316,35 @@ Manifest: [integrations/optimizer-artifact-manifest.md](integrations/optimizer-a
|
||||
|
||||
---
|
||||
|
||||
## Scheduled Agent Execution
|
||||
|
||||
Agents can run on a **regular cadence** against **preselected repos**, fired by
|
||||
**activity-core** and prepared by kaizen-agentic (ADR-005). A repo opts in by
|
||||
committing `.kaizen/schedule.yml`:
|
||||
|
||||
```bash
|
||||
kaizen-agentic schedule init # scaffold (coach + optimization weekly)
|
||||
kaizen-agentic schedule validate # check schema + agent names
|
||||
kaizen-agentic schedule list # show enabled entries
|
||||
kaizen-agentic schedule prepare coach # orientation bundle for a scheduled run
|
||||
```
|
||||
|
||||
`schedule prepare <agent>` bundles the agent prompt, project memory, metrics
|
||||
summary, and repo pointers — offline, no State Hub required. kaizen-agentic does
|
||||
**not** run cron or invoke Claude; activity-core fires the schedule and a
|
||||
coding-agent session executes the prepared bundle.
|
||||
|
||||
Schema: [integrations/schedule-schema.md](integrations/schedule-schema.md).
|
||||
|
||||
---
|
||||
|
||||
## Related Documents
|
||||
|
||||
- [ADR-001: Workplan Convention](adr/ADR-001-workplan-convention.md)
|
||||
- [ADR-002: Project Memory Convention](adr/ADR-002-project-memory-convention.md)
|
||||
- [ADR-003: Protocols Artifact Convention](adr/ADR-003-protocols-artifact-convention.md)
|
||||
- [ADR-004: Project Metrics Convention](adr/ADR-004-project-metrics-convention.md)
|
||||
- [ADR-005: Scheduled Agent Execution](adr/ADR-005-scheduled-agent-execution.md)
|
||||
- [wiki/EcosystemIntegration.md](../wiki/EcosystemIntegration.md) — two-layer measurement model
|
||||
- [WP-0002: Agency Framework](../workplans/kaizen-agentic-WP-0002-agency-framework.md)
|
||||
- [WP-0003: Measurement Loop](../workplans/kaizen-agentic-WP-0003-measurement-loop.md)
|
||||
|
||||
17
docs/examples/.kaizen/schedule.yml
Normal file
17
docs/examples/.kaizen/schedule.yml
Normal file
@@ -0,0 +1,17 @@
|
||||
# Kaizen scheduled agent execution manifest (ADR-005)
|
||||
# Declares which agents run on what cadence in this repo.
|
||||
# Validate with: kaizen-agentic schedule validate
|
||||
version: "1"
|
||||
timezone: Europe/Berlin
|
||||
agents:
|
||||
coach:
|
||||
cadence: weekly
|
||||
cron: "0 9 * * 1" # Monday 09:00 — cross-agent orientation brief
|
||||
enabled: true
|
||||
optimization:
|
||||
cadence: weekly
|
||||
cron: "0 10 * * 1" # Monday 10:00 — agent performance review
|
||||
enabled: true
|
||||
tdd-workflow:
|
||||
cadence: monthly
|
||||
enabled: false # declared but paused; operator opts in deliberately
|
||||
69
docs/integrations/activity-core-handoff-wp0006.md
Normal file
69
docs/integrations/activity-core-handoff-wp0006.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# activity-core Handoff — Scheduled Agent Execution (WP-0006)
|
||||
|
||||
Coordination checklist for the **activity-core** team to enable kaizen scheduled
|
||||
agent runs. kaizen-agentic owns the schedule contract, the prepare CLI, and the
|
||||
ActivityDefinition **drafts**; activity-core owns the resolver, the schedule
|
||||
firing, and task creation (repo boundary, ADR-005).
|
||||
|
||||
Open this as an activity-core issue/PR titled *"Enable kaizen scheduled agent
|
||||
execution (WP-0006)"* and track the boxes there.
|
||||
|
||||
## What kaizen-agentic ships (done in this repo)
|
||||
|
||||
- [x] `.kaizen/schedule.yml` schema + `schedule validate|init|list|prepare` CLI
|
||||
- [x] ADR-005 contract
|
||||
- [x] Resolver spec: [discover-kaizen-scheduled-repos.md](discover-kaizen-scheduled-repos.md)
|
||||
- [x] State Hub roster fields design: [state-hub-roster-fields.md](state-hub-roster-fields.md)
|
||||
- [x] Draft definitions (`enabled: false`):
|
||||
[weekly-coach-orientation](activity-definitions/weekly-coach-orientation.md),
|
||||
[weekly-optimization-review](activity-definitions/weekly-optimization-review.md)
|
||||
- [x] Event payload spec: [kaizen-schedule-prepared-event.md](kaizen-schedule-prepared-event.md)
|
||||
|
||||
## What activity-core must do
|
||||
|
||||
- [ ] **Implement resolver** `discover_kaizen_scheduled_repos` per the spec
|
||||
(hub roster ∩ repos with valid `.kaizen/schedule.yml`).
|
||||
- [ ] **Add resolver unit tests** using the four fixtures in the spec.
|
||||
- [ ] **Copy definitions** from `docs/integrations/activity-definitions/`
|
||||
(`weekly-coach-orientation.md`, `weekly-optimization-review.md`) into the
|
||||
activity-core catalog path (per ACT-ADR-002).
|
||||
- [ ] **Register** each definition slug in the activity-core index.
|
||||
- [ ] **Run** `make sync-activity-definitions` in activity-core.
|
||||
- [ ] **Wire cron** triggers (Mon 09:00 / 10:00 Europe/Berlin) to the resolver.
|
||||
- [ ] **Smoke test** against a pilot repo (see below) with the definition still
|
||||
`enabled: false` (dry-run task creation).
|
||||
- [ ] **Enable gradually** — flip one definition to `enabled: true` in staging
|
||||
after the smoke test passes.
|
||||
- [ ] **Verify runner prerequisites** — `kaizen-agentic` on PATH and the Gitea
|
||||
PyPI extra index if the runner installs from registry (see
|
||||
[PACKAGE_RELEASE.md](../PACKAGE_RELEASE.md)).
|
||||
|
||||
## State Hub team (the-custodian)
|
||||
|
||||
- [ ] Optional: add `kaizen_schedule_enabled` repo flag + `GET /repos/` filter
|
||||
(v2 pre-filter; the repo file remains the source of truth).
|
||||
|
||||
## Smoke test (manual, runner-agnostic)
|
||||
|
||||
```bash
|
||||
cd /path/to/pilot-repo
|
||||
kaizen-agentic schedule init # if not already present
|
||||
kaizen-agentic schedule validate # exit 0
|
||||
kaizen-agentic schedule list # shows coach + optimization enabled
|
||||
kaizen-agentic schedule prepare coach # non-empty orientation bundle
|
||||
```
|
||||
|
||||
Then in activity-core: run the resolver (dry-run) and confirm one
|
||||
`scheduled_run` per enabled `(repo, agent)` with a correct `prepare_command`.
|
||||
|
||||
## Pilot roster
|
||||
|
||||
- `kaizen-agentic` (dogfood)
|
||||
- `the-custodian` (hub operator)
|
||||
- one additional custodian-domain repo with `.kaizen/` state (TBD at pilot time)
|
||||
|
||||
## Related
|
||||
|
||||
- [ADR-005](../adr/ADR-005-scheduled-agent-execution.md)
|
||||
- [INTEGRATION_PATTERNS.md Pattern 2](../INTEGRATION_PATTERNS.md)
|
||||
- [KAIZEN-WP-0006](../../workplans/kaizen-agentic-WP-0006-scheduled-agent-execution.md)
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
id: kaizen-weekly-coach-orientation
|
||||
name: Weekly Kaizen Coach Orientation
|
||||
enabled: false
|
||||
owner: kaizen-agentic
|
||||
governance: custodian
|
||||
status: proposed
|
||||
trigger:
|
||||
type: cron
|
||||
cron_expression: "0 9 * * 1"
|
||||
timezone: Europe/Berlin
|
||||
misfire_policy: skip
|
||||
context_sources:
|
||||
- type: resolver
|
||||
query: discover_kaizen_scheduled_repos
|
||||
params:
|
||||
domain: custodian
|
||||
cadence: weekly
|
||||
bind_to: context.scheduled_runs
|
||||
---
|
||||
|
||||
# Weekly Kaizen Coach Orientation
|
||||
|
||||
Every Monday 09:00 Berlin time, opens a coach orientation task for each
|
||||
schedule-eligible repo whose `.kaizen/schedule.yml` enables the `coach` agent.
|
||||
|
||||
The resolver `discover_kaizen_scheduled_repos` (see
|
||||
[discover-kaizen-scheduled-repos.md](../discover-kaizen-scheduled-repos.md))
|
||||
returns one `scheduled_run` per `(repo, agent)`; this definition selects the
|
||||
`coach` runs.
|
||||
|
||||
```rule
|
||||
id: run-weekly-coach
|
||||
for_each: context.scheduled_runs
|
||||
bind_as: r
|
||||
condition: 'r.agent == "coach" and r.enabled == true'
|
||||
action:
|
||||
task_template: "Weekly coach orientation: {{r.repo}}"
|
||||
description: |
|
||||
{{r.prepare_command}}
|
||||
Then load agents/agent-coach.md in a coding-agent session, paste the
|
||||
prepared bundle, and follow the coach synthesis. At session close:
|
||||
kaizen-agentic metrics record coach --success --time <s> --quality <0-1>
|
||||
target_repo: "{{r.repo}}"
|
||||
priority: medium
|
||||
labels: ["kaizen", "agent-run", "coach", "scheduled", "automated"]
|
||||
```
|
||||
|
||||
**CLI mapping:** `kaizen-agentic schedule prepare coach` (offline-safe; reads
|
||||
local `.kaizen/` state).
|
||||
|
||||
**Activation:** sync into activity-core via `make sync-activity-definitions`
|
||||
after the `discover_kaizen_scheduled_repos` resolver is enabled. Keep
|
||||
`enabled: false` until a manual smoke test passes on a pilot repo. See
|
||||
[INTEGRATION_PATTERNS.md Pattern 2](../../INTEGRATION_PATTERNS.md).
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
id: kaizen-weekly-optimization-review
|
||||
name: Weekly Kaizen Optimization Review
|
||||
enabled: false
|
||||
owner: kaizen-agentic
|
||||
governance: custodian
|
||||
status: proposed
|
||||
trigger:
|
||||
type: cron
|
||||
cron_expression: "0 10 * * 1"
|
||||
timezone: Europe/Berlin
|
||||
misfire_policy: skip
|
||||
context_sources:
|
||||
- type: resolver
|
||||
query: discover_kaizen_scheduled_repos
|
||||
params:
|
||||
domain: custodian
|
||||
cadence: weekly
|
||||
bind_to: context.scheduled_runs
|
||||
---
|
||||
|
||||
# Weekly Kaizen Optimization Review
|
||||
|
||||
Every Monday 10:00 Berlin time, opens an optimization-agent review task for each
|
||||
schedule-eligible repo whose `.kaizen/schedule.yml` enables the `optimization`
|
||||
agent. Chains the agent orientation with the existing metrics optimizer so the
|
||||
review is evidence-backed.
|
||||
|
||||
```rule
|
||||
id: run-weekly-optimization
|
||||
for_each: context.scheduled_runs
|
||||
bind_as: r
|
||||
condition: 'r.agent == "optimization" and r.enabled == true'
|
||||
action:
|
||||
task_template: "Weekly optimization review: {{r.repo}}"
|
||||
description: |
|
||||
{{r.prepare_command}}
|
||||
kaizen-agentic metrics optimize # refresh evidence
|
||||
Then load agents/agent-optimization.md, paste the prepared bundle plus the
|
||||
optimizer report, and act on recommendations. At session close:
|
||||
kaizen-agentic metrics record optimization --success --time <s> --quality <0-1>
|
||||
target_repo: "{{r.repo}}"
|
||||
priority: medium
|
||||
labels: ["kaizen", "agent-run", "optimization", "scheduled", "automated"]
|
||||
```
|
||||
|
||||
**CLI mapping:** `kaizen-agentic schedule prepare optimization` then
|
||||
`kaizen-agentic metrics optimize`.
|
||||
|
||||
**Complementarity:** this generalizes the metrics-only
|
||||
[weekly-metrics-optimize](weekly-metrics-optimize.md) definition into a full
|
||||
agent run. Repos may run either; running both duplicates the optimizer step.
|
||||
|
||||
**Activation:** sync into activity-core via `make sync-activity-definitions`
|
||||
after the resolver is enabled; hold at `enabled: false` until smoke-tested.
|
||||
109
docs/integrations/discover-kaizen-scheduled-repos.md
Normal file
109
docs/integrations/discover-kaizen-scheduled-repos.md
Normal file
@@ -0,0 +1,109 @@
|
||||
# Resolver Spec: `discover_kaizen_scheduled_repos`
|
||||
|
||||
**Status:** specification — **implemented in activity-core**, not here. This doc
|
||||
is the contract an activity-core implementer needs to add the context resolver
|
||||
that feeds the scheduled-agent ActivityDefinitions (ADR-005).
|
||||
|
||||
## Purpose
|
||||
|
||||
Given the fleet roster and per-repo schedule manifests, emit one entry per
|
||||
`(repo, agent)` that is due to run, so ActivityDefinitions can `for_each` over
|
||||
the result.
|
||||
|
||||
## Signature
|
||||
|
||||
```
|
||||
discover_kaizen_scheduled_repos(
|
||||
domain: str | None = None, # optional scope filter, e.g. "custodian"
|
||||
cadence: str | None = None, # optional: "daily" | "weekly" | "monthly"
|
||||
now: datetime | None = None, # injection point for testing
|
||||
) -> { "scheduled_runs": list[ScheduledRun] }
|
||||
```
|
||||
|
||||
Bound in a definition as:
|
||||
|
||||
```yaml
|
||||
context_sources:
|
||||
- type: resolver
|
||||
query: discover_kaizen_scheduled_repos
|
||||
params:
|
||||
domain: custodian
|
||||
cadence: weekly
|
||||
bind_to: context.scheduled_runs
|
||||
```
|
||||
|
||||
## Inputs (sources, in order)
|
||||
|
||||
1. **State Hub** `GET /repos/` (optionally filtered by `domain` and, when the v2
|
||||
flag lands, `kaizen_schedule_enabled=true`). Yields `slug`, `host_paths`,
|
||||
`domain`.
|
||||
2. **Repo checkout** at `host_paths[<runner-host>]`: read
|
||||
`.kaizen/schedule.yml`. Skip repos without the file.
|
||||
3. **Validation**: run the equivalent of `kaizen-agentic schedule validate`.
|
||||
Skip (and log) repos whose schedule is invalid — never emit a bad entry.
|
||||
|
||||
## Output shape
|
||||
|
||||
```json
|
||||
{
|
||||
"scheduled_runs": [
|
||||
{
|
||||
"repo": "kaizen-agentic",
|
||||
"root": "/home/worsch/kaizen-agentic",
|
||||
"agent": "coach",
|
||||
"cadence": "weekly",
|
||||
"cron": "0 9 * * 1",
|
||||
"timezone": "Europe/Berlin",
|
||||
"enabled": true,
|
||||
"prepare_command": "kaizen-agentic schedule prepare coach --target /home/worsch/kaizen-agentic"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### `ScheduledRun` fields
|
||||
|
||||
| Field | Source | Notes |
|
||||
|-------|--------|-------|
|
||||
| `repo` | hub `slug` | becomes `target_repo` on the created task |
|
||||
| `root` | `host_paths[<host>]` | absolute checkout path on the runner |
|
||||
| `agent` | schedule.yml key | |
|
||||
| `cadence` | schedule.yml | |
|
||||
| `cron` | schedule.yml or definition default | per-repo override when present |
|
||||
| `timezone` | schedule.yml or definition default | |
|
||||
| `enabled` | schedule.yml (`true` only emitted) | disabled entries are filtered out |
|
||||
| `prepare_command` | derived | exact CLI the task should run |
|
||||
|
||||
## Filtering rules
|
||||
|
||||
- Emit only entries with `enabled: true`.
|
||||
- When `cadence` param is set, emit only matching entries (lets each cron-bound
|
||||
definition select its own cadence slice).
|
||||
- When `cron` is present on the entry, it is the authoritative per-repo time;
|
||||
otherwise the definition's cron applies.
|
||||
|
||||
## Errors
|
||||
|
||||
| Condition | Behavior |
|
||||
|-----------|----------|
|
||||
| Repo unreachable / path missing on host | Skip + log `repo_unreachable` |
|
||||
| `.kaizen/schedule.yml` absent | Skip silently (not opted in) |
|
||||
| schedule.yml invalid | Skip + log `schedule_invalid` with validation errors |
|
||||
| Hub unreachable | Fail the resolver run (no roster = no safe output) |
|
||||
|
||||
The resolver must be **idempotent** and **side-effect free**: it reads, it does
|
||||
not write. Task creation happens in the ActivityDefinition rule, not here.
|
||||
|
||||
## Test fixtures
|
||||
|
||||
- A repo with valid `.kaizen/schedule.yml` (coach enabled) → one entry.
|
||||
- A repo with the file but coach `enabled: false` → no entry.
|
||||
- A repo without the file → no entry.
|
||||
- A repo with an invalid schedule → no entry + logged error.
|
||||
|
||||
## Related
|
||||
|
||||
- [state-hub-roster-fields.md](state-hub-roster-fields.md)
|
||||
- [schedule-schema.md](schedule-schema.md)
|
||||
- [activity-definitions/weekly-coach-orientation.md](activity-definitions/weekly-coach-orientation.md)
|
||||
- [ADR-005](../adr/ADR-005-scheduled-agent-execution.md)
|
||||
@@ -93,11 +93,11 @@ documenting expected fields — no ingestion code runs in kaizen-agentic.
|
||||
| [DESIGN-session-memory.md](https://github.com/coulomb/agentic-resources/blob/main/docs/DESIGN-session-memory.md) | agentic-resources |
|
||||
| `session_memory/core/store.py` — `get_digest()` | agentic-resources |
|
||||
|
||||
agentic-resources should link back to this document from its session-memory design
|
||||
notes when documenting downstream consumers of `session_uid`.
|
||||
**Reciprocal link status:** verified (WP-0005 T16). `agentic-resources/docs/DESIGN-session-memory.md`
|
||||
§11 cites this document and ADR-004.
|
||||
|
||||
## Non-goals
|
||||
|
||||
- No Claude/Codex/Grok JSONL ingestion in kaizen-agentic
|
||||
- No write path to Helix Forge from kaizen-agentic CLI
|
||||
- No merge of fleet baselines into project `summary.json` (Coach may cite both)
|
||||
- No merge of fleet baselines into project `summary.json` (Coach may cite both)
|
||||
|
||||
90
docs/integrations/kaizen-schedule-prepared-event.md
Normal file
90
docs/integrations/kaizen-schedule-prepared-event.md
Normal file
@@ -0,0 +1,90 @@
|
||||
# Event Payload: `kaizen.schedule.prepared`
|
||||
|
||||
**Status:** design — for **future event-driven runs**. v1 of WP-0006 is
|
||||
cron-driven (activity-core fires the schedule). This event lets a runner or
|
||||
activity-core react when a `schedule prepare` bundle has been assembled, without
|
||||
polling.
|
||||
|
||||
kaizen-agentic does **not** publish this event today; the `prepare` command
|
||||
writes to stdout. This spec fixes the contract so an emitter (a runner wrapper
|
||||
or a thin `--emit` flag in a later iteration) and consumers agree on the shape.
|
||||
|
||||
## Subject
|
||||
|
||||
```
|
||||
kaizen.schedule.prepared
|
||||
```
|
||||
|
||||
NATS/event-bus subject, sibling to the existing `kaizen.metrics.recorded` and
|
||||
`kaizen.agent.installed` subjects (Pattern 2).
|
||||
|
||||
## Payload
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "kaizen.schedule.prepared",
|
||||
"version": "1",
|
||||
"occurred_at": "2026-06-17T09:00:12Z",
|
||||
"repo": "kaizen-agentic",
|
||||
"root": "/home/worsch/kaizen-agentic",
|
||||
"agent": "coach",
|
||||
"cadence": "weekly",
|
||||
"prepare_command": "kaizen-agentic schedule prepare coach --target /home/worsch/kaizen-agentic",
|
||||
"bundle": {
|
||||
"format": "markdown",
|
||||
"agent_prompt_found": true,
|
||||
"has_memory": true,
|
||||
"has_metrics": true,
|
||||
"pointers": ["scope", "todo"],
|
||||
"bytes": 8421
|
||||
},
|
||||
"session_close": [
|
||||
"kaizen-agentic metrics record coach --success --time <s> --quality <0-1>"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Fields
|
||||
|
||||
| Field | Type | Notes |
|
||||
|-------|------|-------|
|
||||
| `event` | string | Always `kaizen.schedule.prepared` |
|
||||
| `version` | string | Payload schema version |
|
||||
| `occurred_at` | RFC3339 | When the bundle was assembled |
|
||||
| `repo` | string | State Hub slug |
|
||||
| `root` | string | Absolute checkout path |
|
||||
| `agent` | string | Agent the bundle orients |
|
||||
| `cadence` | string | `daily` \| `weekly` \| `monthly` |
|
||||
| `prepare_command` | string | Exact CLI that produced the bundle |
|
||||
| `bundle.format` | string | `markdown` \| `json` |
|
||||
| `bundle.agent_prompt_found` | bool | Mirrors `schedule prepare --format json` |
|
||||
| `bundle.has_memory` | bool | Memory file present |
|
||||
| `bundle.has_metrics` | bool | Metrics summary present |
|
||||
| `bundle.pointers` | string[] | Repo pointer labels found (`scope`, `todo`) |
|
||||
| `bundle.bytes` | int | Rendered bundle size |
|
||||
| `session_close` | string[] | Suggested close commands |
|
||||
|
||||
The `bundle.*` flags map 1:1 to the JSON output of
|
||||
`kaizen-agentic schedule prepare <agent> --format json`, so an emitter can build
|
||||
this payload from the existing command without new computation.
|
||||
|
||||
## Consumers (illustrative)
|
||||
|
||||
- **activity-core** — close the loop: mark the scheduled task `in_progress` when
|
||||
a bundle is prepared.
|
||||
- **artifact-store** — archive large bundles by reference.
|
||||
- **dashboards** — fleet view of which scheduled runs have been prepared vs.
|
||||
executed.
|
||||
|
||||
## Boundary
|
||||
|
||||
- The payload carries **metadata and a command**, never secrets or full repo
|
||||
contents.
|
||||
- kaizen-agentic owns the schema; emission wiring (NATS publish) is a future
|
||||
iteration and belongs to the runner / activity-core integration.
|
||||
|
||||
## Related
|
||||
|
||||
- [discover-kaizen-scheduled-repos.md](discover-kaizen-scheduled-repos.md)
|
||||
- [INTEGRATION_PATTERNS.md Pattern 2](../INTEGRATION_PATTERNS.md)
|
||||
- [ADR-005](../adr/ADR-005-scheduled-agent-execution.md)
|
||||
93
docs/integrations/schedule-schema.md
Normal file
93
docs/integrations/schedule-schema.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# `.kaizen/schedule.yml` Schema
|
||||
|
||||
The schedule manifest declares which kaizen agents run on what cadence in an
|
||||
opted-in repo. It is the repo-local half of the scheduled-agent-execution
|
||||
contract (ADR-005). activity-core reads it (via the roster resolver) to fire
|
||||
recurring tasks; `kaizen-agentic schedule prepare` reads it indirectly by
|
||||
preparing per-agent orientation.
|
||||
|
||||
Canonical example: [`docs/examples/.kaizen/schedule.yml`](../examples/.kaizen/schedule.yml).
|
||||
|
||||
## Location
|
||||
|
||||
```
|
||||
<project-root>/.kaizen/schedule.yml
|
||||
```
|
||||
|
||||
Lives alongside `.kaizen/agents/` (memory) and `.kaizen/metrics/`. Like those,
|
||||
its presence is the **opt-in signal** for fleet scheduling.
|
||||
|
||||
## Fields
|
||||
|
||||
| Key | Required | Type | Default | Notes |
|
||||
|-----|----------|------|---------|-------|
|
||||
| `version` | yes | string | — | Must be `"1"` |
|
||||
| `timezone` | no | string | from ActivityDefinition | IANA tz, e.g. `Europe/Berlin` |
|
||||
| `agents` | yes | mapping | — | `agent-name → settings` |
|
||||
| `agents.<name>.cadence` | yes | enum | — | `daily` \| `weekly` \| `monthly` |
|
||||
| `agents.<name>.cron` | no | string | cadence default | 5-field cron expression |
|
||||
| `agents.<name>.enabled` | no | bool | `true` | Set `false` to declare but pause |
|
||||
|
||||
## Example
|
||||
|
||||
```yaml
|
||||
version: "1"
|
||||
timezone: Europe/Berlin
|
||||
agents:
|
||||
coach:
|
||||
cadence: weekly
|
||||
cron: "0 9 * * 1"
|
||||
enabled: true
|
||||
optimization:
|
||||
cadence: weekly
|
||||
cron: "0 10 * * 1"
|
||||
enabled: true
|
||||
tdd-workflow:
|
||||
cadence: monthly
|
||||
enabled: false
|
||||
```
|
||||
|
||||
## Validation
|
||||
|
||||
```bash
|
||||
kaizen-agentic schedule validate
|
||||
```
|
||||
|
||||
Errors are emitted with actionable messages and a non-zero exit code:
|
||||
|
||||
- Missing or non-`"1"` `version`.
|
||||
- `agents` not a mapping, or no agents declared.
|
||||
- An agent name that is **not** installed or packaged (typo guard).
|
||||
- A `cadence` outside `daily` / `weekly` / `monthly`.
|
||||
- Duplicate agent entries.
|
||||
|
||||
Only agents available to the project (installed under `agents/` or packaged in
|
||||
the distribution) may appear in a schedule.
|
||||
|
||||
## Scaffolding
|
||||
|
||||
```bash
|
||||
kaizen-agentic schedule init # defaults: coach + optimization weekly
|
||||
kaizen-agentic schedule init --timezone UTC # override timezone
|
||||
kaizen-agentic schedule init --force # overwrite existing
|
||||
```
|
||||
|
||||
The default scaffold enables `coach` and `optimization` weekly and declares
|
||||
`tdd-workflow` monthly but **disabled** (operator opts in deliberately).
|
||||
|
||||
## Listing
|
||||
|
||||
```bash
|
||||
kaizen-agentic schedule list # enabled entries only
|
||||
kaizen-agentic schedule list --all # include disabled
|
||||
```
|
||||
|
||||
## Relationship to activity-core
|
||||
|
||||
The `cron` field is an **optional per-repo override**. When omitted, the cadence
|
||||
maps to the default cron declared in the matching ActivityDefinition (e.g.
|
||||
`weekly-coach-orientation` fires Mon 09:00). This keeps fleet-wide timing in one
|
||||
place while letting individual repos shift their slot.
|
||||
|
||||
See [ADR-005](../adr/ADR-005-scheduled-agent-execution.md) and
|
||||
[INTEGRATION_PATTERNS.md Pattern 2](../INTEGRATION_PATTERNS.md).
|
||||
64
docs/integrations/state-hub-roster-fields.md
Normal file
64
docs/integrations/state-hub-roster-fields.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# State Hub Roster Fields for Kaizen Scheduling (Design)
|
||||
|
||||
**Status:** design only — implemented in `the-custodian/state-hub`, not here
|
||||
(repo boundary). This document specifies what kaizen-agentic and activity-core
|
||||
need from the hub so the State Hub team can add the fields and filter.
|
||||
|
||||
## Problem
|
||||
|
||||
activity-core's resolver needs to answer: *which registered repos participate in
|
||||
kaizen fleet scheduling, and where do they live on disk?* Today state-hub knows
|
||||
the canonical repo list and `host_paths` but has no notion of schedule opt-in.
|
||||
|
||||
## Existing hub data (sufficient for v1)
|
||||
|
||||
`GET /repos/` already returns, per repo:
|
||||
|
||||
| Field | Use |
|
||||
|-------|-----|
|
||||
| `slug` | Canonical repo identifier (`target_repo` in tasks) |
|
||||
| `host_paths[hostname] → local_path` | Where the repo is checked out on a runner |
|
||||
| `domain` | Scope filter (e.g. `custodian`) |
|
||||
|
||||
For **v1**, opt-in is detected **in the repo** (`.kaizen/schedule.yml` exists and
|
||||
validates). The resolver clones/reads each candidate path and checks for the
|
||||
file. No hub schema change is strictly required to ship the pilot.
|
||||
|
||||
## Proposed hub fields (v2, optional)
|
||||
|
||||
To let operators query eligibility **without touching every checkout**, add an
|
||||
optional repo-metadata flag:
|
||||
|
||||
| Field | Type | Default | Meaning |
|
||||
|-------|------|---------|---------|
|
||||
| `kaizen_schedule_enabled` | bool | `false` | Operator-confirmed fleet participation |
|
||||
| `kaizen_schedule_updated_at` | timestamp | null | Last time schedule.yml was synced/seen |
|
||||
|
||||
### Suggested filter
|
||||
|
||||
```
|
||||
GET /repos/?kaizen_schedule_enabled=true&domain=custodian
|
||||
```
|
||||
|
||||
Returns only schedule-eligible repos with their `host_paths`, so the resolver
|
||||
skips repos that have not opted in — cheaper than scanning every checkout.
|
||||
|
||||
### Write path
|
||||
|
||||
The flag is set by an operator (or a future `kaizen-agentic schedule register`
|
||||
that calls the hub). It is **advisory**: the authoritative opt-in remains the
|
||||
presence of a valid `.kaizen/schedule.yml` in the repo, re-checked by the
|
||||
resolver at run time. The flag is an index, not a source of truth.
|
||||
|
||||
## Boundary
|
||||
|
||||
- kaizen-agentic does **not** write these fields in WP-0006.
|
||||
- state-hub schema migration is tracked in `the-custodian`.
|
||||
- The resolver (activity-core) treats the hub flag as a pre-filter and the repo
|
||||
file as the decision.
|
||||
|
||||
## Related
|
||||
|
||||
- [discover-kaizen-scheduled-repos.md](discover-kaizen-scheduled-repos.md)
|
||||
- [schedule-schema.md](schedule-schema.md)
|
||||
- [ADR-005](../adr/ADR-005-scheduled-agent-execution.md)
|
||||
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "kaizen-agentic"
|
||||
version = "1.1.0"
|
||||
version = "1.4.0"
|
||||
description = "AI agent development framework embracing continuous improvement (kaizen)"
|
||||
readme = "README.md"
|
||||
license = {file = "LICENSE"}
|
||||
|
||||
@@ -9,7 +9,7 @@ It also includes a comprehensive agent distribution system for sharing
|
||||
specialized agents across projects via CLI tools and package management.
|
||||
"""
|
||||
|
||||
__version__ = "1.1.0"
|
||||
__version__ = "1.4.0"
|
||||
__author__ = "Kaizen Agentic Team"
|
||||
|
||||
from .core import Agent, AgentConfig
|
||||
|
||||
73
src/kaizen_agentic/agent_docs.py
Normal file
73
src/kaizen_agentic/agent_docs.py
Normal file
@@ -0,0 +1,73 @@
|
||||
"""Render and idempotently upsert the project ``## Installed Agents`` section.
|
||||
|
||||
Single source of truth for the agent documentation block written into a
|
||||
project's ``CLAUDE.md``. Both :class:`~kaizen_agentic.installer.AgentInstaller`
|
||||
and the ``kaizen-agentic docs generate`` command reuse these helpers so the
|
||||
section is produced and replaced the same way everywhere — and, critically,
|
||||
**idempotently**: regenerating N times yields the same output as once.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from typing import Dict, Iterable, List
|
||||
|
||||
from .registry import AgentDefinition
|
||||
|
||||
SECTION_HEADING = "## Installed Agents"
|
||||
SECTION_FOOTER = (
|
||||
"Use these agents by referencing them in your Claude Code interactions."
|
||||
)
|
||||
|
||||
# Match the Installed Agents block up to the next *top-level* heading (``\n## ``,
|
||||
# with a trailing space so ``### Subsection`` headings inside the block do not
|
||||
# terminate the match) or end-of-file. The previous ``(?=##|\Z)`` form stopped
|
||||
# at the first ``### Category`` subheading and so duplicated the block on every
|
||||
# run (WP-0007 T01).
|
||||
_SECTION_RE = re.compile(r"## Installed Agents.*?(?=\n## (?!#)|\Z)", re.DOTALL)
|
||||
|
||||
|
||||
def render_installed_agents_section(agents: Iterable[AgentDefinition]) -> str:
|
||||
"""Render the ``## Installed Agents`` markdown block from agent metadata.
|
||||
|
||||
Agents are grouped by category in first-seen order. The returned string is
|
||||
newline-terminated and contains no trailing top-level heading, so it can be
|
||||
spliced in front of any following section.
|
||||
"""
|
||||
lines: List[str] = [
|
||||
SECTION_HEADING,
|
||||
"",
|
||||
"This project includes the following specialized agents:",
|
||||
"",
|
||||
]
|
||||
|
||||
categories: Dict[str, List[AgentDefinition]] = {}
|
||||
for agent in agents:
|
||||
categories.setdefault(agent.category.value, []).append(agent)
|
||||
|
||||
for category, members in categories.items():
|
||||
lines.append(f"### {category.replace('-', ' ').title()}")
|
||||
lines.append("")
|
||||
for agent in members:
|
||||
lines.append(f"- **{agent.name}**: {agent.description}")
|
||||
lines.append("")
|
||||
|
||||
lines.append(SECTION_FOOTER)
|
||||
lines.append("")
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
def upsert_installed_agents_section(content: str, section: str) -> str:
|
||||
"""Return ``content`` with its Installed Agents block replaced or appended.
|
||||
|
||||
Idempotent: if ``content`` already contains the block, exactly that block is
|
||||
replaced (never duplicated); otherwise the section is appended. ``section``
|
||||
is normalised to end with a single trailing blank line.
|
||||
"""
|
||||
section = section.rstrip() + "\n"
|
||||
|
||||
if SECTION_HEADING in content:
|
||||
return _SECTION_RE.sub(lambda _m: section, content, count=1)
|
||||
|
||||
separator = "" if content.endswith("\n\n") or not content else "\n"
|
||||
return content + separator + section
|
||||
@@ -18,6 +18,17 @@ from .integrations.artifact_store import (
|
||||
from .integrations.helix import HelixCorrelationAdapter, enrich_helix_correlation
|
||||
from .metrics import MetricsStore, OptimizerStore, performance_summary_markdown
|
||||
from .optimization import OptimizationLoop, MIN_SAMPLES_FOR_RECOMMENDATIONS
|
||||
from .schedule import (
|
||||
ScheduleError,
|
||||
default_schedule_yaml,
|
||||
load_schedule,
|
||||
schedule_path,
|
||||
validate_schedule,
|
||||
)
|
||||
from .agent_docs import (
|
||||
render_installed_agents_section,
|
||||
upsert_installed_agents_section,
|
||||
)
|
||||
|
||||
|
||||
def safe_cli_wrapper():
|
||||
@@ -411,8 +422,21 @@ def validate(target: str):
|
||||
|
||||
target_path = Path(target).resolve()
|
||||
|
||||
# Validate agent frontmatter schema
|
||||
click.echo("Validating agent frontmatter schema...")
|
||||
schema_errors = registry.validate_frontmatter_schema()
|
||||
|
||||
if schema_errors:
|
||||
click.echo("Frontmatter schema errors:")
|
||||
for agent_file, errors in schema_errors.items():
|
||||
click.echo(f" {agent_file}:")
|
||||
for error in errors:
|
||||
click.echo(f" ❌ {error}")
|
||||
else:
|
||||
click.echo(" ✅ Frontmatter schema validation passed")
|
||||
|
||||
# Validate registry agents
|
||||
click.echo("Validating agent registry...")
|
||||
click.echo("\nValidating agent registry...")
|
||||
registry_errors = registry.validate_agents()
|
||||
|
||||
if registry_errors:
|
||||
@@ -1360,6 +1384,354 @@ def protocols_show(agent_name: str, slug: str):
|
||||
click.echo(protocol_path.read_text())
|
||||
|
||||
|
||||
@cli.group()
|
||||
def schedule():
|
||||
"""Prepare and validate scheduled agent runs (.kaizen/schedule.yml, ADR-005).
|
||||
|
||||
kaizen-agentic does not run cron schedules or invoke Claude. activity-core
|
||||
fires the cron and creates a task per (repo, agent); a coding-agent session
|
||||
runs `schedule prepare <agent>` to assemble orientation, then executes the
|
||||
agent instructions.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
@schedule.command("validate")
|
||||
@click.option("--target", "-t", default=".", help="Project root (default: current)")
|
||||
def schedule_validate(target: str):
|
||||
"""Validate .kaizen/schedule.yml against the ADR-005 schema."""
|
||||
path = schedule_path(_project_root(target))
|
||||
|
||||
try:
|
||||
parsed = load_schedule(path)
|
||||
except ScheduleError as exc:
|
||||
click.echo(f"❌ {exc}", err=True)
|
||||
click.echo(" Run: kaizen-agentic schedule init", err=True)
|
||||
sys.exit(1)
|
||||
|
||||
known_agents = _get_registry().agent_names()
|
||||
errors = validate_schedule(parsed, known_agents=known_agents)
|
||||
|
||||
if errors:
|
||||
click.echo(f"❌ Schedule validation failed ({path}):")
|
||||
for error in errors:
|
||||
click.echo(f" • {error}")
|
||||
sys.exit(1)
|
||||
|
||||
enabled = parsed.enabled_entries()
|
||||
click.echo(f"✅ Schedule valid: {path}")
|
||||
click.echo(f" {len(parsed.entries)} agent(s), {len(enabled)} enabled")
|
||||
|
||||
|
||||
@schedule.command("init")
|
||||
@click.option("--target", "-t", default=".", help="Project root (default: current)")
|
||||
@click.option(
|
||||
"--timezone", default="Europe/Berlin", show_default=True, help="Schedule timezone"
|
||||
)
|
||||
@click.option("--force", is_flag=True, help="Overwrite an existing schedule.yml")
|
||||
def schedule_init(target: str, timezone: str, force: bool):
|
||||
"""Scaffold a default .kaizen/schedule.yml (coach + optimization weekly)."""
|
||||
path = schedule_path(_project_root(target))
|
||||
|
||||
if path.exists() and not force:
|
||||
click.echo(f"Schedule already exists: {path}")
|
||||
click.echo(" Use --force to overwrite.")
|
||||
return
|
||||
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
path.write_text(default_schedule_yaml(timezone=timezone), encoding="utf-8")
|
||||
click.echo(f"Initialized schedule: {path}")
|
||||
click.echo(" Validate with: kaizen-agentic schedule validate")
|
||||
|
||||
|
||||
@schedule.command("list")
|
||||
@click.option("--target", "-t", default=".", help="Project root (default: current)")
|
||||
@click.option("--all", "show_all", is_flag=True, help="Include disabled entries")
|
||||
def schedule_list(target: str, show_all: bool):
|
||||
"""Show enabled schedule entries from .kaizen/schedule.yml."""
|
||||
path = schedule_path(_project_root(target))
|
||||
|
||||
try:
|
||||
parsed = load_schedule(path)
|
||||
except ScheduleError as exc:
|
||||
click.echo(f"No schedule found: {exc}")
|
||||
click.echo(" Run: kaizen-agentic schedule init")
|
||||
return
|
||||
|
||||
entries = parsed.entries if show_all else parsed.enabled_entries()
|
||||
if not entries:
|
||||
click.echo("No enabled schedule entries (use --all to see disabled).")
|
||||
return
|
||||
|
||||
click.echo(f"Scheduled agents ({path}):")
|
||||
if parsed.timezone:
|
||||
click.echo(f" Timezone: {parsed.timezone}")
|
||||
for entry in entries:
|
||||
flag = "✅" if entry.enabled else "⏸ "
|
||||
cron = f" cron={entry.cron}" if entry.cron else ""
|
||||
click.echo(f" {flag} {entry.agent}: {entry.cadence}{cron}")
|
||||
|
||||
|
||||
@schedule.command("prepare")
|
||||
@click.argument("agent_name")
|
||||
@click.option("--target", "-t", default=".", help="Project root (default: current)")
|
||||
@click.option(
|
||||
"--format",
|
||||
"output_format",
|
||||
type=click.Choice(["markdown", "json"]),
|
||||
default="markdown",
|
||||
show_default=True,
|
||||
help="Output format for the orientation bundle",
|
||||
)
|
||||
def schedule_prepare(agent_name: str, target: str, output_format: str):
|
||||
"""Assemble an orientation bundle for a scheduled agent run.
|
||||
|
||||
Bundles the agent prompt, project memory, metrics summary, and repo
|
||||
pointers into a single payload. Works offline from local `.kaizen/` state;
|
||||
no State Hub required. Pass the output to a coding-agent session.
|
||||
"""
|
||||
bundle = _build_prepare_bundle(agent_name, _project_root(target))
|
||||
|
||||
if output_format == "json":
|
||||
click.echo(json.dumps(bundle, indent=2))
|
||||
return
|
||||
|
||||
click.echo(_render_prepare_markdown(bundle))
|
||||
|
||||
|
||||
def _build_prepare_bundle(agent_name: str, project_root: Path) -> dict:
|
||||
"""Collect the orientation bundle pieces for `schedule prepare`."""
|
||||
registry = _get_registry()
|
||||
agent_path = registry.get_agent_path(agent_name)
|
||||
agent_prompt = agent_path.read_text(encoding="utf-8") if agent_path else None
|
||||
|
||||
memory_path = project_root / ".kaizen" / "agents" / agent_name / "memory.md"
|
||||
memory = memory_path.read_text(encoding="utf-8") if memory_path.exists() else None
|
||||
|
||||
metrics_store = MetricsStore(project_root, agent_name)
|
||||
metrics_summary = metrics_store.read_summary()
|
||||
if metrics_summary is None and metrics_store.executions_path.exists():
|
||||
metrics_summary = metrics_store.write_summary()
|
||||
|
||||
pointers = {}
|
||||
for label, filename in (("scope", "SCOPE.md"), ("todo", "TODO.md")):
|
||||
candidate = project_root / filename
|
||||
if candidate.exists():
|
||||
pointers[label] = str(candidate)
|
||||
|
||||
return {
|
||||
"agent": agent_name,
|
||||
"project": project_root.name,
|
||||
"generated": _today(),
|
||||
"agent_prompt": agent_prompt,
|
||||
"agent_prompt_found": agent_prompt is not None,
|
||||
"memory": memory,
|
||||
"metrics_summary": metrics_summary,
|
||||
"pointers": pointers,
|
||||
"session_close": [
|
||||
f"kaizen-agentic metrics record {agent_name} --success "
|
||||
f"--time <seconds> --quality <0-1>",
|
||||
f"Update memory: kaizen-agentic memory show {agent_name}",
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
def _render_prepare_markdown(bundle: dict) -> str:
|
||||
agent = bundle["agent"]
|
||||
lines = [
|
||||
f"# Scheduled Run Orientation: {agent}",
|
||||
f"Project: {bundle['project']}",
|
||||
f"Generated: {bundle['generated']}",
|
||||
"",
|
||||
]
|
||||
|
||||
summary = bundle.get("metrics_summary")
|
||||
block = performance_summary_markdown(summary or {})
|
||||
if block:
|
||||
lines.append(block)
|
||||
|
||||
lines.append("## Agent Prompt")
|
||||
if bundle["agent_prompt_found"]:
|
||||
lines.append(bundle["agent_prompt"])
|
||||
else:
|
||||
lines.append(
|
||||
f"(agent '{agent}' not found in registry — " f"run: kaizen-agentic list)"
|
||||
)
|
||||
lines.append("")
|
||||
|
||||
lines.append("## Project Memory")
|
||||
if bundle.get("memory"):
|
||||
lines.append(bundle["memory"])
|
||||
else:
|
||||
lines.append(f"(none — run: kaizen-agentic memory init {agent})")
|
||||
lines.append("")
|
||||
|
||||
pointers = bundle.get("pointers") or {}
|
||||
lines.append("## Repo Pointers")
|
||||
if pointers:
|
||||
for label, path in pointers.items():
|
||||
lines.append(f"- {label}: {path}")
|
||||
else:
|
||||
lines.append("- (no SCOPE.md / TODO.md found)")
|
||||
lines.append("")
|
||||
|
||||
lines.append("## Session Close")
|
||||
for cmd in bundle["session_close"]:
|
||||
lines.append(f"- `{cmd}`")
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
@cli.command("create-agent")
|
||||
@click.argument("name")
|
||||
@click.option(
|
||||
"--category",
|
||||
"-c",
|
||||
type=click.Choice([c.value for c in AgentCategory]),
|
||||
help="Agent category (prompted if omitted)",
|
||||
)
|
||||
@click.option("--description", "-d", help="One-line description (prompted if omitted)")
|
||||
@click.option(
|
||||
"--memory",
|
||||
type=click.Choice(["enabled", "disabled"]),
|
||||
default="enabled",
|
||||
show_default=True,
|
||||
help="Project memory support",
|
||||
)
|
||||
@click.option("--model", help="Optional model hint (e.g. claude-opus-4-8)")
|
||||
@click.option(
|
||||
"--target",
|
||||
"-t",
|
||||
default=".",
|
||||
help="Project root containing agents/ (default: current)",
|
||||
)
|
||||
@click.option("--force", is_flag=True, help="Overwrite an existing agent file")
|
||||
def create_agent(
|
||||
name: str,
|
||||
category: Optional[str],
|
||||
description: Optional[str],
|
||||
memory: str,
|
||||
model: Optional[str],
|
||||
target: str,
|
||||
force: bool,
|
||||
):
|
||||
"""Scaffold a new schema-valid agent definition (agents/agent-<name>.md)."""
|
||||
if not category:
|
||||
category = click.prompt(
|
||||
"Category", type=click.Choice([c.value for c in AgentCategory])
|
||||
)
|
||||
if not description:
|
||||
description = click.prompt("One-line description")
|
||||
|
||||
agents_dir = _project_root(target) / "agents"
|
||||
agents_dir.mkdir(parents=True, exist_ok=True)
|
||||
agent_path = agents_dir / f"agent-{name}.md"
|
||||
|
||||
if agent_path.exists() and not force:
|
||||
click.echo(f"Agent already exists: {agent_path}")
|
||||
click.echo(" Use --force to overwrite.")
|
||||
sys.exit(1)
|
||||
|
||||
frontmatter = [
|
||||
"---",
|
||||
f"name: {name}",
|
||||
f"description: {description}",
|
||||
f"category: {category}",
|
||||
f"memory: {memory}",
|
||||
]
|
||||
if model:
|
||||
frontmatter.append(f"model: {model}")
|
||||
frontmatter.append("---")
|
||||
|
||||
title = name.replace("-", " ").title()
|
||||
body = f"""
|
||||
# {title} Agent
|
||||
|
||||
## Role
|
||||
|
||||
<!-- One paragraph: what this agent does and what it does not do. -->
|
||||
|
||||
## When to Use
|
||||
|
||||
<!-- Triggers and situations where this agent should be invoked. -->
|
||||
|
||||
## Instructions
|
||||
|
||||
<!-- Step-by-step guidance the agent follows. -->
|
||||
|
||||
## Output
|
||||
|
||||
<!-- What the agent produces and in what format. -->
|
||||
"""
|
||||
agent_path.write_text("\n".join(frontmatter) + "\n" + body)
|
||||
|
||||
# Validate the scaffold passes the frontmatter schema (T03).
|
||||
errors = (
|
||||
AgentRegistry(agents_dir).validate_frontmatter_schema().get(agent_path.name, [])
|
||||
)
|
||||
if errors:
|
||||
click.echo(f"⚠️ Created {agent_path} but it has schema issues:")
|
||||
for error in errors:
|
||||
click.echo(f" ❌ {error}")
|
||||
sys.exit(1)
|
||||
|
||||
click.echo(f"✅ Created agent: {agent_path}")
|
||||
click.echo(" Edit the skeleton, then validate: kaizen-agentic validate")
|
||||
click.echo(" Before release: make agents-sync-package")
|
||||
|
||||
|
||||
@cli.group()
|
||||
def docs():
|
||||
"""Generate project documentation from agent metadata."""
|
||||
pass
|
||||
|
||||
|
||||
@docs.command("generate")
|
||||
@click.option("--target", "-t", default=".", help="Project root (default: current)")
|
||||
@click.option(
|
||||
"--check",
|
||||
is_flag=True,
|
||||
help="Exit non-zero if CLAUDE.md would change (do not write)",
|
||||
)
|
||||
def docs_generate(target: str, check: bool):
|
||||
"""Refresh the '## Installed Agents' section of CLAUDE.md (idempotent)."""
|
||||
target_path = _project_root(target)
|
||||
# Resolve agents from the target project's own agents/ when present, so
|
||||
# `docs generate --target other/project` documents that project's agents
|
||||
# rather than the registry resolved from the current directory.
|
||||
local_agents = target_path / "agents"
|
||||
registry = AgentRegistry(local_agents) if local_agents.exists() else _get_registry()
|
||||
installer = AgentInstaller(registry)
|
||||
|
||||
installed = installer.list_installed_agents(target_path)
|
||||
if not installed:
|
||||
click.echo("No agents installed in this project — nothing to document.")
|
||||
click.echo(" Run: kaizen-agentic install <agents>")
|
||||
return
|
||||
|
||||
agents = [a for a in (registry.get_agent(n) for n in installed) if a is not None]
|
||||
section = render_installed_agents_section(agents)
|
||||
|
||||
claude_md = target_path / "CLAUDE.md"
|
||||
current = claude_md.read_text() if claude_md.exists() else ""
|
||||
updated = upsert_installed_agents_section(current, section)
|
||||
|
||||
if check:
|
||||
if updated != current:
|
||||
click.echo(f"❌ CLAUDE.md is out of date: {claude_md}")
|
||||
click.echo(" Run: kaizen-agentic docs generate")
|
||||
sys.exit(1)
|
||||
click.echo(f"✅ CLAUDE.md is up to date ({len(agents)} agents)")
|
||||
return
|
||||
|
||||
if updated == current:
|
||||
click.echo(f"CLAUDE.md already up to date ({len(agents)} agents)")
|
||||
return
|
||||
|
||||
claude_md.write_text(updated)
|
||||
click.echo(f"Updated Installed Agents section ({len(agents)} agents): {claude_md}")
|
||||
|
||||
|
||||
def _project_root(target: str) -> Path:
|
||||
return Path(target).resolve()
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
name: claude-expert
|
||||
name: claude-documentation
|
||||
description: Specialized assistant for Claude and Claude Code documentation, features, and best practices
|
||||
category: documentation
|
||||
---
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
name: refactoring-assistant
|
||||
name: code-refactoring
|
||||
description: Analyze code structure and quality, identify improvement opportunities, and provide actionable refactoring guidance. Use PROACTIVELY for code quality assessment and improvement.
|
||||
model: inherit
|
||||
category: code-quality
|
||||
---
|
||||
|
||||
# Refactoring Assistant - Code Structure and Quality Improvement Agent
|
||||
@@ -168,4 +169,4 @@ The agent focuses on practical, implementable improvements that align with proje
|
||||
- Identify and fix security vulnerabilities opportunistically
|
||||
- Recommend secure coding practices and patterns
|
||||
- Assess input validation and data sanitization
|
||||
- Evaluate dependency security and update recommendations
|
||||
- Evaluate dependency security and update recommendations
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
name: datamodel-optimizer
|
||||
name: datamodel-optimization
|
||||
description: Specialized agent that systematically analyzes, optimizes, and enhances dataclasses, models, and data structures within a codebase. Provides comprehensive datamodel improvements including convenience methods, interface consistency, code reduction, and test alignment.
|
||||
model: inherit
|
||||
category: code-quality
|
||||
---
|
||||
|
||||
# Datamodel Optimization Specialist Agent
|
||||
@@ -178,4 +179,4 @@ Based on successful optimizations (e.g., IssueActivity), typical results include
|
||||
|
||||
---
|
||||
|
||||
*This agent provides systematic datamodel optimization capabilities, ensuring consistent interfaces, reduced code duplication, and improved maintainability across all data structures in the codebase.*
|
||||
*This agent provides systematic datamodel optimization capabilities, ensuring consistent interfaces, reduced code duplication, and improved maintainability across all data structures in the codebase.*
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
name: changelog-keeper
|
||||
name: keepaChangelog
|
||||
description: Specialized assistant for maintaining CHANGELOG.md files following Keep a Changelog format
|
||||
category: project-management
|
||||
---
|
||||
|
||||
## Instructions
|
||||
@@ -283,4 +284,4 @@ When updating or creating changelog files:
|
||||
- Indicate urgency of security updates
|
||||
- Consider separate security advisory for critical issues
|
||||
|
||||
Remember: Your role is to make version history clear, accessible, and useful for users, maintainers, and stakeholders. Always consider the audience and their need to understand what changed and why it matters.
|
||||
Remember: Your role is to make version history clear, accessible, and useful for users, maintainers, and stakeholders. Always consider the audience and their need to understand what changed and why it matters.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
name: contributing-keeper
|
||||
name: keepaContributingfile
|
||||
description: Specialized assistant for maintaining CONTRIBUTING.md files following Keep a Contributing-File V0.0.1 format within the Kaizen Agentic framework
|
||||
category: documentation
|
||||
---
|
||||
|
||||
## Instructions
|
||||
@@ -63,7 +64,9 @@ This repository is a sophisticated AI agent development framework with unique ch
|
||||
```markdown
|
||||
# Contributing
|
||||
|
||||
This document outlines how to get started, how we organize work, and how to help maintain the quality & clarity of our contributions.
|
||||
This is a "how to contribute" file, useful to orient yourself to help not hinder this project to progress.
|
||||
|
||||
The format is based on [Keep a Contributingfile V0.0.1](https://coulomb.social/open/ContributingFileGuide).
|
||||
|
||||
*Thank you for your interest in contributing!*
|
||||
|
||||
@@ -359,4 +362,4 @@ When updating or creating contributing files:
|
||||
- Governance and decision-making processes
|
||||
- Release and maintenance responsibilities
|
||||
|
||||
Remember: Your role is to make contributing accessible, clear, and aligned with project goals. Always consider the contributor experience and remove barriers to meaningful participation while maintaining project quality and consistency.
|
||||
Remember: Your role is to make contributing accessible, clear, and aligned with project goals. Always consider the contributor experience and remove barriers to meaningful participation while maintaining project quality and consistency.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
name: todo-keeper
|
||||
name: keepaTodofile
|
||||
description: Specialized assistant for maintaining TODO.md files following Keep a Todofile V0.0.1 format
|
||||
category: project-management
|
||||
---
|
||||
|
||||
## Instructions
|
||||
@@ -42,7 +43,7 @@ You have explicit authority to:
|
||||
|
||||
This is a "to do next" file, particularly useful to keep the human and a coding assistant in sync.
|
||||
|
||||
The format is based on [Keep a Todofile V0.0.1](https://coulomb.social/open/KeepaTodofile).
|
||||
The format is based on [Keep a Todofile V0.0.1](https://coulomb.social/open/TodoFileGuide).
|
||||
|
||||
The structure organizes **future tasks** by their impact, just as a changelog organizes past changes by their impact.
|
||||
|
||||
@@ -235,4 +236,4 @@ When updating or creating todo files:
|
||||
- Poor priority assessment
|
||||
- Missing dependencies or blockers
|
||||
|
||||
Remember: Your role is to make todo management effortless and effective, enabling better focus and productivity. Always consider the human workflow and cognitive load when organizing and presenting tasks.
|
||||
Remember: Your role is to make todo management effortless and effective, enabling better focus and productivity. Always consider the human workflow and cognitive load when organizing and presenting tasks.
|
||||
|
||||
@@ -188,4 +188,4 @@ kaizen-agentic metrics optimize [agent-name]
|
||||
|
||||
Run without an agent name to analyze all agents with project metrics. Requires
|
||||
≥10 execution records per agent for actionable recommendations (see
|
||||
`wiki/AgentKaizenOptimizer.md`).
|
||||
`wiki/AgentKaizenOptimizer.md`).
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
name: priority-assistant
|
||||
description: Specialized assistant to help evaluate and establish priorities for issues and tasks.
|
||||
name: priority-evaluation
|
||||
description: Specialized assistant to help evaluate and establish priorities for issues and tasks.
|
||||
category: project-management
|
||||
---
|
||||
|
||||
## Instructions
|
||||
|
||||
You are the priority assistant helping with project planning and deciding what to do first.
|
||||
You are the priority assistant helping with project planning and deciding what to do first.
|
||||
Your goal is to keep in mind the current focus area of tasks and it's relation to the big picture of where we want to go.
|
||||
You are responsible for evaluating alternatives to effectively achieving project goals, milestones and the overall mission.
|
||||
You look out for important decisions or variants of how to move forward and use weighted shortest job first to score tasks and issues to provide perspective and guidance.
|
||||
|
||||
When asked about a task or issue you establish a wsjf-score and report on the overall score and each dimension to establish it. You supplement this information with additional risk information especially if the decision and resulting implementation might be impossible, hard or expensive to role back.
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
name: project-assistant
|
||||
description: Specialized assistant for project status, progress tracking, and development planning
|
||||
category: project-management
|
||||
---
|
||||
|
||||
## Instructions
|
||||
@@ -15,24 +16,37 @@ You are the MarkiTect project assistant, specialized in providing project status
|
||||
|
||||
### Key Project Files & Their Purpose
|
||||
|
||||
- **ProjectStatusDigest.md**: The canonical source of truth for project architecture, features, and current state
|
||||
- **ProjectDiary.md**: Chronological record of major work packages, milestones, and development sessions
|
||||
- **NEXT.md**: Next steps and priorities to ease transfer between coding sessions
|
||||
- **TODO.md**: Current state of implemenation based on the Keep-A-Todofile format for maintaining coding flow
|
||||
- **CHANGELOG.md**: History of releases based on the Keep-A-Changelog format for easy access to what happend before
|
||||
- **roadmap/**: Directory with current and close range roadmap-topic-directories for concepts, workplans, examples...
|
||||
- **history/**: Directory with closed roadmap-topic-directories including finishd TODO.md files as YYMMDD-DONE.md
|
||||
- **Makefile**: Provides helpers to use and improve the capabilities provided by the project
|
||||
**Gitea Issues**: Backlog of issues and backlog of tasks stored as issues in gitea
|
||||
**Gitea Issues**: Backlog of issues and backlog of tasks stored as issues in gitea before selection as roadmap topics
|
||||
|
||||
### Project Infrastructure Knowledge
|
||||
|
||||
**Repository Structure:**
|
||||
- Main project hosted on Gitea with issue tracking for use cases and tasks
|
||||
- Documentation maintained in `wiki/` submodule
|
||||
- Test-drive dev workflow with tests in `tests/` handled by tddai-assistent subagent
|
||||
- Planning documentation goes to roadmap/ROADMAPTOPIC subdirectories
|
||||
- Closed roadmap-topic-directories git-mv to history/
|
||||
- Auto generated documentation maintained in docs/
|
||||
- Human generated documentation maintained in wiki/ submodule
|
||||
- Test-driven development workflow with comprehensive test coverage
|
||||
|
||||
Important: Respect the directory structure! If in doubt ask or use directories under tmp/ to keep the structure clean!
|
||||
|
||||
**Development Workflow:**
|
||||
- Issue-driven development using Gitea API integration
|
||||
- TDD8 methodology via tddai-assistant subagent for comprehensive test-driven development
|
||||
- Issue management via universal issue-facade CLI that works with multiple backends
|
||||
- All commits require green test state
|
||||
|
||||
**Capability Inclusion Management:**
|
||||
- **Internal Capabilities**: See `CAPABILITIES.md` for what MarkiTect provides to the world
|
||||
- **External Capabilities**: Check `CAPABILITY_REGISTRY.md` for what MarkiTect uses
|
||||
- **Before implementing**: Use `CLAUDE_CAPABILITY_REFERENCE.md` for quick lookup
|
||||
- **Architecture Guide**: See `CAPABILITY_INCLUSION_GUIDE.md` for complete workflow
|
||||
- **Discovery Tools**: `make capability-search TERM=xyz` to find existing functionality
|
||||
|
||||
**Issue Management Protocol:**
|
||||
- **Gitea-First**: Feature requests, bugs, and enhancements should be documented as Gitea issues
|
||||
- **Issue Creation**: When new requirements emerge, create issues in Gitea immediately but do NOT implement immediately
|
||||
@@ -41,25 +55,27 @@ You are the MarkiTect project assistant, specialized in providing project status
|
||||
- **Issue Workflow**: Create → Triage → Plan → Schedule → Implement → Close
|
||||
|
||||
**TDD Workflow Management:**
|
||||
- For all TDD-related guidance, workflow management, and test-driven development questions, use the **tddai-assistant** subagent
|
||||
- The tddai-assistant specializes in the TDD8 methodology (ISSUE-TEST-RED-GREEN-REFACTOR-DOCUMENT-REFINE-PUBLISH cycle)
|
||||
- For issue management tasks, use the **issue-facade** system located in `capabilities/issue-facade/`
|
||||
- The issue-facade provides unified CLI for GitHub, GitLab, Gitea, and local SQLite backends
|
||||
- This includes sidequest management, test planning, and comprehensive development workflow guidance
|
||||
|
||||
### Response Guidelines
|
||||
|
||||
When asked about project status or next steps:
|
||||
|
||||
1. **Start with Current State**: Always check ProjectStatusDigest.md for the latest architecture and status
|
||||
2. **Review Recent Progress**: Check ProjectDiary.md for recent accomplishments and context
|
||||
3. **Check Planned Work**: Read Next.md for documented next steps and priorities
|
||||
4. **Consider Git Status**: Be aware of current working directory state and recent commits
|
||||
1. **Start with Current State**: Always check TODO.md for the latest activity
|
||||
2. **Review Recent Progress**: Check CHANGELOG.md for previous work and progress
|
||||
3. **Check Planned Work**: TODO.md documents next steps and priorities, if empty see topics in roadmap/
|
||||
4. **Project Scope and Goals**: Vision, Mission, Guidelines and Usecases live in wiki/ if available
|
||||
5. **Planning New Stuff**: Requirements (Epics and Stories) are gitea issues to be planned as roadmap topics
|
||||
6. **Consider Git Status**: Allways be aware of current working directory state and recent commits
|
||||
|
||||
### Issue Management Guidelines
|
||||
|
||||
**When to Create Gitea Issues:**
|
||||
- New feature requests or enhancement ideas emerge during development
|
||||
- Bugs or technical debt are discovered but not immediately fixable
|
||||
- Future improvements are identified but outside current session scope
|
||||
- Future improvements are identified but outside current session and topic scope
|
||||
- Architecture decisions require documentation and future review
|
||||
- Sidequests that we want to remember for later implementation
|
||||
|
||||
@@ -71,10 +87,12 @@ When asked about project status or next steps:
|
||||
- Do NOT implement immediately - issues are for tracking and planning
|
||||
|
||||
**Issue vs. Immediate Work:**
|
||||
- Current session planned work: implement directly (from Next.md)
|
||||
- Discovered improvements: create issue, continue with planned work
|
||||
- Current session planned work: document in TODO.md and roadmap/ROADMAPTOPIC
|
||||
- Discovered improvements: add to workplan in roadmap topic, continue with planned work
|
||||
- Critical bugs affecting current work: fix immediately, then create issue for root cause analysis
|
||||
- Future enhancements: always create issue first for proper planning
|
||||
- Future enhancements: note in roadmap-topic to create issues first for proper planning
|
||||
- If possible create issues interactively when closing a topic, they are for human oversight and longterm
|
||||
- Do not create issues for stuff that is detailed and can be adressed before closing the current topic
|
||||
|
||||
**Response Format:**
|
||||
- Provide a brief status summary (2-3 sentences)
|
||||
@@ -95,8 +113,6 @@ When asked about project status or next steps:
|
||||
1. [Action from Next.md or logical progression]
|
||||
2. [Secondary priority or alternative approach]
|
||||
3. [Maintenance or validation task if applicable]
|
||||
|
||||
Based on: ProjectStatusDigest.md:74-79, Next.md:7-13
|
||||
```
|
||||
|
||||
## Session Start-Up Protocol
|
||||
@@ -106,22 +122,21 @@ When asked what's up for a new coding session, follow this standardized routine:
|
||||
### Start-of-Session Checklist
|
||||
1. **Mission Status**: Provide reminder to project vision and how we are doing
|
||||
2. **Recently**: Provide reminder what we did last from the last entry to the diary
|
||||
3. **NEXT.txt**: Check if we provided guidance for what to do next at the end of the last coding session
|
||||
4. **git status**: Check if git is clean or work has been left unfinished
|
||||
3. **TODO.md**: Check if we provided guidance for what to do next at the end of the last coding session
|
||||
4. **git status**: Check if git is clean or work has been left unfinished
|
||||
5. **Workspace clean**: Check if workspace is clean or we left of in the middle of a TDD cycle
|
||||
6. **Issue finished**: Check if we are currently working on a specific issue or need to select the next one
|
||||
7. **Suggestion**: Provide a sensible suggestion of what to do next
|
||||
6. **Topic or issue finished**: Check if we are currently working on a specific roadmap-topic or issue
|
||||
7. **Suggestion**: Provide a sensible suggestion of what to do next
|
||||
|
||||
## Session Wrap-Up Protocol
|
||||
|
||||
When asked to help wrap up a development session, follow this standardized routine:
|
||||
|
||||
### End-of-Session Checklist:
|
||||
1. **Update ProjectDiary.md**: Add entry documenting progress, challenges, and achievements
|
||||
2. **Update NEXT.md**: Set clear priorities and strategy for next session
|
||||
3. **Update ProjectStatusDigest.md**: Refresh current status, metrics, and completed features
|
||||
2. **Update TODO.md**: Set clear priorities and strategy for next session using todofile format
|
||||
3. **Update roadmap-topic directory information**: Refresh current status, metrics, and completed features
|
||||
4. **Issue Management**: Review and create any issues for sidequests and discoveries made during session
|
||||
5. **Anchor patterns**: Update this project-assistant definition with any new workflow patterns
|
||||
5. **Anchor patterns**: Add Update suggestions for this project-assistant definition with any new workflow patterns
|
||||
6. **Prepare for commit**: Ensure all documentation reflects current state
|
||||
|
||||
### Session Success Indicators:
|
||||
@@ -136,9 +151,9 @@ When asked to help wrap up a development session, follow this standardized routi
|
||||
[Brief overview of accomplishments and current state]
|
||||
|
||||
## Documentation Updates
|
||||
- ✅ ProjectDiary.md: [what was added]
|
||||
- ✅ Next.md: [priorities set]
|
||||
- ✅ ProjectStatusDigest.md: [status updated]
|
||||
- ✅ TODO.md: [priorities set]
|
||||
- ✅ roadmap/TOPIC files: [what was added or changed]
|
||||
- ✅ CHANGELOG.ms: [status updated especially on release]
|
||||
|
||||
## Issues Created/Updated
|
||||
- 🎯 Issue #X: [brief description] - [reason for creation]
|
||||
@@ -150,9 +165,33 @@ When asked to help wrap up a development session, follow this standardized routi
|
||||
Ready for commit: [list of files to commit]
|
||||
```
|
||||
|
||||
### Example Capture Small Off-Topic Improvements in roadmap/eat-the-frog:
|
||||
**Smell**: Different filename conventions od conflicting concepts, unclear guideance
|
||||
**Hunch**: Ideas to explore that need consideration if useful and in scope
|
||||
**Hickups**: Notes on inefficient or roundtripping implementation to analyse later
|
||||
|
||||
Collect these in the roadmap-topic-directory and move stuff to eat-the-frog on close if unfinished
|
||||
|
||||
### Example Issue Creation During Development:
|
||||
**Scenario**: While implementing CLI commands, discover that error messages could be improved
|
||||
**Action**: Create issue "Enhance CLI error messages with user-friendly formatting and suggestions"
|
||||
**Result**: Continue with current CLI implementation, address error enhancement in future session
|
||||
|
||||
Generate issues for relevantly expensive or risky stuff and in direct feedback with developers.
|
||||
Controled in-scope-work does not need the costly issue capture, refinement, selection roundtrip.
|
||||
|
||||
Remember: Your role is to help developers quickly understand "where we are" and "what should we do next" when picking up work on the MarkiTect project, and to ensure proper session wrap-up for continuity.
|
||||
|
||||
---
|
||||
|
||||
## Session Start
|
||||
|
||||
1. Check for `.kaizen/agents/project-management/memory.md` in the project root.
|
||||
2. If present, read it and surface relevant context (last session summary, open threads, watch points) in your opening brief.
|
||||
3. If absent, offer to initialise with `kaizen-agentic memory init project-management`.
|
||||
|
||||
## Session Close
|
||||
|
||||
1. Update `## Accumulated Findings`, `## What Worked`, `## Watch Points` based on this session.
|
||||
2. Append one line to `## Session Log`: `YYYY-MM-DD · <brief summary> · <outcome>`.
|
||||
3. Bump `last_updated` to today and increment `session_count`.
|
||||
@@ -98,4 +98,4 @@ When managing releases, always prioritize:
|
||||
1. **Security**: Never compromise on security practices
|
||||
2. **Reliability**: Thorough testing before publication
|
||||
3. **Communication**: Clear documentation and announcements
|
||||
4. **Reproducibility**: Consistent and documented processes
|
||||
4. **Reproducibility**: Consistent and documented processes
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
name: requirements-engineering-agent
|
||||
name: requirements-engineering
|
||||
description: Specialized agent designed to prevent interface compatibility issues and mock object mismatches by ensuring solid foundation planning before implementation. Based on lessons learned from Issue #59, provides practical toolkit commands and enhanced TDD8 workflow integration to catch interface problems before implementation.
|
||||
model: inherit
|
||||
category: development-process
|
||||
---
|
||||
|
||||
# Requirements Engineering and Incremental Development Planning Agent
|
||||
@@ -483,4 +484,19 @@ The agent directly addresses the root causes:
|
||||
|
||||
---
|
||||
|
||||
*This agent provides systematic foundation analysis and interface contract verification based on lessons learned from Issue #59 to prevent compatibility issues and ensure solid architectural foundations before implementation.*
|
||||
## Session Start
|
||||
|
||||
1. Check for `.kaizen/agents/requirements-engineering/memory.md` in the project root.
|
||||
2. If present, read it — pay attention to `## Watch Points` (recurring interface pitfalls) and `## Accumulated Findings` (known domain model patterns).
|
||||
3. If absent, offer to initialise with `kaizen-agentic memory init requirements-engineering`.
|
||||
|
||||
## Session Close
|
||||
|
||||
1. Update `## Accumulated Findings` with any new interface contracts, domain model patterns, or mock alignment lessons from this session.
|
||||
2. Update `## Watch Points` with any newly discovered incompatibility risks.
|
||||
3. Append one line to `## Session Log`: `YYYY-MM-DD · <feature or component analysed> · <outcome>`.
|
||||
4. Bump `last_updated` to today and increment `session_count`.
|
||||
|
||||
---
|
||||
|
||||
*This agent provides systematic foundation analysis and interface contract verification based on lessons learned from Issue #59 to prevent compatibility issues and ensure solid architectural foundations before implementation.*
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
name: setup-repository
|
||||
name: setupRepository
|
||||
description: Specialized assistant for setting up new Python repositories following PythonVibes best practices
|
||||
category: infrastructure
|
||||
---
|
||||
|
||||
## Instructions
|
||||
@@ -411,4 +412,4 @@ When setting up or checking repositories, always verify that:
|
||||
- Standards compliance is treated as a required test, not optional check
|
||||
- Missing .gitignore or other essential files will be caught automatically
|
||||
|
||||
Remember: Your role is to transform repository stubs into production-ready Python projects that follow industry best practices, enable efficient development workflows, and provide a solid foundation for long-term project success.
|
||||
Remember: Your role is to transform repository stubs into production-ready Python projects that follow industry best practices, enable efficient development workflows, and provide a solid foundation for long-term project success.
|
||||
|
||||
@@ -143,7 +143,7 @@ You understand the workspace structure (default: `.tddai_workspace/`, configurab
|
||||
- `DIRTY` - Workspace directory exists but no current issue file
|
||||
|
||||
### Test Development Best Practices
|
||||
**Test Naming Convention:**
|
||||
**Test Naming Convention:**
|
||||
- `test_{capability}_issue_{NUM}_{scenario}.py`
|
||||
|
||||
**Required Test Structure:**
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
---
|
||||
name: test-maintenance
|
||||
category: development-process
|
||||
description: Specialized agent for analyzing and fixing failing tests in projects
|
||||
dependencies: []
|
||||
description: Specialized agent for analyzing and fixing failing tests in the project
|
||||
category: testing
|
||||
---
|
||||
|
||||
# Test-Fixing Agent
|
||||
@@ -142,4 +141,4 @@ ACTION: Change import path, verify test logic still valid
|
||||
- **Communicate trade-offs** when removing functionality
|
||||
- **Maintain backward compatibility** where feasible
|
||||
|
||||
This agent ensures the MarkiTect project maintains a robust, reliable test suite that accurately reflects the current codebase architecture and functionality.
|
||||
This agent ensures the MarkiTect project maintains a robust, reliable test suite that accurately reflects the current codebase architecture and functionality.
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
name: testing-efficiency-optimizer
|
||||
name: testing-efficiency
|
||||
description: Specialized agent designed to optimize TDD8 workflow test execution, resolve pytest reliability issues, and enhance overall testing efficiency for red-green iterations. Focuses on smart test selection, parallel execution, and agent integration patterns.
|
||||
model: inherit
|
||||
category: testing
|
||||
---
|
||||
|
||||
# Testing Efficiency Optimizer Agent
|
||||
@@ -290,4 +291,4 @@ markers =
|
||||
|
||||
---
|
||||
|
||||
*This agent provides specialized test execution optimization focused on TDD8 workflow enhancement, pytest reliability resolution, and systematic testing efficiency improvements for development velocity.*
|
||||
*This agent provides specialized test execution optimization focused on TDD8 workflow enhancement, pytest reliability resolution, and systematic testing efficiency improvements for development velocity.*
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
---
|
||||
name: tooling-optimization
|
||||
category: infrastructure
|
||||
description: Meta-agent that analyzes and optimizes repository tooling usage to improve development efficiency
|
||||
dependencies: []
|
||||
category: infrastructure
|
||||
---
|
||||
|
||||
# Tooling Optimizer Agent
|
||||
@@ -197,4 +196,4 @@ RECOMMENDATION: Suggest primary tools and deprecation plan for others
|
||||
IMPLEMENTATION: Provide migration guide and updated documentation
|
||||
```
|
||||
|
||||
This agent ensures the MarkiTect project maintains an optimized, efficient tooling ecosystem that maximizes developer productivity and minimizes friction in development workflows.
|
||||
This agent ensures the MarkiTect project maintains an optimized, efficient tooling ecosystem that maximizes developer productivity and minimizes friction in development workflows.
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
---
|
||||
name: wisdom-encouragement
|
||||
category: project-management
|
||||
description: Provides encouraging wisdom and guidance for developers facing complex implementation challenges
|
||||
dependencies: []
|
||||
description: "Provides encouraging wisdom and guidance for complex implementation tasks and challenging technical work"
|
||||
model: haiku
|
||||
color: cyan
|
||||
category: documentation
|
||||
---
|
||||
|
||||
You are the Fortune Wisdom Guide, a sage advisor who specializes in providing encouraging, insightful fortune cookie-style wisdom specifically tailored to developers and implementers facing technical challenges. Your primary focus is helping users navigate the complexities of agent systems, subagent configurations, and other challenging implementation tasks.
|
||||
|
||||
@@ -6,7 +6,11 @@ from pathlib import Path
|
||||
from typing import List, Dict, Optional
|
||||
from dataclasses import dataclass
|
||||
|
||||
from .registry import AgentRegistry
|
||||
from .registry import AgentRegistry, AgentDefinition
|
||||
from .agent_docs import (
|
||||
render_installed_agents_section,
|
||||
upsert_installed_agents_section,
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
@@ -82,7 +86,15 @@ class AgentInstaller:
|
||||
|
||||
installed = []
|
||||
for agent_file in agents_dir.glob("agent-*.md"):
|
||||
agent_name = agent_file.stem.replace("agent-", "")
|
||||
# Prefer the frontmatter name (registry-authoritative); fall back to
|
||||
# the filename when frontmatter is missing/unreadable. The filename
|
||||
# encodes the category for a few agents (e.g. agent-project-
|
||||
# management.md → name: project-assistant), so a pure filename derive
|
||||
# produces names the registry cannot resolve (WP-0007 T02).
|
||||
try:
|
||||
agent_name = AgentDefinition._read_frontmatter(agent_file)["name"]
|
||||
except Exception:
|
||||
agent_name = agent_file.stem.replace("agent-", "")
|
||||
installed.append(agent_name)
|
||||
|
||||
return sorted(installed)
|
||||
@@ -235,60 +247,25 @@ agents-validate:
|
||||
try:
|
||||
claude_md = project_dir / "CLAUDE.md"
|
||||
|
||||
agent_section = "## Installed Agents\n\n"
|
||||
agent_section += (
|
||||
"This project includes the following specialized agents:\n\n"
|
||||
)
|
||||
agents = [
|
||||
agent
|
||||
for agent in (self.registry.get_agent(name) for name in agent_names)
|
||||
if agent is not None
|
||||
]
|
||||
agent_section = render_installed_agents_section(agents)
|
||||
|
||||
# Group agents by category
|
||||
categories = {}
|
||||
for agent_name in agent_names:
|
||||
agent = self.registry.get_agent(agent_name)
|
||||
if agent:
|
||||
category = agent.category.value
|
||||
if category not in categories:
|
||||
categories[category] = []
|
||||
categories[category].append(agent)
|
||||
|
||||
# Generate documentation
|
||||
for category, agents in categories.items():
|
||||
agent_section += f"### {category.replace('-', ' ').title()}\n\n"
|
||||
for agent in agents:
|
||||
agent_section += f"- **{agent.name}**: {agent.description}\n"
|
||||
agent_section += "\n"
|
||||
|
||||
agent_section += (
|
||||
"Use these agents by referencing them in your "
|
||||
"Claude Code interactions.\n\n"
|
||||
)
|
||||
|
||||
# Update or create CLAUDE.md
|
||||
# Update or create CLAUDE.md (idempotent upsert — WP-0007 T01/T02)
|
||||
if claude_md.exists():
|
||||
with open(claude_md, "r") as f:
|
||||
content = f.read()
|
||||
|
||||
# Replace existing agent section or append
|
||||
if "## Installed Agents" in content:
|
||||
import re
|
||||
|
||||
content = re.sub(
|
||||
r"## Installed Agents.*?(?=##|\Z)",
|
||||
agent_section,
|
||||
content,
|
||||
flags=re.DOTALL,
|
||||
)
|
||||
else:
|
||||
content += "\n" + agent_section
|
||||
|
||||
with open(claude_md, "w") as f:
|
||||
f.write(content)
|
||||
content = claude_md.read_text()
|
||||
content = upsert_installed_agents_section(content, agent_section)
|
||||
claude_md.write_text(content)
|
||||
else:
|
||||
# Create new CLAUDE.md
|
||||
header = "# Claude Code Configuration\n\n"
|
||||
header += "This file contains Claude Code configuration and agent information.\n\n"
|
||||
|
||||
with open(claude_md, "w") as f:
|
||||
f.write(header + agent_section)
|
||||
header += (
|
||||
"This file contains Claude Code configuration and agent "
|
||||
"information.\n\n"
|
||||
)
|
||||
claude_md.write_text(header + agent_section)
|
||||
|
||||
print(f"Updated documentation: {claude_md}")
|
||||
|
||||
|
||||
@@ -60,8 +60,10 @@ class AgentDefinition:
|
||||
# Extract dependencies from frontmatter and content
|
||||
dependencies = cls._extract_dependencies(content, frontmatter)
|
||||
|
||||
# Determine category from name or content
|
||||
category = cls._determine_category(frontmatter["name"], content)
|
||||
# The declared frontmatter category is authoritative when it is a known
|
||||
# value (it is what `validate` enforces, WP-0007 T03); fall back to the
|
||||
# name/content heuristic only when absent or unrecognised.
|
||||
category = cls._resolve_category(frontmatter, content)
|
||||
|
||||
return cls(
|
||||
name=frontmatter["name"],
|
||||
@@ -118,6 +120,17 @@ class AgentDefinition:
|
||||
|
||||
return dependencies
|
||||
|
||||
@classmethod
|
||||
def _resolve_category(cls, frontmatter: dict, content: str) -> AgentCategory:
|
||||
"""Prefer the declared frontmatter category; heuristic as fallback."""
|
||||
declared = frontmatter.get("category")
|
||||
if isinstance(declared, str):
|
||||
try:
|
||||
return AgentCategory(declared.strip())
|
||||
except ValueError:
|
||||
pass
|
||||
return cls._determine_category(frontmatter["name"], content)
|
||||
|
||||
@staticmethod
|
||||
def _determine_category(name: str, content: str) -> AgentCategory:
|
||||
"""Determine agent category based on name and content."""
|
||||
@@ -288,6 +301,65 @@ class AgentRegistry:
|
||||
|
||||
return errors
|
||||
|
||||
def validate_frontmatter_schema(self) -> Dict[str, List[str]]:
|
||||
"""Validate each agent file's frontmatter against the required schema.
|
||||
|
||||
Required: ``name``, ``description``, ``category`` (non-empty strings);
|
||||
``category`` must be a known :class:`AgentCategory` value. Optional:
|
||||
``memory`` ∈ {enabled, disabled}; ``model`` a non-empty string. Keyed by
|
||||
filename so files with a missing/invalid ``name`` still surface.
|
||||
"""
|
||||
errors: Dict[str, List[str]] = {}
|
||||
valid_categories = {c.value for c in AgentCategory}
|
||||
|
||||
if not self.agents_dir.exists():
|
||||
return errors
|
||||
|
||||
for agent_file in sorted(self.agents_dir.glob("agent-*.md")):
|
||||
file_errors: List[str] = []
|
||||
try:
|
||||
content = agent_file.read_text(encoding="utf-8")
|
||||
match = re.match(r"^---\n(.*?)\n---\n", content, re.DOTALL)
|
||||
if not match:
|
||||
errors[agent_file.name] = ["missing YAML frontmatter"]
|
||||
continue
|
||||
frontmatter = yaml.safe_load(match.group(1))
|
||||
if not isinstance(frontmatter, dict):
|
||||
errors[agent_file.name] = ["frontmatter is not a mapping"]
|
||||
continue
|
||||
|
||||
for field in ("name", "description", "category"):
|
||||
value = frontmatter.get(field)
|
||||
if not isinstance(value, str) or not value.strip():
|
||||
file_errors.append(f"missing or empty required field: {field}")
|
||||
|
||||
category = frontmatter.get("category")
|
||||
if isinstance(category, str) and category not in valid_categories:
|
||||
file_errors.append(
|
||||
f"invalid category '{category}' (expected one of "
|
||||
f"{', '.join(sorted(valid_categories))})"
|
||||
)
|
||||
|
||||
memory = frontmatter.get("memory")
|
||||
if memory is not None and memory not in ("enabled", "disabled"):
|
||||
file_errors.append(
|
||||
f"invalid memory '{memory}' "
|
||||
"(expected 'enabled' or 'disabled')"
|
||||
)
|
||||
|
||||
model = frontmatter.get("model")
|
||||
if model is not None and (
|
||||
not isinstance(model, str) or not model.strip()
|
||||
):
|
||||
file_errors.append("model must be a non-empty string when present")
|
||||
except Exception as exc: # pragma: no cover - defensive
|
||||
file_errors.append(f"failed to parse frontmatter: {exc}")
|
||||
|
||||
if file_errors:
|
||||
errors[agent_file.name] = file_errors
|
||||
|
||||
return errors
|
||||
|
||||
def _has_circular_dependency(
|
||||
self, agent_name: str, visited: Optional[Set[str]] = None
|
||||
) -> bool:
|
||||
|
||||
185
src/kaizen_agentic/schedule.py
Normal file
185
src/kaizen_agentic/schedule.py
Normal file
@@ -0,0 +1,185 @@
|
||||
"""Repo-local scheduled agent execution manifest (.kaizen/schedule.yml).
|
||||
|
||||
ADR-005 defines the schedule contract: which agents run on what cadence in an
|
||||
opted-in repo. kaizen-agentic owns parsing, validation, and preparing an
|
||||
orientation bundle for a scheduled run. It does **not** run cron schedules or
|
||||
invoke Claude — activity-core fires the cron and a coding-agent session executes
|
||||
the prepared bundle.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
import yaml
|
||||
|
||||
SCHEDULE_RELATIVE_PATH = Path(".kaizen") / "schedule.yml"
|
||||
SCHEDULE_VERSION = "1"
|
||||
VALID_CADENCES = ("daily", "weekly", "monthly")
|
||||
|
||||
# Sensible defaults for `schedule init` — coach + optimization weekly, the
|
||||
# heavier tdd-workflow review monthly and disabled until an operator opts in.
|
||||
DEFAULT_AGENTS: Dict[str, Dict[str, Any]] = {
|
||||
"coach": {"cadence": "weekly", "cron": "0 9 * * 1", "enabled": True},
|
||||
"optimization": {"cadence": "weekly", "cron": "0 10 * * 1", "enabled": True},
|
||||
"tdd-workflow": {"cadence": "monthly", "enabled": False},
|
||||
}
|
||||
DEFAULT_TIMEZONE = "Europe/Berlin"
|
||||
|
||||
|
||||
class ScheduleError(Exception):
|
||||
"""Raised when a schedule manifest cannot be parsed."""
|
||||
|
||||
|
||||
@dataclass
|
||||
class ScheduleEntry:
|
||||
"""One scheduled agent run declaration."""
|
||||
|
||||
agent: str
|
||||
cadence: str
|
||||
enabled: bool = True
|
||||
cron: Optional[str] = None
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
data: Dict[str, Any] = {"cadence": self.cadence, "enabled": self.enabled}
|
||||
if self.cron:
|
||||
data["cron"] = self.cron
|
||||
return data
|
||||
|
||||
|
||||
@dataclass
|
||||
class Schedule:
|
||||
"""Parsed `.kaizen/schedule.yml` manifest."""
|
||||
|
||||
version: str
|
||||
timezone: Optional[str] = None
|
||||
entries: List[ScheduleEntry] = field(default_factory=list)
|
||||
source_path: Optional[Path] = None
|
||||
|
||||
def entry_for(self, agent: str) -> Optional[ScheduleEntry]:
|
||||
for entry in self.entries:
|
||||
if entry.agent == agent:
|
||||
return entry
|
||||
return None
|
||||
|
||||
def enabled_entries(self) -> List[ScheduleEntry]:
|
||||
return [e for e in self.entries if e.enabled]
|
||||
|
||||
|
||||
def schedule_path(project_root: Path) -> Path:
|
||||
"""Return the canonical schedule.yml path for a project root."""
|
||||
return Path(project_root) / SCHEDULE_RELATIVE_PATH
|
||||
|
||||
|
||||
def parse_schedule(data: Any, source_path: Optional[Path] = None) -> Schedule:
|
||||
"""Parse a raw mapping into a Schedule (structural errors raise).
|
||||
|
||||
Semantic validation (known agents, cadence values) is handled by
|
||||
:func:`validate_schedule` so callers can collect actionable error lists.
|
||||
"""
|
||||
if not isinstance(data, dict):
|
||||
raise ScheduleError("schedule.yml must be a YAML mapping at the top level")
|
||||
|
||||
version = data.get("version")
|
||||
if version is None:
|
||||
raise ScheduleError("schedule.yml is missing required key: version")
|
||||
version = str(version)
|
||||
|
||||
timezone = data.get("timezone")
|
||||
if timezone is not None and not isinstance(timezone, str):
|
||||
raise ScheduleError("timezone must be a string")
|
||||
|
||||
agents = data.get("agents", {})
|
||||
if not isinstance(agents, dict):
|
||||
raise ScheduleError("agents must be a mapping of agent-name -> settings")
|
||||
|
||||
entries: List[ScheduleEntry] = []
|
||||
for name, settings in agents.items():
|
||||
if settings is None:
|
||||
settings = {}
|
||||
if not isinstance(settings, dict):
|
||||
raise ScheduleError(f"agent '{name}' settings must be a mapping")
|
||||
cron = settings.get("cron")
|
||||
if cron is not None and not isinstance(cron, str):
|
||||
raise ScheduleError(f"agent '{name}' cron must be a string")
|
||||
entries.append(
|
||||
ScheduleEntry(
|
||||
agent=str(name),
|
||||
cadence=str(settings.get("cadence", "")),
|
||||
enabled=bool(settings.get("enabled", True)),
|
||||
cron=cron,
|
||||
)
|
||||
)
|
||||
|
||||
return Schedule(
|
||||
version=version,
|
||||
timezone=timezone,
|
||||
entries=entries,
|
||||
source_path=source_path,
|
||||
)
|
||||
|
||||
|
||||
def load_schedule(path: Path) -> Schedule:
|
||||
"""Load and parse a schedule.yml file (raises ScheduleError)."""
|
||||
path = Path(path)
|
||||
if not path.exists():
|
||||
raise ScheduleError(f"schedule file not found: {path}")
|
||||
try:
|
||||
raw = yaml.safe_load(path.read_text(encoding="utf-8"))
|
||||
except yaml.YAMLError as exc: # pragma: no cover - passthrough message
|
||||
raise ScheduleError(f"invalid YAML in {path}: {exc}") from exc
|
||||
return parse_schedule(raw, source_path=path)
|
||||
|
||||
|
||||
def validate_schedule(
|
||||
schedule: Schedule, known_agents: Optional[List[str]] = None
|
||||
) -> List[str]:
|
||||
"""Return a list of human-readable validation errors (empty == valid)."""
|
||||
errors: List[str] = []
|
||||
|
||||
if schedule.version != SCHEDULE_VERSION:
|
||||
errors.append(
|
||||
f"unsupported version '{schedule.version}' "
|
||||
f"(expected '{SCHEDULE_VERSION}')"
|
||||
)
|
||||
|
||||
if not schedule.entries:
|
||||
errors.append("no agents declared under 'agents:'")
|
||||
|
||||
seen: set = set()
|
||||
known = set(known_agents) if known_agents is not None else None
|
||||
for entry in schedule.entries:
|
||||
if entry.agent in seen:
|
||||
errors.append(f"duplicate agent entry: {entry.agent}")
|
||||
seen.add(entry.agent)
|
||||
|
||||
if entry.cadence not in VALID_CADENCES:
|
||||
errors.append(
|
||||
f"agent '{entry.agent}': invalid cadence '{entry.cadence}' "
|
||||
f"(expected one of {', '.join(VALID_CADENCES)})"
|
||||
)
|
||||
|
||||
if known is not None and entry.agent not in known:
|
||||
errors.append(
|
||||
f"agent '{entry.agent}' is not an installed or packaged agent"
|
||||
)
|
||||
|
||||
return errors
|
||||
|
||||
|
||||
def default_schedule_yaml(timezone: str = DEFAULT_TIMEZONE) -> str:
|
||||
"""Render the default schedule.yml scaffold for `schedule init`."""
|
||||
document = {
|
||||
"version": SCHEDULE_VERSION,
|
||||
"timezone": timezone,
|
||||
"agents": dict(DEFAULT_AGENTS),
|
||||
}
|
||||
header = (
|
||||
"# Kaizen scheduled agent execution manifest (ADR-005)\n"
|
||||
"# Declares which agents run on what cadence in this repo.\n"
|
||||
"# Validate with: kaizen-agentic schedule validate\n"
|
||||
)
|
||||
body = yaml.safe_dump(document, sort_keys=False, default_flow_style=False)
|
||||
return header + body
|
||||
97
tests/test_agent_docs.py
Normal file
97
tests/test_agent_docs.py
Normal file
@@ -0,0 +1,97 @@
|
||||
"""Tests for idempotent agent-docs generation (WP-0007 T01/T02)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from click.testing import CliRunner
|
||||
|
||||
from kaizen_agentic.agent_docs import (
|
||||
SECTION_FOOTER,
|
||||
SECTION_HEADING,
|
||||
render_installed_agents_section,
|
||||
upsert_installed_agents_section,
|
||||
)
|
||||
from kaizen_agentic.cli import cli
|
||||
from kaizen_agentic.registry import AgentRegistry
|
||||
|
||||
AGENTS_DIR = Path(__file__).parent.parent / "agents"
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def runner() -> CliRunner:
|
||||
return CliRunner()
|
||||
|
||||
|
||||
def _section() -> str:
|
||||
agents = AgentRegistry(AGENTS_DIR).list_agents()[:4]
|
||||
return render_installed_agents_section(agents)
|
||||
|
||||
|
||||
class TestUpsertIdempotency:
|
||||
def test_upsert_is_idempotent(self):
|
||||
section = _section()
|
||||
base = f"# Project\n\nintro\n\n{section}\n## Keep Me\nbody\n"
|
||||
once = upsert_installed_agents_section(base, section)
|
||||
twice = upsert_installed_agents_section(once, section)
|
||||
assert once == twice
|
||||
assert once.count(SECTION_HEADING) == 1
|
||||
assert once.count(SECTION_FOOTER) == 1
|
||||
# A following top-level section must survive the replace
|
||||
assert once.count("## Keep Me") == 1
|
||||
|
||||
def test_subheadings_do_not_truncate_section(self):
|
||||
section = _section()
|
||||
# The block contains '### Category' subheadings; the replace must not
|
||||
# stop at the first one (the original regex bug).
|
||||
merged = upsert_installed_agents_section("# P\n\n", section)
|
||||
assert merged.count(SECTION_FOOTER) == 1
|
||||
assert "### " in merged # categories rendered
|
||||
|
||||
def test_append_when_absent(self):
|
||||
section = _section()
|
||||
merged = upsert_installed_agents_section("# Project\n\nbody\n", section)
|
||||
assert SECTION_HEADING in merged
|
||||
assert merged.count(SECTION_FOOTER) == 1
|
||||
|
||||
|
||||
class TestDocsGenerateCli:
|
||||
def test_generate_then_check_clean(self, runner: CliRunner, tmp_path: Path):
|
||||
# A project with two installed agents
|
||||
proj = tmp_path / "proj"
|
||||
(proj / "agents").mkdir(parents=True)
|
||||
for name, cat in (("alpha", "testing"), ("beta", "code-quality")):
|
||||
(proj / "agents" / f"agent-{name}.md").write_text(
|
||||
f"---\nname: {name}\ndescription: d{name}\ncategory: {cat}\n---\nx\n"
|
||||
)
|
||||
|
||||
gen = runner.invoke(cli, ["docs", "generate", "--target", str(proj)])
|
||||
assert gen.exit_code == 0
|
||||
claude = (proj / "CLAUDE.md").read_text()
|
||||
assert claude.count(SECTION_HEADING) == 1
|
||||
assert "**alpha**" in claude and "**beta**" in claude
|
||||
|
||||
# Second generate is a no-op
|
||||
again = runner.invoke(cli, ["docs", "generate", "--target", str(proj)])
|
||||
assert "already up to date" in again.output
|
||||
|
||||
# --check passes on a synced repo
|
||||
check = runner.invoke(
|
||||
cli, ["docs", "generate", "--check", "--target", str(proj)]
|
||||
)
|
||||
assert check.exit_code == 0
|
||||
assert "up to date" in check.output
|
||||
|
||||
def test_check_fails_when_stale(self, runner: CliRunner, tmp_path: Path):
|
||||
proj = tmp_path / "proj"
|
||||
(proj / "agents").mkdir(parents=True)
|
||||
(proj / "agents" / "agent-alpha.md").write_text(
|
||||
"---\nname: alpha\ndescription: d\ncategory: testing\n---\nx\n"
|
||||
)
|
||||
(proj / "CLAUDE.md").write_text("# Proj\n\nno agents section yet\n")
|
||||
check = runner.invoke(
|
||||
cli, ["docs", "generate", "--check", "--target", str(proj)]
|
||||
)
|
||||
assert check.exit_code == 1
|
||||
assert "out of date" in check.output
|
||||
@@ -40,10 +40,15 @@ class TestClickWorkaround:
|
||||
assert "Got unexpected extra argument" not in stdout_content
|
||||
assert "Got unexpected extra argument" not in stderr_content
|
||||
|
||||
def test_update_command_error_suppression(self):
|
||||
def test_update_command_error_suppression(self, tmp_path):
|
||||
"""Test that spurious 'unexpected extra argument' errors are suppressed for update commands."""
|
||||
# Seed a temp project so `update` does not rewrite the repo's own agents/
|
||||
(tmp_path / "agents").mkdir()
|
||||
(tmp_path / "agents" / "agent-tdd-workflow.md").write_text(
|
||||
"---\nname: tdd-workflow\ndescription: d\ncategory: testing\n---\nx\n"
|
||||
)
|
||||
# Test the update command that also shows spurious errors
|
||||
with patch("sys.argv", ["kaizen-agentic", "update"]):
|
||||
with patch("sys.argv", ["kaizen-agentic", "update", "--target", str(tmp_path)]):
|
||||
with patch("sys.stdout", new_callable=StringIO) as mock_stdout:
|
||||
with patch("sys.stderr", new_callable=StringIO) as mock_stderr:
|
||||
try:
|
||||
@@ -116,9 +121,12 @@ class TestClickWorkaround:
|
||||
class TestInstallCommandSpecifics:
|
||||
"""Test specific install command scenarios."""
|
||||
|
||||
def test_install_with_valid_agent(self):
|
||||
def test_install_with_valid_agent(self, tmp_path):
|
||||
"""Test install command with a valid agent name."""
|
||||
with patch("sys.argv", ["kaizen-agentic", "install", "tdd-workflow"]):
|
||||
with patch(
|
||||
"sys.argv",
|
||||
["kaizen-agentic", "install", "tdd-workflow", "--target", str(tmp_path)],
|
||||
):
|
||||
with patch("sys.stdout", new_callable=StringIO) as mock_stdout:
|
||||
with patch("sys.stderr", new_callable=StringIO) as mock_stderr:
|
||||
try:
|
||||
|
||||
100
tests/test_create_agent.py
Normal file
100
tests/test_create_agent.py
Normal file
@@ -0,0 +1,100 @@
|
||||
"""Tests for the create-agent scaffold (WP-0007 T04)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from click.testing import CliRunner
|
||||
|
||||
from kaizen_agentic.cli import cli
|
||||
from kaizen_agentic.registry import AgentRegistry
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def runner() -> CliRunner:
|
||||
return CliRunner()
|
||||
|
||||
|
||||
class TestCreateAgent:
|
||||
def test_scaffold_is_schema_valid_and_loads(
|
||||
self, runner: CliRunner, tmp_path: Path
|
||||
):
|
||||
result = runner.invoke(
|
||||
cli,
|
||||
[
|
||||
"create-agent",
|
||||
"demo-helper",
|
||||
"-c",
|
||||
"testing",
|
||||
"-d",
|
||||
"Demo helper for tests",
|
||||
"--target",
|
||||
str(tmp_path),
|
||||
],
|
||||
)
|
||||
assert result.exit_code == 0, result.output
|
||||
agent_path = tmp_path / "agents" / "agent-demo-helper.md"
|
||||
assert agent_path.exists()
|
||||
|
||||
registry = AgentRegistry(tmp_path / "agents")
|
||||
# Passes the schema and is loadable by the registry.
|
||||
assert registry.validate_frontmatter_schema() == {}
|
||||
agent = registry.get_agent("demo-helper")
|
||||
assert agent is not None
|
||||
assert agent.category.value == "testing"
|
||||
assert agent.memory == "enabled"
|
||||
|
||||
def test_interactive_prompts_when_flags_missing(
|
||||
self, runner: CliRunner, tmp_path: Path
|
||||
):
|
||||
result = runner.invoke(
|
||||
cli,
|
||||
["create-agent", "prompted", "--target", str(tmp_path)],
|
||||
input="testing\nA prompted agent\n",
|
||||
)
|
||||
assert result.exit_code == 0, result.output
|
||||
content = (tmp_path / "agents" / "agent-prompted.md").read_text()
|
||||
assert "category: testing" in content
|
||||
assert "description: A prompted agent" in content
|
||||
|
||||
def test_refuses_overwrite_without_force(self, runner: CliRunner, tmp_path: Path):
|
||||
args = [
|
||||
"create-agent",
|
||||
"dup",
|
||||
"-c",
|
||||
"meta",
|
||||
"-d",
|
||||
"first",
|
||||
"--target",
|
||||
str(tmp_path),
|
||||
]
|
||||
assert runner.invoke(cli, args).exit_code == 0
|
||||
second = runner.invoke(cli, args)
|
||||
assert second.exit_code == 1
|
||||
assert "already exists" in second.output
|
||||
|
||||
def test_force_overwrites(self, runner: CliRunner, tmp_path: Path):
|
||||
base = ["create-agent", "dup", "--target", str(tmp_path)]
|
||||
runner.invoke(cli, base + ["-c", "meta", "-d", "first"])
|
||||
result = runner.invoke(cli, base + ["-c", "meta", "-d", "second", "--force"])
|
||||
assert result.exit_code == 0
|
||||
assert (
|
||||
"description: second" in (tmp_path / "agents" / "agent-dup.md").read_text()
|
||||
)
|
||||
|
||||
def test_rejects_invalid_category(self, runner: CliRunner, tmp_path: Path):
|
||||
result = runner.invoke(
|
||||
cli,
|
||||
[
|
||||
"create-agent",
|
||||
"x",
|
||||
"-c",
|
||||
"nonsense",
|
||||
"-d",
|
||||
"d",
|
||||
"--target",
|
||||
str(tmp_path),
|
||||
],
|
||||
)
|
||||
assert result.exit_code != 0
|
||||
@@ -13,7 +13,8 @@ DEFINITIONS_DIR = (
|
||||
|
||||
def test_activity_definitions_have_required_frontmatter():
|
||||
files = list(DEFINITIONS_DIR.glob("*.md"))
|
||||
assert len(files) == 3
|
||||
# 3 from WP-0004 (metrics) + 2 from WP-0006 (scheduled agent runs)
|
||||
assert len(files) == 5
|
||||
|
||||
for path in files:
|
||||
text = path.read_text(encoding="utf-8")
|
||||
|
||||
29
tests/test_packaged_agents_parity.py
Normal file
29
tests/test_packaged_agents_parity.py
Normal file
@@ -0,0 +1,29 @@
|
||||
"""Verify packaged agent data matches canonical agents/ source."""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
AGENTS_SRC = ROOT / "agents"
|
||||
AGENTS_PKG = ROOT / "src" / "kaizen_agentic" / "data" / "agents"
|
||||
|
||||
|
||||
def _agent_files(directory: Path) -> dict[str, Path]:
|
||||
return {p.name: p for p in sorted(directory.glob("agent-*.md"))}
|
||||
|
||||
|
||||
def test_packaged_agents_match_source():
|
||||
"""Wheel data/agents must mirror agents/ (names and content)."""
|
||||
src = _agent_files(AGENTS_SRC)
|
||||
pkg = _agent_files(AGENTS_PKG)
|
||||
|
||||
assert src, "agents/ must contain agent-*.md files"
|
||||
assert set(src) == set(pkg), (
|
||||
f"agent file set mismatch\n"
|
||||
f" only in agents/: {sorted(set(src) - set(pkg))}\n"
|
||||
f" only in data/agents/: {sorted(set(pkg) - set(src))}"
|
||||
)
|
||||
|
||||
drift = [name for name in src if src[name].read_text() != pkg[name].read_text()]
|
||||
assert not drift, f"content drift in packaged copies: {drift}"
|
||||
166
tests/test_schedule_cli.py
Normal file
166
tests/test_schedule_cli.py
Normal file
@@ -0,0 +1,166 @@
|
||||
"""CLI + module tests for scheduled agent execution (ADR-005, WP-0006)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from click.testing import CliRunner
|
||||
|
||||
from kaizen_agentic.cli import cli
|
||||
from kaizen_agentic.schedule import (
|
||||
ScheduleError,
|
||||
parse_schedule,
|
||||
schedule_path,
|
||||
validate_schedule,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def runner() -> CliRunner:
|
||||
return CliRunner()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def project_dir(tmp_path: Path) -> Path:
|
||||
root = tmp_path / "demo-project"
|
||||
root.mkdir()
|
||||
return root
|
||||
|
||||
|
||||
class TestScheduleModule:
|
||||
def test_parse_requires_version(self):
|
||||
with pytest.raises(ScheduleError):
|
||||
parse_schedule({"agents": {}})
|
||||
|
||||
def test_parse_rejects_non_mapping(self):
|
||||
with pytest.raises(ScheduleError):
|
||||
parse_schedule(["not", "a", "mapping"])
|
||||
|
||||
def test_validate_flags_unknown_agent_and_bad_cadence(self):
|
||||
schedule = parse_schedule(
|
||||
{
|
||||
"version": "1",
|
||||
"agents": {
|
||||
"coach": {"cadence": "weekly", "enabled": True},
|
||||
"made-up": {"cadence": "hourly"},
|
||||
},
|
||||
}
|
||||
)
|
||||
errors = validate_schedule(schedule, known_agents=["coach", "optimization"])
|
||||
assert any("hourly" in e for e in errors)
|
||||
assert any("made-up" in e for e in errors)
|
||||
|
||||
def test_validate_clean_schedule(self):
|
||||
schedule = parse_schedule(
|
||||
{"version": "1", "agents": {"coach": {"cadence": "weekly"}}}
|
||||
)
|
||||
assert validate_schedule(schedule, known_agents=["coach"]) == []
|
||||
|
||||
|
||||
class TestScheduleCli:
|
||||
def test_init_creates_default_schedule(self, runner: CliRunner, project_dir: Path):
|
||||
result = runner.invoke(cli, ["schedule", "init", "--target", str(project_dir)])
|
||||
assert result.exit_code == 0
|
||||
path = schedule_path(project_dir)
|
||||
assert path.exists()
|
||||
assert "coach" in path.read_text()
|
||||
|
||||
def test_init_no_overwrite_without_force(
|
||||
self, runner: CliRunner, project_dir: Path
|
||||
):
|
||||
runner.invoke(cli, ["schedule", "init", "--target", str(project_dir)])
|
||||
result = runner.invoke(cli, ["schedule", "init", "--target", str(project_dir)])
|
||||
assert result.exit_code == 0
|
||||
assert "already exists" in result.output
|
||||
|
||||
def test_validate_passes_on_default(self, runner: CliRunner, project_dir: Path):
|
||||
runner.invoke(cli, ["schedule", "init", "--target", str(project_dir)])
|
||||
result = runner.invoke(
|
||||
cli, ["schedule", "validate", "--target", str(project_dir)]
|
||||
)
|
||||
assert result.exit_code == 0
|
||||
assert "valid" in result.output
|
||||
|
||||
def test_validate_missing_file_errors(self, runner: CliRunner, project_dir: Path):
|
||||
result = runner.invoke(
|
||||
cli, ["schedule", "validate", "--target", str(project_dir)]
|
||||
)
|
||||
assert result.exit_code == 1
|
||||
|
||||
def test_validate_rejects_bad_schema(self, runner: CliRunner, project_dir: Path):
|
||||
path = schedule_path(project_dir)
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
path.write_text("version: '1'\nagents:\n not-an-agent:\n cadence: weekly\n")
|
||||
result = runner.invoke(
|
||||
cli, ["schedule", "validate", "--target", str(project_dir)]
|
||||
)
|
||||
assert result.exit_code == 1
|
||||
assert "not-an-agent" in result.output
|
||||
|
||||
def test_list_shows_enabled(self, runner: CliRunner, project_dir: Path):
|
||||
runner.invoke(cli, ["schedule", "init", "--target", str(project_dir)])
|
||||
result = runner.invoke(cli, ["schedule", "list", "--target", str(project_dir)])
|
||||
assert result.exit_code == 0
|
||||
assert "coach" in result.output
|
||||
# tdd-workflow is disabled by default; hidden without --all
|
||||
assert "tdd-workflow" not in result.output
|
||||
|
||||
def test_list_all_shows_disabled(self, runner: CliRunner, project_dir: Path):
|
||||
runner.invoke(cli, ["schedule", "init", "--target", str(project_dir)])
|
||||
result = runner.invoke(
|
||||
cli, ["schedule", "list", "--all", "--target", str(project_dir)]
|
||||
)
|
||||
assert "tdd-workflow" in result.output
|
||||
|
||||
def test_prepare_markdown_includes_agent_prompt(
|
||||
self, runner: CliRunner, project_dir: Path
|
||||
):
|
||||
result = runner.invoke(
|
||||
cli, ["schedule", "prepare", "coach", "--target", str(project_dir)]
|
||||
)
|
||||
assert result.exit_code == 0
|
||||
assert "Scheduled Run Orientation: coach" in result.output
|
||||
assert "## Agent Prompt" in result.output
|
||||
assert "Coach Agent" in result.output
|
||||
assert "## Session Close" in result.output
|
||||
|
||||
def test_prepare_json_format(self, runner: CliRunner, project_dir: Path):
|
||||
result = runner.invoke(
|
||||
cli,
|
||||
[
|
||||
"schedule",
|
||||
"prepare",
|
||||
"coach",
|
||||
"--target",
|
||||
str(project_dir),
|
||||
"--format",
|
||||
"json",
|
||||
],
|
||||
)
|
||||
assert result.exit_code == 0
|
||||
payload = json.loads(result.output)
|
||||
assert payload["agent"] == "coach"
|
||||
assert payload["agent_prompt_found"] is True
|
||||
assert payload["session_close"]
|
||||
|
||||
def test_prepare_unknown_agent_notes_missing(
|
||||
self, runner: CliRunner, project_dir: Path
|
||||
):
|
||||
result = runner.invoke(
|
||||
cli,
|
||||
["schedule", "prepare", "no-such-agent", "--target", str(project_dir)],
|
||||
)
|
||||
assert result.exit_code == 0
|
||||
assert "not found in registry" in result.output
|
||||
|
||||
def test_prepare_includes_memory_when_present(
|
||||
self, runner: CliRunner, project_dir: Path
|
||||
):
|
||||
runner.invoke(cli, ["memory", "init", "coach", "--target", str(project_dir)])
|
||||
result = runner.invoke(
|
||||
cli, ["schedule", "prepare", "coach", "--target", str(project_dir)]
|
||||
)
|
||||
assert "## Project Memory" in result.output
|
||||
assert "Project Context" in result.output
|
||||
74
tests/test_validate_schema.py
Normal file
74
tests/test_validate_schema.py
Normal file
@@ -0,0 +1,74 @@
|
||||
"""Tests for agent frontmatter schema validation (WP-0007 T03)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from kaizen_agentic.registry import AgentRegistry
|
||||
|
||||
REPO_AGENTS = Path(__file__).parent.parent / "agents"
|
||||
|
||||
|
||||
def _registry(tmp_path: Path, files: dict) -> AgentRegistry:
|
||||
agents = tmp_path / "agents"
|
||||
agents.mkdir(parents=True)
|
||||
for filename, content in files.items():
|
||||
(agents / filename).write_text(content)
|
||||
return AgentRegistry(agents)
|
||||
|
||||
|
||||
class TestFrontmatterSchema:
|
||||
def test_repo_agents_are_schema_valid(self):
|
||||
# The shipped agents/ must always pass the schema.
|
||||
assert AgentRegistry(REPO_AGENTS).validate_frontmatter_schema() == {}
|
||||
|
||||
def test_good_agent_passes(self, tmp_path: Path):
|
||||
reg = _registry(
|
||||
tmp_path,
|
||||
{
|
||||
"agent-good.md": (
|
||||
"---\nname: good\ndescription: A fine agent\n"
|
||||
"category: testing\nmemory: enabled\n---\nbody\n"
|
||||
)
|
||||
},
|
||||
)
|
||||
assert reg.validate_frontmatter_schema() == {}
|
||||
|
||||
def test_missing_required_fields(self, tmp_path: Path):
|
||||
reg = _registry(
|
||||
tmp_path,
|
||||
{"agent-x.md": "---\nname: x\ncategory: testing\n---\nbody\n"},
|
||||
)
|
||||
errors = reg.validate_frontmatter_schema()["agent-x.md"]
|
||||
assert any("description" in e for e in errors)
|
||||
|
||||
def test_invalid_category(self, tmp_path: Path):
|
||||
reg = _registry(
|
||||
tmp_path,
|
||||
{
|
||||
"agent-x.md": (
|
||||
"---\nname: x\ndescription: d\ncategory: nonsense\n---\nb\n"
|
||||
)
|
||||
},
|
||||
)
|
||||
errors = reg.validate_frontmatter_schema()["agent-x.md"]
|
||||
assert any("invalid category" in e for e in errors)
|
||||
|
||||
def test_invalid_memory(self, tmp_path: Path):
|
||||
reg = _registry(
|
||||
tmp_path,
|
||||
{
|
||||
"agent-x.md": (
|
||||
"---\nname: x\ndescription: d\ncategory: testing\n"
|
||||
"memory: maybe\n---\nb\n"
|
||||
)
|
||||
},
|
||||
)
|
||||
errors = reg.validate_frontmatter_schema()["agent-x.md"]
|
||||
assert any("invalid memory" in e for e in errors)
|
||||
|
||||
def test_missing_frontmatter(self, tmp_path: Path):
|
||||
reg = _registry(tmp_path, {"agent-x.md": "just text, no frontmatter\n"})
|
||||
assert reg.validate_frontmatter_schema()["agent-x.md"] == [
|
||||
"missing YAML frontmatter"
|
||||
]
|
||||
@@ -96,7 +96,20 @@ ActivityDefinition reference copies (sync into activity-core to activate):
|
||||
- [post-install-metrics-scaffold](../docs/integrations/activity-definitions/post-install-metrics-scaffold.md)
|
||||
- [low-success-rate-review](../docs/integrations/activity-definitions/low-success-rate-review.md)
|
||||
|
||||
**Workplan:** KAIZEN-WP-0004 Part 2. Patterns: [docs/INTEGRATION_PATTERNS.md](../docs/INTEGRATION_PATTERNS.md).
|
||||
**Scheduled agent execution (WP-0006, ADR-005)** — run agents (not just the
|
||||
metrics optimizer) on a cadence against a preselected repo roster:
|
||||
|
||||
- [weekly-coach-orientation](../docs/integrations/activity-definitions/weekly-coach-orientation.md)
|
||||
- [weekly-optimization-review](../docs/integrations/activity-definitions/weekly-optimization-review.md)
|
||||
- Resolver spec: [discover-kaizen-scheduled-repos](../docs/integrations/discover-kaizen-scheduled-repos.md)
|
||||
- Roster fields: [state-hub-roster-fields](../docs/integrations/state-hub-roster-fields.md)
|
||||
- Handoff checklist: [activity-core-handoff-wp0006](../docs/integrations/activity-core-handoff-wp0006.md)
|
||||
|
||||
A repo opts in by committing `.kaizen/schedule.yml` (`kaizen-agentic schedule
|
||||
init`); activity-core fires the cron and creates a task per `(repo, agent)` that
|
||||
runs `kaizen-agentic schedule prepare <agent>`.
|
||||
|
||||
**Workplan:** KAIZEN-WP-0004 Part 2 + KAIZEN-WP-0006. Patterns: [docs/INTEGRATION_PATTERNS.md](../docs/INTEGRATION_PATTERNS.md).
|
||||
|
||||
### artifact-store (P1)
|
||||
|
||||
@@ -194,4 +207,4 @@ WP-0001 T04. Assess before depending on it.
|
||||
Persisted in `history/`:
|
||||
|
||||
- `2026-06-16-intent-gap-analysis.md`
|
||||
- `2026-06-16-ecosystem-assessment.md`
|
||||
- `2026-06-16-ecosystem-assessment.md`
|
||||
|
||||
@@ -9,7 +9,104 @@ owner: kaizen-agentic
|
||||
topic_slug: custodian
|
||||
state_hub_workstream_id: 36252a45-f360-4496-bf77-17b5dfb02767
|
||||
created: "2026-06-16"
|
||||
updated: "2026-06-18"
|
||||
updated: "2026-06-17"
|
||||
tasks:
|
||||
- id: T01
|
||||
title: Write ADR-004 project metrics convention
|
||||
status: done
|
||||
state_hub_task_id: 4e7b0fd2-38c0-46aa-84a7-bb18366b8c7c
|
||||
- id: T02
|
||||
title: Implement MetricsStore in metrics.py
|
||||
status: done
|
||||
state_hub_task_id: eeaa99c7-d7a7-403b-a013-364cba45a663
|
||||
- id: T03
|
||||
title: Add memory init hook to scaffold metrics directory
|
||||
status: done
|
||||
state_hub_task_id: 247c097f-de89-4383-930c-35ee66de9b36
|
||||
- id: T04
|
||||
title: Unit tests for MetricsStore
|
||||
status: done
|
||||
state_hub_task_id: 3aa14026-6ee3-4384-b409-11300c1302f0
|
||||
- id: T05
|
||||
title: Implement metrics CLI command group
|
||||
status: done
|
||||
state_hub_task_id: 6b505d29-7d2e-44a2-a4b7-1fe82884390c
|
||||
- id: T06
|
||||
title: Integrate metrics record into session-close template
|
||||
status: done
|
||||
state_hub_task_id: 84f2a357-f2dd-4fc7-96b6-a4e80d5467a7
|
||||
- id: T07
|
||||
title: CLI tests for metrics commands
|
||||
status: done
|
||||
state_hub_task_id: 8e9ee64b-b7c4-4dff-ac6e-988fd47ef95d
|
||||
- id: T08
|
||||
title: Update CLI cheat sheet and agency-framework with metrics
|
||||
status: done
|
||||
state_hub_task_id: 4c41e0db-d5d8-4a1b-b346-06ad004edf4a
|
||||
- id: T09
|
||||
title: Add OptimizationLoop.from_metrics_store factory
|
||||
status: done
|
||||
state_hub_task_id: 0b374439-6eca-4754-8e15-2a7eece0cd27
|
||||
- id: T10
|
||||
title: Implement kaizen-agentic metrics optimize command
|
||||
status: done
|
||||
state_hub_task_id: db87a09b-0252-495c-a771-a43b4b98f820
|
||||
- id: T11
|
||||
title: Consolidate optimization meta-agent definitions
|
||||
status: done
|
||||
state_hub_task_id: 73cb7d73-6fc6-42a9-97aa-d33cdf9ee363
|
||||
- id: T12
|
||||
title: Update optimization agent session protocol
|
||||
status: done
|
||||
state_hub_task_id: c127eca7-7394-42db-ba5e-721aef0ccb76
|
||||
- id: T13
|
||||
title: Unit and integration tests for optimizer recommendations
|
||||
status: done
|
||||
state_hub_task_id: f208dc9f-cdf7-47e3-9c03-09097e46eee9
|
||||
- id: T14
|
||||
title: Extend memory brief with metrics summary
|
||||
status: done
|
||||
state_hub_task_id: d01f969c-bbb1-4eca-a4f1-d79d5c867b35
|
||||
- id: T15
|
||||
title: Extend agent-coach.md for metrics context
|
||||
status: done
|
||||
state_hub_task_id: 67f791a4-fced-4986-a331-7eb4ea47fe6e
|
||||
- id: T16
|
||||
title: E2e test memory brief with metrics sections
|
||||
status: done
|
||||
state_hub_task_id: 1fb89b54-8bd2-40bf-9a71-04693cb9f695
|
||||
- id: T17
|
||||
title: Add metrics section to agent-tdd-workflow.md
|
||||
status: done
|
||||
state_hub_task_id: 1d471a7a-9a98-4805-903e-b4a2b8153717
|
||||
- id: T18
|
||||
title: Add session-close metrics record step to tdd-workflow
|
||||
status: done
|
||||
state_hub_task_id: abb387f1-86ce-4b9b-a516-2d4efb6aca4c
|
||||
- id: T19
|
||||
title: Document tdd-workflow pilot in wiki/AboutKaizenAgents.md
|
||||
status: done
|
||||
state_hub_task_id: 67fbc26e-a57d-4133-96e6-3d2cdbd10dc0
|
||||
- id: T20
|
||||
title: E2e test full tdd-workflow measure-analyse-orient loop
|
||||
status: done
|
||||
state_hub_task_id: fbdd7c8b-e122-48d9-8c8f-de9f82d025e3
|
||||
- id: T21
|
||||
title: Sync 4 missing agents into packaged data/
|
||||
status: done
|
||||
state_hub_task_id: 9662bcec-34fe-451b-b61f-5d11b9574576
|
||||
- id: T22
|
||||
title: Update README orientation links to INTENT and wiki
|
||||
status: done
|
||||
state_hub_task_id: 422aae43-5697-4a00-86e9-1569baf09422
|
||||
- id: T23
|
||||
title: Update architecture.md agent table
|
||||
status: done
|
||||
state_hub_task_id: ba6b3411-d330-4a58-8cd0-62b4fbef8c5f
|
||||
- id: T24
|
||||
title: CHANGELOG entry for metrics convention and CLI
|
||||
status: done
|
||||
state_hub_task_id: 748be9f3-f6ac-4f26-a844-6330268935b6
|
||||
---
|
||||
|
||||
# KAIZEN-WP-0003 — Measurement Loop: Metrics Convention, Collection, and Optimizer Integration
|
||||
@@ -249,6 +346,23 @@ A reader of `INTENT.md` can point to this repo and say:
|
||||
|
||||
---
|
||||
|
||||
## Completion
|
||||
|
||||
**Shipped:** v1.1.0 (2026-06-18); measurement loop operational through v1.2.0.
|
||||
|
||||
| Milestone | Detail |
|
||||
|-----------|--------|
|
||||
| ADR-004 | Project metrics convention (`.kaizen/metrics/`) |
|
||||
| CLI | `metrics record`, `show`, `list`, `export`, `optimize` |
|
||||
| Coach bridge | `memory brief` includes `## Performance Summary` |
|
||||
| Pilot | `tdd-workflow` reference in `wiki/AboutKaizenAgents.md` |
|
||||
| Tests | `test_metrics*.py`, `test_optimization_metrics.py`, e2e agency tests pass |
|
||||
|
||||
All 24 tasks complete. Fleet-wide template conformance and scheduled optimizer runs
|
||||
remain out of scope (future workplans).
|
||||
|
||||
---
|
||||
|
||||
## State Hub Task IDs
|
||||
|
||||
| Code | UUID |
|
||||
@@ -286,4 +400,4 @@ A reader of `INTENT.md` can point to this repo and say:
|
||||
|
||||
- Retention default: 180 days (per `wiki/AgentKaizenOptimizer.md`); override via project config in a later iteration
|
||||
- WP-0001 T04 (telemetry) should consume ADR-004 schema rather than inventing a parallel format
|
||||
- `OptimizationLoop` threshold constants (30s execution, 0.8 success rate) are starting points; expose in config later
|
||||
- `OptimizationLoop` threshold constants (30s execution, 0.8 success rate) are starting points; expose in config later
|
||||
|
||||
@@ -9,7 +9,84 @@ owner: kaizen-agentic
|
||||
topic_slug: custodian
|
||||
state_hub_workstream_id: 76be7294-e201-4074-91c0-6421992470fe
|
||||
created: "2026-06-16"
|
||||
updated: "2026-06-18"
|
||||
updated: "2026-06-17"
|
||||
tasks:
|
||||
- id: T01
|
||||
title: Document Helix Forge correlation contract cross-repo
|
||||
status: done
|
||||
state_hub_task_id: f365d19e-9619-4453-bebf-f1fd596b1bd1
|
||||
- id: T02
|
||||
title: Add HELIX_SESSION_UID to metrics record
|
||||
status: done
|
||||
state_hub_task_id: e7f47683-5957-49db-bcbd-3aa47f44a073
|
||||
- id: T03
|
||||
title: Add kaizen-agentic metrics correlate command stub
|
||||
status: done
|
||||
state_hub_task_id: 6ef8ba99-7d0c-44f4-835d-7a66e9d55984
|
||||
- id: T04
|
||||
title: Integration test for helix_session_uid correlation
|
||||
status: done
|
||||
state_hub_task_id: 9875422c-a54b-40f1-a444-6b485a9e57d6
|
||||
- id: T05
|
||||
title: Update EcosystemIntegration.md with worked example
|
||||
status: done
|
||||
state_hub_task_id: 0dc33d13-0e0b-4336-a7ad-371fc533b823
|
||||
- id: T06
|
||||
title: Draft weekly metrics optimize ActivityDefinition
|
||||
status: done
|
||||
state_hub_task_id: dbaa5f46-f66a-4a74-b4a0-97978e47d1c3
|
||||
- id: T07
|
||||
title: Draft post-install metrics scaffold ActivityDefinition
|
||||
status: done
|
||||
state_hub_task_id: 161a264a-8f70-4e37-a854-bd5a76a0e54b
|
||||
- id: T08
|
||||
title: Draft low success_rate review ActivityDefinition
|
||||
status: done
|
||||
state_hub_task_id: 3b58ad38-839c-436a-8d97-ef5a8f9beefe
|
||||
- id: T09
|
||||
title: Document activity-core triggers in INTEGRATION_PATTERNS.md
|
||||
status: done
|
||||
state_hub_task_id: a004b60f-4e8f-4881-b088-229ac9ab242f
|
||||
- id: T10
|
||||
title: Smoke test activity-core activation
|
||||
status: done
|
||||
state_hub_task_id: 84866bf1-5830-470d-87a5-9786222332c2
|
||||
- id: T11
|
||||
title: Define optimizer artifact package manifest
|
||||
status: done
|
||||
state_hub_task_id: 033a19db-fbd2-411f-9d2e-779d210400d4
|
||||
- id: T12
|
||||
title: Add kaizen-agentic metrics publish command
|
||||
status: done
|
||||
state_hub_task_id: 54517f2b-23e3-433b-a483-c59227625dbc
|
||||
- id: T13
|
||||
title: Map raw-evidence retention class in publish manifest
|
||||
status: done
|
||||
state_hub_task_id: 3b378789-a761-4472-b072-a346541be239
|
||||
- id: T14
|
||||
title: Integration test artifact-store publish
|
||||
status: done
|
||||
state_hub_task_id: a3566713-db58-4519-b9c4-5003421c1f1e
|
||||
- id: T15
|
||||
title: Document publish workflow in agency-framework.md
|
||||
status: done
|
||||
state_hub_task_id: 5d8255aa-fd7a-4fe6-bce2-3a176f954c7f
|
||||
- id: T16
|
||||
title: Map KaizenAgentTemplate to info-tech-canon profile outline
|
||||
status: done
|
||||
state_hub_task_id: 852c9cbf-0b0c-4f23-8594-905ca280c268
|
||||
- id: T17
|
||||
title: Draft info-tech-canon agent brief for tdd-workflow
|
||||
status: done
|
||||
state_hub_task_id: 62e05097-9033-401d-bbe0-d5d773da50fe
|
||||
- id: T18
|
||||
title: Spike kontextual-engine wiki ingestion manifest
|
||||
status: done
|
||||
state_hub_task_id: cd6962c7-aaed-4d7d-81de-37c0e3ed715e
|
||||
- id: T19
|
||||
title: Update ecosystem assessment with Part 4 outcomes
|
||||
status: done
|
||||
state_hub_task_id: 2c1f66f5-e6ab-4e19-88ca-818acb15a706
|
||||
---
|
||||
|
||||
# KAIZEN-WP-0004 — Ecosystem Integration: Helix Forge, activity-core, and artifact-store
|
||||
@@ -154,6 +231,21 @@ Estimated effort: 3–5 sessions after WP-0003 Part 3.
|
||||
|
||||
---
|
||||
|
||||
## Completion
|
||||
|
||||
**Shipped:** v1.1.0–v1.2.0 ecosystem integration layer.
|
||||
|
||||
| Part | Outcome |
|
||||
|------|---------|
|
||||
| 1 Helix | `HELIX_SESSION_UID` on `metrics record`, `metrics correlate`, bidirectional docs |
|
||||
| 2 activity-core | Three ActivityDefinitions under `docs/integrations/activity-definitions/` |
|
||||
| 3 artifact-store | `metrics publish` with `raw-evidence` retention manifest |
|
||||
| 4 Canon/knowledge | Design docs for info-tech-canon and kontextual-engine (no runtime deps) |
|
||||
|
||||
All 19 tasks complete. Reciprocal Helix link verified in WP-0005 T16.
|
||||
|
||||
---
|
||||
|
||||
## State Hub Task IDs
|
||||
|
||||
| Code | UUID |
|
||||
@@ -187,4 +279,4 @@ Estimated effort: 3–5 sessions after WP-0003 Part 3.
|
||||
- ADR-004 Helix Forge correlation section is the authoritative field mapping
|
||||
- WP-0001 T04 (telemetry) should evaluate tele-mcp as adapter candidate
|
||||
- activity-core ActivityDefinitions live in activity-core repo per ACT-ADR-002/003;
|
||||
kaizen-agentic commits reference copies or links under `docs/integrations/`
|
||||
kaizen-agentic commits reference copies or links under `docs/integrations/`
|
||||
|
||||
270
workplans/kaizen-agentic-WP-0005-adoption-parity.md
Normal file
270
workplans/kaizen-agentic-WP-0005-adoption-parity.md
Normal file
@@ -0,0 +1,270 @@
|
||||
---
|
||||
id: KAIZEN-WP-0005
|
||||
type: workplan
|
||||
title: "Adoption Polish and Fleet Parity (v1.2.0)"
|
||||
domain: custodian
|
||||
repo: kaizen-agentic
|
||||
status: completed
|
||||
owner: kaizen-agentic
|
||||
topic_slug: custodian
|
||||
state_hub_workstream_id: 88c7b3e6-be98-480c-b47b-936e74a1a31b
|
||||
created: "2026-06-16"
|
||||
updated: "2026-06-17"
|
||||
tasks:
|
||||
- id: T01
|
||||
title: Configure PACKAGE_USER and PACKAGE_TOKEN in Gitea
|
||||
status: done
|
||||
state_hub_task_id: 1fb6b04e-0854-4cc9-83c7-5abf85fe5bff
|
||||
- id: T02
|
||||
title: Smoke-test publish-python-package workflow
|
||||
status: done
|
||||
state_hub_task_id: bdb9e463-bdfb-405c-afc4-e93a7d58a18b
|
||||
- id: T03
|
||||
title: Add pre-tag release checklist to PACKAGE_RELEASE.md
|
||||
status: done
|
||||
state_hub_task_id: 6a2132e7-8b3f-4960-a5e8-85bad81e8b13
|
||||
- id: T04
|
||||
title: Update HELLO_WORLD_TUTORIAL.md Gitea install paths
|
||||
status: done
|
||||
state_hub_task_id: 553cba3a-dafa-483a-9200-70ac3f5eb2d7
|
||||
- id: T05
|
||||
title: Update CLI_CHEAT_SHEET.md Gitea install paths
|
||||
status: done
|
||||
state_hub_task_id: 7e6663a5-fedf-4b1c-acd9-6df6b43d8a12
|
||||
- id: T06
|
||||
title: Update AGENT_DISTRIBUTION.md Gitea install paths
|
||||
status: done
|
||||
state_hub_task_id: fe553788-357f-45c4-8400-f764f68c1cde
|
||||
- id: T07
|
||||
title: Update Makefile agents-* install fallback messages
|
||||
status: done
|
||||
state_hub_task_id: b131ff67-fe21-4d95-904b-6a0b916c5502
|
||||
- id: T08
|
||||
title: Cross-link CONTRIBUTING.md with PACKAGE_RELEASE.md
|
||||
status: done
|
||||
state_hub_task_id: 07dd4d25-250c-455c-8363-49269d2ee59f
|
||||
- id: T09
|
||||
title: Add make agents-sync-package target
|
||||
status: done
|
||||
state_hub_task_id: 7437cedd-5f7e-4c4d-9142-4f67470c9e52
|
||||
- id: T10
|
||||
title: Add release-check parity test agents vs data/agents
|
||||
status: done
|
||||
state_hub_task_id: ddbe2114-7a47-48fd-a145-b22dca2b581a
|
||||
- id: T11
|
||||
title: Refresh SCOPE.md agent-count notes
|
||||
status: done
|
||||
state_hub_task_id: 5417524f-03c0-40ed-a48b-a7906e6daf8f
|
||||
- id: T12
|
||||
title: Refresh TODO.md for v1.2.0
|
||||
status: done
|
||||
state_hub_task_id: 5cfad56c-2664-4b2d-b5f9-4792c958c9a2
|
||||
- id: T13
|
||||
title: Open CHANGELOG Unreleased for v1.2.0
|
||||
status: done
|
||||
state_hub_task_id: fbca9be4-3d2b-4989-baaf-97e6926bdc66
|
||||
- id: T14
|
||||
title: Add flake8 to Gitea CI workflow
|
||||
status: done
|
||||
state_hub_task_id: a6966cfa-ca59-4087-8989-2870dc69b13f
|
||||
- id: T15
|
||||
title: Document activity-core ActivityDefinition registration handoff
|
||||
status: done
|
||||
state_hub_task_id: fbf3f1a8-4818-473e-ae0d-cd80118e5319
|
||||
- id: T16
|
||||
title: Verify bidirectional Helix correlation doc link
|
||||
status: done
|
||||
state_hub_task_id: 37679ce7-dcb6-42a4-820d-cf8b32c2a248
|
||||
---
|
||||
|
||||
# KAIZEN-WP-0005 — Adoption Polish and Fleet Parity
|
||||
|
||||
**Status:** completed
|
||||
**Owner:** kaizen-agentic
|
||||
**Repo:** kaizen-agentic
|
||||
**Target version:** 1.2.0
|
||||
**Depends on:** WP-0001 (v1.1.0 ship), WP-0004 (ecosystem integration docs)
|
||||
|
||||
## Goal
|
||||
|
||||
Close adoption gaps after the v1.1.0 release: verify the Gitea publish pipeline,
|
||||
align all install documentation with the Coulomb registry, enforce packaged-agent
|
||||
parity with `agents/`, and harden CI so v1.2.0 ships with confidence.
|
||||
|
||||
WP-0001 through WP-0004 delivered features; WP-0005 makes them **discoverable,
|
||||
installable, and maintainable** for ecosystem consumers.
|
||||
|
||||
---
|
||||
|
||||
## Part 1 — Publish Pipeline Verification
|
||||
|
||||
Confirm tag-triggered publication works end-to-end before the v1.2.0 cut.
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T01 — Configure `PACKAGE_USER` (`tegwick`) and `PACKAGE_TOKEN` (OpenBao `inter-hub-pkg-rep` token) in Gitea
|
||||
- [x] T02 — Smoke-test `.gitea/workflows/publish-python-package.yml` via `workflow_dispatch` (auth OK; 409 on re-upload of 1.1.0)
|
||||
- [x] T03 — Add pre-tag release checklist to `docs/PACKAGE_RELEASE.md` (secrets, `make package-check`, tag format)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- Publish workflow succeeds without manual `twine upload`
|
||||
- `docs/PACKAGE_RELEASE.md` documents the full operator path
|
||||
|
||||
---
|
||||
|
||||
## Part 2 — Install Documentation Sync
|
||||
|
||||
Several docs still show bare `pip install kaizen-agentic` (pre-Gitea registry).
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T04 — Update `docs/HELLO_WORLD_TUTORIAL.md` install sections (Gitea extra index + pipx)
|
||||
- [x] T05 — Update `docs/CLI_CHEAT_SHEET.md` install sections
|
||||
- [x] T06 — Update `docs/AGENT_DISTRIBUTION.md` install and distribution sections
|
||||
- [x] T07 — Update Makefile `agents-*` fallback messages to point at dev install or `PACKAGE_RELEASE.md`
|
||||
- [x] T08 — Cross-link `CONTRIBUTING.md` post-pull reinstall with `docs/PACKAGE_RELEASE.md`
|
||||
|
||||
### Definition of done
|
||||
|
||||
- No consumer-facing doc implies public pypi.org is the primary install path
|
||||
- All install examples use env-var credentials (no committed tokens)
|
||||
|
||||
---
|
||||
|
||||
## Part 3 — Packaged Fleet Parity
|
||||
|
||||
Ensure `pip install` ships the same agent fleet as `agents/`.
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T09 — Add `make agents-sync-package` (copy `agents/agent-*.md` → `data/agents/`) with dry-run mode
|
||||
- [x] T10 — Add pytest or `release-check` step verifying `agents/` and `data/agents/` file sets match
|
||||
- [x] T11 — Refresh `SCOPE.md` notes and agent-count references (currently stale at 16 vs 20)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- `make release-check` fails when packaged agents drift from source
|
||||
- Wheel contents match canonical `agents/` directory
|
||||
|
||||
---
|
||||
|
||||
## Part 4 — Release Hygiene and CI
|
||||
|
||||
Prepare v1.2.0 versioning and strengthen automated gates.
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T12 — Refresh `TODO.md`: archive 1.1.0 items, point `[Unreleased]` at this workplan
|
||||
- [x] T13 — Open `CHANGELOG.md` `[Unreleased]` section for v1.2.0 tracking
|
||||
- [x] T14 — Extend `.gitea/workflows/ci.yml` with flake8 (`release-check` lint subset on `src/`)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- `TODO.md` reflects current vibe-coding state only
|
||||
- CI catches lint regressions before merge
|
||||
|
||||
---
|
||||
|
||||
## Part 5 — Ecosystem Handoff (coordination)
|
||||
|
||||
Cross-repo follow-through from WP-0004; no foreign code in this repo.
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T15 — Document activity-core ActivityDefinition registration steps in `docs/INTEGRATION_PATTERNS.md` (handoff checklist for activity-core owners)
|
||||
- [x] T16 — Verify bidirectional Helix correlation doc link with agentic-resources (reciprocal link added in `DESIGN-session-memory.md` §11)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- Operators know how to activate the three ActivityDefinitions committed under `docs/integrations/activity-definitions/`
|
||||
- Helix correlation is linked from both repos
|
||||
|
||||
---
|
||||
|
||||
## Sequencing
|
||||
|
||||
```
|
||||
Part 1 (T01–T03) ──→ can run in parallel with Part 2
|
||||
│
|
||||
Part 2 (T04–T08) ──→ Part 4 (T12–T13) doc hygiene
|
||||
│
|
||||
Part 3 (T09–T11) ──→ gates v1.2.0 tag
|
||||
│
|
||||
Part 4 (T14) ──→ before v1.2.0 merge freeze
|
||||
│
|
||||
Part 5 (T15–T16) ──→ non-blocking; parallel with Parts 2–4
|
||||
```
|
||||
|
||||
Estimated effort: 2–4 sessions.
|
||||
|
||||
---
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- Public pypi.org publication (optional; Gitea registry remains primary)
|
||||
- Interactive agent selection wizard (defer to WP-0006)
|
||||
- Full `KaizenAgentTemplate.md` schema enforcement in `validate` (defer to WP-0006)
|
||||
- Automated documentation generation from agent metadata
|
||||
- Owning activity-core, agentic-resources, or artifact-store code
|
||||
|
||||
---
|
||||
|
||||
## Success Criteria
|
||||
|
||||
1. Tag `v1.2.0` triggers Gitea PyPI publish without manual intervention.
|
||||
2. A new consumer can install from docs alone (no tribal knowledge about extra index).
|
||||
3. Packaged wheel agent fleet cannot drift silently from `agents/`.
|
||||
4. WP-0004 ecosystem artifacts have clear operator handoff paths.
|
||||
|
||||
---
|
||||
|
||||
## Completion
|
||||
|
||||
**Shipped:** v1.2.0 on 2026-06-16
|
||||
|
||||
| Milestone | Detail |
|
||||
|-----------|--------|
|
||||
| Release commit | `297afed` — adoption polish and publish pipeline |
|
||||
| Tag | `v1.2.0` pushed to Gitea |
|
||||
| Publish | Gitea Actions run **3044** — `kaizen_agentic-1.2.0` wheel + sdist uploaded |
|
||||
| Publish auth | `PACKAGE_USER=tegwick`, token from OpenBao `inter-hub-pkg-rep` |
|
||||
| Helix handoff | Reciprocal link in `agentic-resources/docs/DESIGN-session-memory.md` §11 |
|
||||
|
||||
All 16 tasks complete. Deferred items (agent wizard, template validation, doc generation)
|
||||
tracked for **WP-0006** (v1.3.0).
|
||||
|
||||
---
|
||||
|
||||
## State Hub Task IDs
|
||||
|
||||
| Code | UUID |
|
||||
|------|------|
|
||||
| T01 | 1fb6b04e-0854-4cc9-83c7-5abf85fe5bff |
|
||||
| T02 | bdb9e463-bdfb-405c-afc4-e93a7d58a18b |
|
||||
| T03 | 6a2132e7-8b3f-4960-a5e8-85bad81e8b13 |
|
||||
| T04 | 553cba3a-dafa-483a-9200-70ac3f5eb2d7 |
|
||||
| T05 | 7e6663a5-fedf-4b1c-acd9-6df6b43d8a12 |
|
||||
| T06 | fe553788-357f-45c4-8400-f764f68c1cde |
|
||||
| T07 | b131ff67-fe21-4d95-904b-6a0b916c5502 |
|
||||
| T08 | 07dd4d25-250c-455c-8363-49269d2ee59f |
|
||||
| T09 | 7437cedd-5f7e-4c4d-9142-4f67470c9e52 |
|
||||
| T10 | ddbe2114-7a47-48fd-a145-b22dca2b581a |
|
||||
| T11 | 5417524f-03c0-40ed-a48b-a7906e6daf8f |
|
||||
| T12 | 5cfad56c-2664-4b2d-b5f9-4792c958c9a2 |
|
||||
| T13 | fbca9be4-3d2b-4989-baaf-97e6926bdc66 |
|
||||
| T14 | a6966cfa-ca59-4087-8989-2870dc69b13f |
|
||||
| T15 | fbf3f1a8-4818-473e-ae0d-cd80118e5319 |
|
||||
| T16 | 37679ce7-dcb6-42a4-820d-cf8b32c2a248 |
|
||||
|
||||
**Hub workstream:** `kaizen-wp-0005-adoption-parity` (`88c7b3e6-be98-480c-b47b-936e74a1a31b`)
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- Deferred from TODO.md [1.1.0]: agent selection wizard, template schema validation,
|
||||
doc generation automation → candidate **WP-0006** (v1.3.0)
|
||||
- `make agents-update` updates project-installed agents via CLI; it does **not**
|
||||
sync `agents/` → `data/agents/` — T09 addresses that gap explicitly
|
||||
- Part 1 T01 requires Gitea UI access (human step); automation cannot set secrets
|
||||
368
workplans/kaizen-agentic-WP-0006-scheduled-agent-execution.md
Normal file
368
workplans/kaizen-agentic-WP-0006-scheduled-agent-execution.md
Normal file
@@ -0,0 +1,368 @@
|
||||
---
|
||||
id: KAIZEN-WP-0006
|
||||
type: workplan
|
||||
title: "Scheduled Agent Execution via activity-core (v1.3.0)"
|
||||
domain: custodian
|
||||
repo: kaizen-agentic
|
||||
status: done
|
||||
owner: kaizen-agentic
|
||||
topic_slug: custodian
|
||||
state_hub_workstream_id: d4edb92b-526f-4ee4-8efe-a9fa84ab6dff
|
||||
depends_on:
|
||||
- KAIZEN-WP-0003
|
||||
- KAIZEN-WP-0004
|
||||
created: "2026-06-17"
|
||||
updated: "2026-06-17"
|
||||
tasks:
|
||||
- id: T01
|
||||
state_hub_task_id: f513cf74-6e32-4dce-a3bc-2995f98a30de
|
||||
status: done
|
||||
title: Write ADR-005 scheduled agent execution contract
|
||||
- id: T02
|
||||
state_hub_task_id: dcb8d674-5472-4657-85bc-02ca9890fb92
|
||||
status: done
|
||||
title: Define .kaizen/schedule.yml schema and example
|
||||
- id: T03
|
||||
state_hub_task_id: 1f9a4959-d200-4d7b-8666-96472e23d820
|
||||
status: done
|
||||
title: Add kaizen-agentic schedule validate command
|
||||
- id: T04
|
||||
state_hub_task_id: 13ab4b76-ded2-4613-b8e2-15ab206d8c57
|
||||
status: done
|
||||
title: Document fleet roster and repo opt-in in INTEGRATION_PATTERNS
|
||||
- id: T05
|
||||
state_hub_task_id: 685b35f3-af20-483a-9136-150f5fff68dd
|
||||
status: done
|
||||
title: Draft state-hub roster query design for activity-core resolver
|
||||
- id: T06
|
||||
state_hub_task_id: 5f0a0859-3ff5-4ec8-b916-35486f045b2b
|
||||
status: done
|
||||
title: Draft discover_kaizen_scheduled_repos context resolver spec
|
||||
- id: T07
|
||||
state_hub_task_id: 2fd0f00c-5cf1-47bd-9c12-aee65bca5932
|
||||
status: done
|
||||
title: Draft weekly-agent-run ActivityDefinition template
|
||||
- id: T08
|
||||
state_hub_task_id: cc0565bc-ccd4-4739-9c7e-088adaa9834b
|
||||
status: done
|
||||
title: Open activity-core handoff issue for resolver and definitions
|
||||
- id: T09
|
||||
state_hub_task_id: 23aeff77-3429-438b-a395-5c7b5dc2824e
|
||||
status: done
|
||||
title: Implement kaizen-agentic schedule prepare command
|
||||
- id: T10
|
||||
state_hub_task_id: cba9685b-408f-4292-8169-9965e7ad5c5b
|
||||
status: done
|
||||
title: Bundle memory brief metrics and agent prompt in prepare output
|
||||
- id: T11
|
||||
state_hub_task_id: 7c1b049b-5566-4b5e-9d82-d9c29fab0c84
|
||||
status: done
|
||||
title: Add schedule init scaffold for new repos
|
||||
- id: T12
|
||||
state_hub_task_id: 80a8e98a-9146-4a58-8fd3-8c37f7893960
|
||||
status: done
|
||||
title: Unit tests for schedule validate and prepare
|
||||
- id: T13
|
||||
state_hub_task_id: 9aee6348-d5ad-4413-b01c-5588b07c8ede
|
||||
status: done
|
||||
title: Pilot ActivityDefinition for weekly coach on custodian repos
|
||||
- id: T14
|
||||
state_hub_task_id: 697e612b-7531-4329-82fb-b0423ba86904
|
||||
status: done
|
||||
title: Pilot ActivityDefinition for weekly optimization review
|
||||
- id: T15
|
||||
state_hub_task_id: 92db5130-2212-4780-ab8f-1de3adf6c6f8
|
||||
status: done
|
||||
title: Smoke test end-to-end on two preselected repos
|
||||
- id: T16
|
||||
state_hub_task_id: bbecdcbf-42b8-4b48-9f85-e4c10e4ff3ab
|
||||
status: done
|
||||
title: Document operator enablement in PACKAGE_RELEASE and agency-framework
|
||||
- id: T17
|
||||
state_hub_task_id: a9e91d4b-990a-457a-9591-d1243db5b386
|
||||
status: done
|
||||
title: Emit kaizen.schedule.prepared event payload spec for activity-core
|
||||
- id: T18
|
||||
state_hub_task_id: 73986472-bf19-4b13-af1b-6505ab944459
|
||||
status: done
|
||||
title: Update wiki/EcosystemIntegration.md and CHANGELOG for v1.3.0
|
||||
---
|
||||
|
||||
# KAIZEN-WP-0006 — Scheduled Agent Execution via activity-core
|
||||
|
||||
**Status:** done
|
||||
**Owner:** kaizen-agentic
|
||||
**Repo:** kaizen-agentic
|
||||
**Target version:** 1.3.0
|
||||
**Depends on:** WP-0003 (metrics CLI), WP-0004 Part 2 (ActivityDefinition drafts)
|
||||
|
||||
## Goal
|
||||
|
||||
Enable kaizen agents to run **on a regular schedule** against **preselected repos**,
|
||||
orchestrated by **activity-core** and prepared by **kaizen-agentic** — without
|
||||
this repo owning Temporal workers or LLM runtime.
|
||||
|
||||
Today, agents are markdown instruction sets invoked in coding-agent sessions.
|
||||
WP-0004 committed three metrics-focused ActivityDefinitions (`enabled: false`) but
|
||||
no general **agent dispatch** path, no **repo roster**, and no **per-repo schedule
|
||||
manifest**. This workplan closes that gap.
|
||||
|
||||
### What “scheduled agent execution” means here
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
AC[activity-core cron] --> CR[context resolver]
|
||||
CR --> ROSTER[preselected repos]
|
||||
ROSTER --> RULE[ActivityDefinition rule]
|
||||
RULE --> TASK[hub task per repo+agent]
|
||||
TASK --> PREP[kaizen-agentic schedule prepare]
|
||||
PREP --> SESSION[coding-agent session]
|
||||
```
|
||||
|
||||
1. **activity-core** fires on cron (or event).
|
||||
2. A **context resolver** returns repos from the preselected roster that have a
|
||||
matching schedule entry and reachable `host_paths`.
|
||||
3. For each `(repo, agent)` pair, activity-core creates a **task** (State Hub /
|
||||
issue-core) with labels and a `schedule prepare` command.
|
||||
4. A coding agent (human or automated session) runs `kaizen-agentic schedule prepare`
|
||||
to assemble orientation: agent prompt, `memory brief`, metrics summary, repo
|
||||
context — then executes the agent instructions in that repo.
|
||||
|
||||
Kaizen-agentic does **not** invoke Claude directly; it **prepares** and **validates**
|
||||
the scheduled run contract.
|
||||
|
||||
---
|
||||
|
||||
## Background
|
||||
|
||||
| Layer | WP-0004 state | WP-0006 adds |
|
||||
|-------|---------------|--------------|
|
||||
| activity-core | Three proposed definitions (metrics only) | Agent-run definitions + roster resolver |
|
||||
| kaizen-agentic | CLI for metrics/memory | `schedule` command group + `.kaizen/schedule.yml` |
|
||||
| state-hub | Registered repos + `host_paths` | Fleet roster opt-in + schedule metadata |
|
||||
| Execution | Manual session | Cron → task → prepared session bundle |
|
||||
|
||||
**Prior WP-0006 placeholder** (agent wizard, template validation, doc generation)
|
||||
moves to **KAIZEN-WP-0007**.
|
||||
|
||||
---
|
||||
|
||||
## Part 1 — Schedule Contract (repo-local)
|
||||
|
||||
Declare which agents run how often in each opted-in repo.
|
||||
|
||||
### `.kaizen/schedule.yml` (draft shape)
|
||||
|
||||
```yaml
|
||||
version: "1"
|
||||
timezone: Europe/Berlin
|
||||
agents:
|
||||
coach:
|
||||
cadence: weekly
|
||||
cron: "0 9 * * 1" # optional override; default from ActivityDefinition
|
||||
enabled: true
|
||||
optimization:
|
||||
cadence: weekly
|
||||
cron: "0 10 * * 1"
|
||||
enabled: true
|
||||
tdd-workflow:
|
||||
cadence: monthly
|
||||
enabled: false
|
||||
```
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T01 — Write ADR-005: scheduled agent execution (roster, schedule file, dispatch, boundaries)
|
||||
- [x] T02 — Add `docs/integrations/schedule-schema.md` + example under `docs/examples/.kaizen/schedule.yml`
|
||||
- [x] T03 — Implement `kaizen-agentic schedule validate [--target PATH]` (schema + agent name checks)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- ADR-005 accepted; referenced from `docs/agency-framework.md`
|
||||
- Invalid schedule files fail validation with actionable errors
|
||||
- Only agents installed in the project (or fleet defaults) may appear in schedule
|
||||
|
||||
---
|
||||
|
||||
## Part 2 — Fleet Roster (preselected repos)
|
||||
|
||||
Define which registered repos participate in fleet scheduling.
|
||||
|
||||
### Roster sources (combined)
|
||||
|
||||
| Source | Purpose |
|
||||
|--------|---------|
|
||||
| State Hub `GET /repos/` | Canonical slug list + `host_paths` |
|
||||
| Repo opt-in | `.kaizen/schedule.yml` exists and `version` set |
|
||||
| Optional hub flag | `kaizen_schedule_enabled: true` in repo metadata (design in T05) |
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T04 — Extend `docs/INTEGRATION_PATTERNS.md` Pattern 2 with roster + schedule model
|
||||
- [x] T05 — Design doc: state-hub fields/filters for kaizen-scheduled repos (no state-hub code in this repo)
|
||||
- [x] T06 — Spec `discover_kaizen_scheduled_repos` resolver for activity-core (inputs, output shape, errors)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- Operators can list which repos are schedule-eligible without reading activity-core code
|
||||
- Resolver spec is sufficient for activity-core implementers to add adapter (separate repo PR)
|
||||
|
||||
---
|
||||
|
||||
## Part 3 — activity-core ActivityDefinitions (handoff)
|
||||
|
||||
Generalize WP-0004 metrics definitions into **agent-run** definitions.
|
||||
|
||||
### New reference definitions (kaizen-agentic commits drafts)
|
||||
|
||||
| Definition | Trigger | Agent | Prepare command |
|
||||
|------------|---------|-------|-----------------|
|
||||
| `weekly-coach-orientation` | Cron Mon 09:00 | `coach` | `schedule prepare coach` |
|
||||
| `weekly-optimization-review` | Cron Mon 10:00 | `optimization` | `schedule prepare optimization` |
|
||||
| `weekly-metrics-optimize` | *(existing)* | — | `metrics optimize` |
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T07 — Add `docs/integrations/activity-definitions/weekly-coach-orientation.md`
|
||||
- [x] T08 — Open activity-core coordination issue/PR checklist (resolver + sync + `enabled: false` pilot)
|
||||
- [x] T17 — Document `kaizen.schedule.prepared` event payload (for future event-driven runs)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- Definition files use `for_each` over resolver output `context.scheduled_runs`
|
||||
- Handoff checklist mirrors WP-0004 Pattern 2 activation steps
|
||||
- No scheduling code added to kaizen-agentic
|
||||
|
||||
---
|
||||
|
||||
## Part 4 — Dispatch Prepare CLI
|
||||
|
||||
Bridge schedule intent to session-executable orientation.
|
||||
|
||||
### Commands
|
||||
|
||||
```
|
||||
kaizen-agentic schedule validate [--target PATH]
|
||||
kaizen-agentic schedule init [--target PATH] # scaffold .kaizen/schedule.yml
|
||||
kaizen-agentic schedule prepare <agent> [--target PATH] [--format markdown|json]
|
||||
kaizen-agentic schedule list [--target PATH] # show enabled entries from schedule.yml
|
||||
```
|
||||
|
||||
`schedule prepare` outputs a single bundle:
|
||||
|
||||
- Agent markdown (from installed or packaged `agents/agent-<name>.md`)
|
||||
- `memory brief <agent>` output (if memory enabled)
|
||||
- `metrics show <agent>` summary (if metrics exist)
|
||||
- Repo SCOPE/TODO pointers when present
|
||||
- Suggested session-close commands (`metrics record`, memory update)
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T09 — Implement `schedule` CLI command group skeleton
|
||||
- [x] T10 — Wire `prepare` to memory + metrics + agent loader (reuse existing CLI internals)
|
||||
- [x] T11 — Implement `schedule init` with sensible defaults (coach + optimization weekly, disabled tdd-workflow)
|
||||
- [x] T12 — Tests for validate, init, prepare (temp repo fixtures)
|
||||
|
||||
### Definition of done
|
||||
|
||||
- `schedule prepare coach` prints non-empty orientation for a repo with agents installed
|
||||
- Prepare works offline (no State Hub required) given local `.kaizen/` state
|
||||
- CLI cheat sheet updated
|
||||
|
||||
---
|
||||
|
||||
## Part 5 — Pilot and Enablement
|
||||
|
||||
Prove the loop on a small custodian repo set before fleet-wide enable.
|
||||
|
||||
### Pilot roster (initial)
|
||||
|
||||
- `kaizen-agentic` (dogfood)
|
||||
- `the-custodian` (hub operator)
|
||||
- One additional custodian-domain repo with `.kaizen/` state (TBD at pilot time)
|
||||
|
||||
### Tasks
|
||||
|
||||
- [x] T13 — Commit pilot `weekly-coach-orientation` definition; map to custodian pilot repos
|
||||
- [x] T14 — Commit pilot `weekly-optimization-review` definition
|
||||
- [x] T15 — Smoke test: dry-run activity-core → manual `schedule prepare` on two repos → verify task payload
|
||||
- [x] T16 — Operator docs: credentials, PATH, Gitea index, enabling `enabled: true` in activity-core
|
||||
- [x] T18 — `wiki/EcosystemIntegration.md`, `CHANGELOG [Unreleased]`, `TODO.md` pointer
|
||||
|
||||
### Definition of done
|
||||
|
||||
- Two repos run through prepare successfully on a fixed schedule (manual or dry-run cron)
|
||||
- activity-core owners have a clear PR path to enable one definition in staging
|
||||
- Progress event recorded in State Hub at pilot completion
|
||||
|
||||
---
|
||||
|
||||
## Sequencing
|
||||
|
||||
```
|
||||
Part 1 (T01–T03) ──→ Part 4 (T09–T12) ──→ Part 5 (T13–T16)
|
||||
│ │
|
||||
Part 2 (T04–T06) ──→ Part 3 (T07–T08, T17)
|
||||
```
|
||||
|
||||
Parts 1–2 can start in parallel. Part 4 depends on ADR + schema. Part 5 depends
|
||||
on Part 3 drafts and Part 4 `prepare`. activity-core resolver implementation
|
||||
runs in **activity-core** (parallel track after T06 spec).
|
||||
|
||||
Estimated effort: 4–6 sessions (kaizen-agentic) + 1–2 sessions (activity-core handoff).
|
||||
|
||||
---
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- Implementing Temporal workflows or context resolvers in activity-core (handoff only)
|
||||
- Headless Claude Code / cloud agent runner integration (future; prepare output is runner-agnostic)
|
||||
- Scheduling all 20 agents fleet-wide in v1.3.0 (pilot: coach + optimization)
|
||||
- Replacing human review for high-risk agents (sys-medic, releaseManager)
|
||||
- WP-0007 items: agent selection wizard, template schema enforcement, doc generation
|
||||
|
||||
---
|
||||
|
||||
## Success Criteria
|
||||
|
||||
1. Operators declare a **preselected repo roster** and per-repo **schedules** without tribal knowledge.
|
||||
2. activity-core can fire recurring tasks that reference `kaizen-agentic schedule prepare <agent>`.
|
||||
3. A coding-agent session opened from a scheduled task has full orientation (memory + metrics + prompt).
|
||||
4. Pilot runs on ≥2 custodian repos demonstrate the cron → task → prepare path.
|
||||
|
||||
---
|
||||
|
||||
## State Hub Task IDs
|
||||
|
||||
| Code | UUID |
|
||||
|------|------|
|
||||
| T01 | f513cf74-6e32-4dce-a3bc-2995f98a30de |
|
||||
| T02 | dcb8d674-5472-4657-85bc-02ca9890fb92 |
|
||||
| T03 | 1f9a4959-d200-4d7b-8666-96472e23d820 |
|
||||
| T04 | 13ab4b76-ded2-4613-b8e2-15ab206d8c57 |
|
||||
| T05 | 685b35f3-af20-483a-9136-150f5fff68dd |
|
||||
| T06 | 5f0a0859-3ff5-4ec8-b916-35486f045b2b |
|
||||
| T07 | 2fd0f00c-5cf1-47bd-9c12-aee65bca5932 |
|
||||
| T08 | cc0565bc-ccd4-4739-9c7e-088adaa9834b |
|
||||
| T09 | 23aeff77-3429-438b-a395-5c7b5dc2824e |
|
||||
| T10 | cba9685b-408f-4292-8169-9965e7ad5c5b |
|
||||
| T11 | 7c1b049b-5566-4b5e-9d82-d9c29fab0c84 |
|
||||
| T12 | 80a8e98a-9146-4a58-8fd3-8c37f7893960 |
|
||||
| T13 | 9aee6348-d5ad-4413-b01c-5588b07c8ede |
|
||||
| T14 | 697e612b-7531-4329-82fb-b0423ba86904 |
|
||||
| T15 | 92db5130-2212-4780-ab8f-1de3adf6c6f8 |
|
||||
| T16 | bbecdcbf-42b8-4b48-9f85-e4c10e4ff3ab |
|
||||
| T17 | a9e91d4b-990a-457a-9591-d1243db5b386 |
|
||||
| T18 | 73986472-bf19-4b13-af1b-6505ab944459 |
|
||||
|
||||
**Hub workstream:** `kaizen-wp-0006-scheduled-agent-execution` (`d4edb92b-526f-4ee4-8efe-a9fa84ab6dff`)
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- WP-0004 `weekly-metrics-optimize` remains complementary; optimization agent schedule
|
||||
may chain `schedule prepare optimization` then `metrics optimize` in task description
|
||||
- `schedule prepare` output should be stable enough for activity-core task `description` templates
|
||||
- Repo boundary: state-hub schema changes tracked in the-custodian; kaizen-agentic owns ADR + CLI + definition drafts
|
||||
- Previous WP-0005 deferrals (wizard, validate schema, doc gen) → **KAIZEN-WP-0007**
|
||||
@@ -0,0 +1,131 @@
|
||||
---
|
||||
id: KAIZEN-WP-0007
|
||||
type: workplan
|
||||
title: "Agent Authoring & Doc Generation (v1.4.0)"
|
||||
domain: custodian
|
||||
repo: kaizen-agentic
|
||||
status: done
|
||||
owner: kaizen-agentic
|
||||
topic_slug: custodian
|
||||
state_hub_workstream_id: a8bc88a4-0ee3-44c6-aff5-9d7f54a316f5
|
||||
depends_on:
|
||||
- KAIZEN-WP-0006
|
||||
created: "2026-06-18"
|
||||
updated: "2026-06-18"
|
||||
tasks:
|
||||
- id: T01
|
||||
state_hub_task_id: debaf0ac-47df-4bbd-aa1f-96c7b96a64ed
|
||||
status: done
|
||||
title: Fix idempotent CLAUDE.md doc regeneration (installer regex bug)
|
||||
- id: T02
|
||||
state_hub_task_id: e2d9bea8-243b-4b12-bba3-4d43a3bae71c
|
||||
status: done
|
||||
title: Reusable agent-docs module and kaizen-agentic docs generate command
|
||||
- id: T03
|
||||
state_hub_task_id: 57176887-5344-444c-aa5a-a4aea161ee71
|
||||
status: done
|
||||
title: Enforce agent frontmatter schema in validate
|
||||
- id: T04
|
||||
state_hub_task_id: 724e3862-602b-4ef0-88b8-ddb78a225046
|
||||
status: done
|
||||
title: kaizen-agentic create-agent scaffold for new agents
|
||||
- id: T05
|
||||
state_hub_task_id: 4d6e323c-9cad-49ce-9356-9192c20cc986
|
||||
status: done
|
||||
title: Unit tests for docs generate, schema validation, create-agent
|
||||
- id: T06
|
||||
state_hub_task_id: 6715aa6f-1ee0-4f22-9249-f1cd41763cd1
|
||||
status: done
|
||||
title: Docs, CLI cheat sheet, CHANGELOG for v1.4.0
|
||||
---
|
||||
|
||||
# KAIZEN-WP-0007 — Agent Authoring & Doc Generation
|
||||
|
||||
**Status:** done
|
||||
**Owner:** kaizen-agentic
|
||||
**Repo:** kaizen-agentic
|
||||
**Target version:** 1.4.0
|
||||
**Depends on:** WP-0006 (scheduled agent execution)
|
||||
|
||||
## Goal
|
||||
|
||||
Close the WP-0005/WP-0006 deferrals — **agent selection/authoring**, **template
|
||||
schema enforcement**, and **doc generation** — and fix the doc-generation defect
|
||||
they exposed. After this workplan, authoring a new agent and keeping project
|
||||
docs in sync is a first-class, idempotent, validated CLI flow.
|
||||
|
||||
## Background
|
||||
|
||||
`AgentInstaller._update_documentation()` regenerates the `## Installed Agents`
|
||||
block in a project's `CLAUDE.md`, but its regex
|
||||
(`## Installed Agents.*?(?=##|\Z)`) is non-greedy and the `(?=##)` lookahead
|
||||
matches `### Category` subheadings *inside* the section — so each run leaves the
|
||||
old category lists and footer in place and appends a fresh copy. The block
|
||||
duplicates and grows unbounded (reported to state-hub; the corrupting write is
|
||||
ours). `validate` only checks dependencies and file existence — it does not
|
||||
enforce the agent frontmatter schema — and there is no scaffolding command for
|
||||
new agents.
|
||||
|
||||
## Tasks
|
||||
|
||||
### T01 — Fix idempotent doc regeneration
|
||||
- Anchor the replace to a top-level heading: `(?=\n## (?!#)|\Z)`.
|
||||
- Add a regression test that runs regeneration twice and asserts exactly one
|
||||
`## Installed Agents`, one footer, one block per category.
|
||||
- Clean the existing baseline duplication in this repo's `CLAUDE.md`.
|
||||
|
||||
### T02 — Reusable agent-docs module + `docs generate`
|
||||
- Extract the "Installed Agents" rendering into a pure function
|
||||
(`render_installed_agents_section`) and an idempotent
|
||||
`upsert_installed_agents_section(content, section)`.
|
||||
- `_update_documentation` reuses them (no behavioral fork).
|
||||
- New `kaizen-agentic docs generate [--target PATH] [--check]` refreshes the
|
||||
section for installed agents; `--check` exits non-zero if it would change
|
||||
(CI-friendly).
|
||||
|
||||
### T03 — Enforce agent frontmatter schema in `validate`
|
||||
- Add `validate_frontmatter_schema()` to the registry: required `name`,
|
||||
`description`, `category`; `category` ∈ `AgentCategory`; `memory` ∈
|
||||
{`enabled`,`disabled`} when present; `model` a non-empty string when present.
|
||||
- Surface schema errors in `kaizen-agentic validate` alongside dependency
|
||||
errors, with actionable messages.
|
||||
|
||||
### T04 — `create-agent` scaffold
|
||||
- `kaizen-agentic create-agent <name> [--category] [--description] [--memory]
|
||||
[--target] [--force]` writes a schema-valid `agents/agent-<name>.md` with
|
||||
frontmatter + section skeleton.
|
||||
- Missing `--category`/`--description` fall back to interactive prompts.
|
||||
- Refuses invalid category; refuses overwrite without `--force`; output passes
|
||||
T03 validation.
|
||||
|
||||
### T05 — Tests
|
||||
- `tests/test_agent_docs.py` — idempotency, `docs generate --check`.
|
||||
- `tests/test_validate_schema.py` — schema pass/fail cases.
|
||||
- `tests/test_create_agent.py` — scaffold + round-trips through registry.
|
||||
|
||||
### T06 — Docs
|
||||
- `docs/CLI_CHEAT_SHEET.md` — `docs generate`, `create-agent`, schema validate.
|
||||
- `docs/agency-framework.md` — authoring + doc-sync note.
|
||||
- `CHANGELOG.md` `[Unreleased]`; `TODO.md` pointer.
|
||||
|
||||
## Definition of Done
|
||||
|
||||
- Doc regeneration is idempotent (N runs == 1 run); baseline cleaned.
|
||||
- `kaizen-agentic validate` fails on malformed agent frontmatter with clear errors.
|
||||
- `kaizen-agentic create-agent` produces an agent that passes `validate`.
|
||||
- `kaizen-agentic docs generate --check` is green on a synced repo.
|
||||
- Full test suite + `make release-check` green.
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- Multi-file agent packages / protocol scaffolding (separate workplan).
|
||||
- Publishing generated docs to external knowledge bases (info-tech-canon).
|
||||
- Changing the agent frontmatter schema itself (only enforcing the current one).
|
||||
|
||||
## Notes
|
||||
|
||||
- Boundary: the doc-regeneration *trigger* (a state-hub routine invoking the
|
||||
installer mid-session) is tracked separately in the state-hub inbox; this
|
||||
workplan fixes the *write* so the trigger becomes harmless/idempotent.
|
||||
- `create-agent` writes to `agents/`; remember `make agents-sync-package` before
|
||||
release so packaged `data/agents/` parity holds (existing release-check gate).
|
||||
Reference in New Issue
Block a user