Skip to main content

A framework for AI-powered software development using a team of specialized agents.

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Code Team Framework

This project implements the "Code Team Framework", a system that orchestrates a team of specialized AI agents to automate software development tasks. It operates on a "human-on-the-loop" principle, where the system handles the cycles of coding and verification, while strategic decisions are left to the user.

The framework is built to be stateless and resilient, deriving its state from the filesystem (Git status, plan files, logs) to allow for easy stopping and resuming of tasks.

Features

  • State Machine Orchestration: A central orchestrator manages the entire workflow, from planning to coding, verification, and committing.
  • Specialized AI Agents: A roster of agents (Planner, Coder, Verifiers, etc.) each with a specific role, powered by the Claude Code SDK.
  • File-Based State: The system is stateless. Stop it at any time and it will recover its state from the repository's condition.
  • Human-on-the-Loop: Key decision points, like plan approval and accepting code changes, require user intervention.
  • Configurable Workflow: Define verification steps, agent settings, and LLM providers in a simple .codeteam/config.yml.
  • Extensible: Designed with SOLID principles, making it easy to add new agents or verification steps.
  • Rich Terminal UI: Agent output is displayed in styled panels for better readability. Note: Scrolling within the panels is not supported - use your terminal's scrollback feature to review previous output.

Prerequisites

  • Python 3.10+
  • Node.js
  • Claude Code CLI: npm install -g @anthropic-ai/claude-code
  • An Anthropic API key set as an environment variable: export ANTHROPIC_API_KEY="your-key-here"

Installation

Install from PyPI (Recommended)

pip install code-team-framework

Install from Source

  1. Clone the repository:

    git clone <repository_url>
    cd code-team-framework
    
  2. Create and activate a virtual environment:

    python3 -m venv .venv
    source .venv/bin/activate
    
  3. Install dependencies:

    pip install -e ".[dev]"
    

Usage

The framework is controlled via the codeteam command.

1. Planning a New Feature

Start by creating a plan. The Planner agent will collaborate with you to break down the request into a task list.

You can provide the initial request directly as an argument:

codeteam plan "Implement a user profile feature with bio and avatar."

Alternatively, you can run the command without an argument to be prompted for the request interactively:

codeteam plan

The agent will ask clarifying questions. When you're ready, type /save_plan. The plan will be saved to .codeteam/planning/{plan_id}/plan.yml.

Review the plan and accept it to begin the coding phase.

# The tool will prompt you for this after the plan is saved
/accept_plan

2. Executing the Plan

Once a plan is accepted, start the coding and verification loop.

codeteam code

The orchestrator will pick up the next pending task, generate a prompt, and invoke the Coder agent. After the Coder finishes, verification checks run automatically. You will be prompted to review the changes.

  • Type /accept_changes to commit the work and move to the next task.
  • Type /reject_changes [your feedback] to send it back to the Coder with your notes.

3. Resuming Work

If you stop the process, you can resume it at any time. The orchestrator will automatically determine the current state and pick up where it left off.

# If you were in the middle of coding:
codeteam code

# If you were in the middle of planning:
codeteam plan

Integration

The Code Team Framework can be easily integrated into any project:

1. Initialize the Framework

# Navigate to your project
cd /path/to/your/project

# Initialize the framework (creates .codeteam/ directory)
codeteam init

This creates a .codeteam/ directory with:

  • config.yml - Main configuration file
  • agent_instructions/ - Customizable agent instruction templates
  • planning/ - Planning documents (generated during use)
  • reports/ - Verification reports (temporary)

2. Start Using the Framework

# Start planning and coding
codeteam plan "Implement new feature"
codeteam code

3. Customization

After initialization, you can customize:

  • Configuration: Edit .codeteam/config.yml to adjust paths, verification commands, and agent settings
  • Agent Instructions: Modify templates in .codeteam/agent_instructions/ to customize how agents behave

Configuration

The framework is configured via .codeteam/config.yml. You can set the LLM model, define custom verification commands, and configure agent behavior. Run codeteam init to create the default configuration file.

For comprehensive configuration options and examples, see the Configuration Guide.

Project Structure

Framework Source Code:

  • src/code_team/__main__.py: The command-line entry point (available as codeteam command after installation).
  • src/code_team/: The main application source code.
    • orchestrator/: The core state machine and orchestrator logic.
    • agents/: Implementations for all specialized AI agents.
    • models/: Pydantic models for configuration and plan files.
    • utils/: Helper modules for filesystem, Git, LLM interaction, and templating.
    • templates/: Default agent instruction templates (packaged with the framework).

When Used in Projects:

  • .codeteam/: Framework directory (created by codeteam init).
    • config.yml: Main configuration file.
    • agent_instructions/: Customizable agent instruction templates.
    • planning/: Generated plans and related documents.
    • reports/: Verification reports (temporary files).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

code_team_framework-0.1.1.tar.gz (75.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

code_team_framework-0.1.1-py3-none-any.whl (51.2 kB view details)

Uploaded Python 3

File details

Details for the file code_team_framework-0.1.1.tar.gz.

File metadata

  • Download URL: code_team_framework-0.1.1.tar.gz
  • Upload date:
  • Size: 75.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for code_team_framework-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2dfd26cdd9db1b45e8d2de3dbbe7c886f63e9b99cc64b79b683864d1bd012761
MD5 f3ade83b2a4d3c98d42e3b1c50d70ebd
BLAKE2b-256 acba4ce17fa9ed6c246b9d819210001de295391e3239776bd97586b6ebd901cf

See more details on using hashes here.

File details

Details for the file code_team_framework-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for code_team_framework-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d9922c3094c2078bef8a2a61d4a5916cc37a83419d949bd6b56fac79964850b
MD5 fbbcb01c6cbf813c750b5905aa183fd3
BLAKE2b-256 818ac046f658a5d7964dd90fed8f2602aeda7c21dcc7f0dd46264b047a8ad5c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page