CLI utility for initializing AgenticScrum projects with AI agent configurations
Project description
AgenticScrum: A Framework for Structured AI-Driven Code Generation
๐ BETA RELEASE v1.0.0-beta.4 - Join our beta testing program!
โ ๏ธ Beta Software: This is pre-release software. While core features are stable, expect some rough edges. See known limitations and how to provide feedback.
AgenticScrum is an open-source framework designed to bring structure, efficiency, and agile principles to software development powered by AI agents. It provides a comprehensive setup utility, defines clear roles for AI agents within a Scrum-like workflow, and integrates best practices for coding standards and project management.
Table of Contents
- Overview
- Core Principles
- Key Features
- Getting Started
- Project Directory Structure
- The AgenticScrum Workflow
- Multi-Stack and Multi-Repository Support
- Inspiration
- Benefits
- Limitations
- Future Directions
- Additional Resources
- Contributing
- License
Overview
The rise of sophisticated AI agents for code generation offers immense potential but often lacks standardized processes, leading to challenges in managing multiple agents, ensuring code quality, and scaling efforts.
AgenticScrum addresses these challenges by:
- Integrating core Scrum methodologies with specialized AI agents.
- Providing a setup utility to automate the creation of a standardized project structure.
- Generating foundational rules and persona definitions for AI agents.
- Incorporating coding standards and priming scripts to initialize agent behavior.
This framework aims to bring predictability, quality control, and collaborative structure to AI-assisted software development.
Core Principles
AgenticScrum is built upon the following foundational principles:
- Simplicity: Easy to understand and implement, minimizing cognitive overhead.
- Power: Capable of handling complex code generation tasks through specialized, collaborative AI agents.
- Ease of Use: Intuitive setup and operational experience, primarily via a Command-Line Interface (CLI).
- Open-Source: All components are open-source to encourage community contribution, transparency, and evolution.
- Scrum Alignment: Adapts key Scrum elements (artifacts, roles, events) to an agentic context, providing a familiar structure for agile teams.
Key Features
- Automated Project Scaffolding: CLI utility to instantly set up a standardized project.
- Fullstack Support: Create projects with multiple languages and frameworks in a single command.
- Defined AI Agent Roles: Pre-defined personas (ProductOwnerAgent, ScrumMasterAgent, DeveloperAgent, QAAgent, SecurityAuditAgent) with customizable rules.
- Scrum-Inspired Workflow: Structured sprints, task decomposition, and agent collaboration mimicking agile practices.
- Integrated Coding Standards: Mechanisms for defining and enforcing project-specific coding conventions and quality.
- Framework-Specific Templates: Built-in support for FastAPI, Express, React, Spring Boot, and more.
- Priming Scripts: Contextual initialization for agents to guide their behavior effectively.
- Human-in-the-Loop Design: Critical human oversight integrated into the workflow for validation and decision-making.
- Multi-Stack & Multi-Repo Adaptability: Flexible structure to support diverse technology stacks and complex project organizations.
- Checklist-Driven Quality: Utilizes checklists (e.g., Definition of Done, Code Review) to ensure thoroughness and consistency.
- MCP Integration (NEW): Enhanced agent capabilities through Model Context Protocol:
- Persistent Memory: Agents learn and improve from past experiences across sessions
- Advanced Web Search: Access to current information via Perplexity API integration
- Secure API Management: Environment-based configuration keeps credentials safe
Getting Started
Project Location Best Practices
AgenticScrum creates new projects in a designated location to keep your tool installation separate from your development projects. By default, projects are created in:
~/AgenticProjects- When running from within the AgenticScrum directory- Current directory - When running from outside AgenticScrum
Setting up a Workspace:
# Create a dedicated workspace for your projects
./init.sh create-workspace ~/MyProjects
# Or use the default location
./init.sh create-workspace
Environment Variable Configuration:
# Set your preferred default location
export AGENTIC_PROJECTS_DIR="$HOME/MyProjects"
# Add to your shell profile (~/.zshrc or ~/.bashrc) to make permanent
echo 'export AGENTIC_PROJECTS_DIR="$HOME/MyProjects"' >> ~/.zshrc
The Setup Utility
The primary way to start an AgenticScrum project is by using the agentic-scrum-setup CLI utility. To simplify the complex command-line arguments, we provide an init.sh helper script.
Quick Start with init.sh:
# Install the beta release
pip install agentic-scrum-setup==1.0.0b4
# Create a new project interactively (recommended for beta testing)
./init.sh new
# Or use quick setup with defaults
./init.sh quick MyNewWebApp
Beta Testers: Please see BETA_LAUNCH.md for beta-specific installation instructions and feedback guidelines.
Direct CLI Usage:
Single language project:
agentic-scrum-setup init \
--project-name MyNewWebApp \
--language python \
--framework fastapi \
--agents poa,sma,deva_python,qaa,saa \
--llm-provider anthropic \
--default-model claude-sonnet-4-0 \
--output-dir ~/AgenticProjects
Fullstack project:
agentic-scrum-setup init \
--project-name MyFullstackApp \
--project-type fullstack \
--language python \
--backend-framework fastapi \
--frontend-language typescript \
--frontend-framework react \
--agents poa,sma,deva_python,deva_typescript,qaa,saa \
--llm-provider anthropic \
--default-model claude-sonnet-4-0 \
--output-dir ~/AgenticProjects
This command will:
- Create a new project directory in the specified output location (e.g., ~/AgenticProjects/MyNewWebApp/).
- Generate a standardized hierarchical directory structure (see below).
- Create agent configuration files (persona_rules.yaml) and priming_script.md for each specified agent.
- Generate template documents for coding standards (coding_standards.md) and linter configurations.
- Create an agentic_config.yaml for global project settings.
- Scaffold checklist documents like definition_of_done.md.
If run interactively (e.g., agentic-scrum-setup init), the CLI will prompt for necessary information including the output directory.
Claude Code Integration
AgenticScrum is optimized for use with Claude Code (claude.ai/code). When using Claude Code:
Quick Setup:
# Use the --claude-code flag for optimal defaults
agentic-scrum-setup init --project-name MyProject --language python --agents poa,sma,deva_python,qaa --claude-code
Key Features:
- Automatic selection of Anthropic provider and claude-sonnet-4-0 model
- Model parameters (temperature, max_tokens) are controlled by Claude Code IDE
- Agent configurations include model recommendations for different tasks
- Seamless integration with Claude Code's model switching commands
Model Selection Strategy:
- Use
/model opusfor complex planning and architecture tasks - Use
/model sonnet(default) for development and implementation - Use
/model haikufor quick, simple tasks
MCP Integration (Model Context Protocol)
AgenticScrum now supports MCP servers to enhance agent capabilities beyond Claude Code's native features:
Enable MCP Features:
# Create project with MCP integration
agentic-scrum-setup init \
--project-name "MyEnhancedProject" \
--language python \
--agents poa,sma,deva_python,qaa \
--enable-mcp \
--enable-search
# Configure API keys (required for search)
export PERPLEXITY_API_KEY="your-key-here"
MCP Benefits:
- Persistent Memory: Agents remember past decisions, patterns, and solutions across sessions
- Advanced Search: Global web search via Perplexity (not limited to US like native search)
- Learning Agents: Performance improves over time as agents build knowledge
- Secure Configuration: API keys managed through environment variables
For detailed MCP setup, see the MCP Integration Guide.
Retrofitting Existing Projects
AgenticScrum can be gradually integrated into existing codebases without disrupting current workflows. This approach is ideal for teams who want to leverage AI agents without starting from scratch.
Quick Start for Retrofitting:
# Assess your existing project
python scripts/retrofit_project.py assess --path /path/to/your/project
# Generate a customized retrofit plan
python scripts/retrofit_project.py plan --path /path/to/your/project
# Initialize agents for your specific tech stack
python scripts/retrofit_project.py init-agents --path /path/to/your/project \
--languages python,javascript --frameworks django,react
Key Benefits of Retrofitting:
- Non-disruptive integration - Keep your existing structure and workflows
- Gradual adoption - Start with one agent, expand as comfortable
- Respect existing patterns - Agents learn and match your code style
- Preserve team dynamics - Enhance rather than replace current processes
For detailed retrofitting instructions, see the Retrofitting Guide.
Project Directory Structure
A well-defined structure is crucial. AgenticScrum proposes the following:
MyNewWebApp/
โโโ agentic_config.yaml # Global AgenticScrum settings (LLM provider, API keys, etc.)
โโโ README.md # Project overview and setup
โโโ .gitignore # Standard git ignore
โโโ requirements.txt # Or pyproject.toml, package.json, etc. for dependencies
โ
โโโ agents/ # Agent-specific configurations
โ โโโ product_owner_agent/
โ โ โโโ persona_rules.yaml # Role, goals, rules, LLM config for POA
โ โ โโโ priming_script.md # Initial prompt for POA
โ โโโ scrum_master_agent/ # Similar structure for SMA
โ โโโ developer_agent/ # Can have sub-specializations (e.g., python_expert/)
โ โ โโโ python_expert/
โ โ โโโ persona_rules.yaml
โ โ โโโ priming_script.md
โ โโโ qa_agent/ # Similar structure for QAA
โ โโโ security_audit_agent/ # Similar structure for SAA
โ
โโโ src/ # Source code generated by DeveloperAgents
โ โโโ backend/ # Example for full-stack
โ โโโ frontend/ # Example for full-stack
โ
โโโ tests/ # Unit, integration, and E2E tests (mirroring /src)
โ
โโโ docs/ # Project documentation
โ โโโ requirements/
โ โ โโโ product_backlog.md
โ โ โโโ user_stories/
โ โ โโโ sprint_N/ # User stories for each sprint
โ โโโ architecture/ # Architecture diagrams, design decisions
โ โโโ sprint_reports/ # Daily logs, review summaries, retrospective notes
โ
โโโ standards/ # Coding standards and quality guidelines
โ โโโ coding_standards.md # Human-readable coding conventions
โ โโโ linter_configs/ # Config files for linters (e.g.,.eslintrc, pyproject.toml for flake8/black)
โ
โโโ checklists/ # Actionable checklists
โ โโโ definition_of_done.md
โ โโโ code_review_checklist.md
โ โโโ sprint_planning_checklist.md
โ โโโ security_audit_checklist.md
โ
โโโ scripts/ # Utility scripts for automation (e.g., run_linters.sh)
This structure is inspired by best practices from frameworks like CrewAI [1] and LangGraph [3].
The AgenticScrum Workflow
Agent Personas & Rules
Effective agentic systems rely on well-defined "persona engineering."
- Core Agents:
- ProductOwnerAgent (POA): Manages product backlog, creates user stories.
- ScrumMasterAgent (SMA): Facilitates the process, monitors interactions, flags impediments.
- DeveloperAgent (DevA): Generates code and unit tests based on user stories. Can be specialized (e.g., PythonDeveloperAgent).
- QAAgent (QAA): Reviews code, runs tests, ensures adherence to Definition of Done.
- SecurityAuditAgent (SAA): Conducts comprehensive security audits, identifies vulnerabilities, ensures secure coding practices.
- persona_rules.yaml: Located in each agent's directory (e.g., /agents/developer_agent/persona_rules.yaml), this file defines:
- role: The agent's primary function.
- goal: The agent's main objective.
- backstory: Context for the LLM to adopt the persona.
- llm_config: Specific LLM settings (model, temperature).
- capabilities: List of skills.
- rules: Specific operational heuristics and constraints.
- knowledge_sources: Pointers to relevant documents (standards, checklists).
- tools: (Conceptual) Placeholder for future tool integrations.
This detailed configuration, inspired by practices in BMAD-METHOD [5], guides the LLM's behavior.
Priming Scripts
Located in [agent_dir]/priming_script.md, these scripts are the initial textual input to the LLM:
- Invoke the specific agent persona by referencing its persona_rules.yaml.
- Set the context and define the immediate task or mission.
- Point to necessary resources (user stories, coding standards).
- Specify output expectations and contingency instructions.
Coding Standards
AgenticScrum integrates coding standards through:
- standards/coding_standards.md: A human-readable document detailing naming conventions, commenting guidelines, style guides, etc.
- standards/linter_configs/: Configuration files for automated linters (e.g., Flake8, ESLint) and formatters (e.g., Black, Prettier).
Enforcement occurs via:
- Explicit rules in agent persona_rules.yaml.
- Reinforcement in priming_script.md.
- Checklist items in checklists/code_review_checklist.md for the QAAgent.
Workflow Orchestration (Future Feature)
Note: Automated workflow orchestration is planned for future releases. Currently, agents operate independently and require manual coordination.
The conceptual sprint lifecycle that will be automated includes:
- Sprint Planning: POA generates user stories from high-level goals.
- User Story Assignment: Stories assigned to appropriate DevAs.
- Development: DevAs generate code and unit tests.
- Security Audit: SAA performs comprehensive security review of the code.
- Code Review & QA: QAA reviews code, runs tests, verifies against Definition of Done.
- Daily Stand-up (Conceptual): Agents report status, SMA logs progress/impediments.
- Sprint Review: Human stakeholders review completed work.
- Sprint Retrospective: Analyze agent performance and process for improvements.
Planned integrations:
- Automated sprint lifecycle management
- Agent interaction coordination
- Integration with CrewAI [6], AutoGen [6], or LangGraph [6]
- Full POA โ SMA โ DevA โ QAA โ SAA workflow automation
Human-in-the-Loop (HITL)
Human oversight is critical [9]. Responsibilities include:
- Setting strategic direction.
- Reviewing and approving agent outputs (especially user stories, final code).
- Resolving complex ambiguities.
- Making critical design decisions.
- Continuously refining agent personas and prompts.
Multi-Stack and Multi-Repository Support
AgenticScrum supports three project types to handle any software architecture:
Organization Management
NEW: Enterprise-grade multi-repository management with AI agent coordination:
# Create an organization to manage multiple repositories
agentic-scrum-setup init --project-type organization --organization-name "MyCompany"
# Add repositories to the organization
agentic-scrum-setup add-repo \
--organization-dir MyCompany \
--repo-name "api-service" \
--language python \
--framework fastapi \
--agents poa,sma,deva_python,qaa
# List all repositories in organization
agentic-scrum-setup list-repos --organization-dir MyCompany
Organization Features:
- Portfolio-Level Planning: Organization POA manages product strategy across all repositories
- Cross-Project Coordination: Organization SMA coordinates sprints and dependencies across teams
- Shared Standards: Consistent coding standards, security policies, and best practices
- Configuration Inheritance: Organization settings cascade to individual repositories
- Shared Infrastructure: Common databases, monitoring, CI/CD, and development tools
- Agent Memory Sharing: Cross-project pattern recognition and knowledge transfer
Organization Structure:
MyOrganization/
โโโ .agentic/ # Organization configuration
โ โโโ agentic_config.yaml # Organization-wide settings
โ โโโ agents/ # Organization-level agents
โ โ โโโ organization_poa/ # Portfolio Product Owner
โ โ โโโ organization_sma/ # Cross-project Scrum Master
โ โโโ shared_standards/ # Coding standards for all repos
โ โโโ shared_memory/ # Cross-project agent memory
โโโ projects/ # Individual repositories
โ โโโ backend-api/ # Repository 1
โ โโโ frontend-app/ # Repository 2
โ โโโ mobile-app/ # Repository 3
โโโ shared/ # Shared resources
โ โโโ docker-compose.yml # Organization-wide services
โ โโโ scripts/ # Organization utility scripts
โโโ docs/ # Organization documentation
Single and Fullstack Projects
-
Single Language Projects:
agentic-scrum-setup init --project-name "MyAPI" --language python --framework fastapi
-
Fullstack Projects:
agentic-scrum-setup init \ --project-type fullstack \ --language python \ --backend-framework fastapi \ --frontend-language typescript \ --frontend-framework react
- Automatically creates
/backendand/frontenddirectories with appropriate structures - Generates multiple DeveloperAgents for different languages (e.g.,
deva_pythonfor backend,deva_typescriptfor frontend) - Separate standards and linter configurations for each stack
- Automatically creates
Use Cases:
- Organizations: Enterprise teams managing multiple related services and applications
- Fullstack: Single applications with distinct backend and frontend components
- Single: Individual microservices, libraries, or standalone applications
Agent Coordination Across Project Types:
- Organization Level: Portfolio POA + Cross-project SMA coordinate across all repositories
- Repository Level: Individual POA, SMA, and developer agents for each project
- Shared Memory: Agents learn from patterns across the entire organization
Inspiration
AgenticScrum draws inspiration from pioneering open-source frameworks, adapting their successful patterns into a Scrum-like context:
- BMAD-METHOD [5]:
Influences persona engineering, detailed prompting, and the crucial role of checklists. - CrewAI [6]:
Informs the standardized project structure, YAML-based agent definitions, and role-based agent collaboration. - AutoGen [6]:
Provides models for multi-agent communication and orchestration. - LangGraph [6]:
Offers paradigms for complex, stateful multi-agent interactions.
Benefits
- Increased Efficiency & Speed: Automates parts of coding, documentation, and testing [9].
- Improved Consistency: Standardized personas, rules, and coding standards.
- Enhanced Code Quality (Potentially): Systematic QA by QAAgents and feedback loops [9].
- Improved Security: Automated security audits by SecurityAuditAgent to identify vulnerabilities early.
- Scalability: Structure for distributing tasks among multiple AI agents [9].
- Structured Agentic Development: Methodical process for AI-assisted projects.
- Knowledge Centralization: Explicit definition of personas, rules, and standards.
Agent Optimization and Feedback Loops
AgenticScrum includes a comprehensive system for continuously improving agent performance through feedback loops and automated optimization. This addresses one of the key limitations - the dependence on well-crafted configurations.
Key Components:
- Performance Metrics Collection: Automated tracking of code quality, complexity, coverage, and other metrics
- Feedback Forms: Structured templates for collecting human feedback on agent performance
- Automated Analysis: Scripts that identify patterns in feedback and suggest configuration improvements
- Configuration Updates: Tools to apply improvements to persona_rules.yaml and priming_script.md
Documentation:
- Agent Optimization Guide - Comprehensive guide to crafting effective personas and priming scripts
- Feedback Workflow - Step-by-step process for implementing feedback loops
- Agent Feedback Form - Template for collecting structured feedback
Quick Start:
# Collect metrics for agent-generated code
python scripts/collect_agent_metrics.py --agent deva_python --file src/api/users.py --save
# Analyze feedback and generate recommendations
python scripts/update_agent_config.py recommend --agent deva_python
# Apply recommended updates (dry run)
python scripts/update_agent_config.py apply --agent deva_python --dry-run
Limitations
- LLM "Hallucinations": Requires robust QA and human oversight.
- Dependence on Prompt Quality: Effectiveness hinges on well-crafted persona_rules.yaml and priming_script.md. (Mitigated by feedback loops and optimization system)
- Agent Management Overhead: Coordinating multiple agents can be complex.
- Current LLM Reasoning Limits: May struggle with highly novel or abstract problems.
- Cost of LLM API Usage: Can be significant for cloud-based LLMs.
- Integration Challenges: Integrating AI-generated code into existing complex systems.
Future Directions
- Advanced Orchestration Engine: Leveraging frameworks like CrewAI, AutoGen, or LangGraph.
- Enhanced Tool Integration: Enabling agents to actively use linters, test runners, VCS, APIs.
- Feedback Loops & Agent Learning: Implementing RAG, learning from human feedback.
- Sophisticated Agent Specializations & Collaboration Patterns.
- Community-Driven Development: Shared repository of personas, rules, and tool integrations.
Additional Resources
Conceptual Design Document
For a comprehensive understanding of the AgenticScrum framework's theoretical foundations and detailed design principles, please refer to Design.md. This document provides:
- In-depth exploration of the framework's conceptual architecture
- Detailed agent persona engineering principles
- Advanced workflow orchestration patterns
- Multi-agent collaboration strategies
- Comprehensive project structure rationale
Tutorial & Getting Started Guide
If you're looking for a hands-on, step-by-step guide to building your first AgenticScrum project, check out Tutorial.md. This tutorial walks you through:
- Building a full-stack cattle ranching desktop application
- Setting up a FastAPI backend with proper structure
- Creating an Electron + React frontend
- Integrating with Docker for containerized development
- Practical examples of using AgenticScrum agents in development
Retrofitting Guide
For teams with existing projects who want to adopt AgenticScrum incrementally, see the Retrofitting Guide. This guide covers:
- Assessing your existing codebase for AgenticScrum compatibility
- Creating a phased adoption plan
- Configuring agents to respect existing patterns
- Integrating with current CI/CD pipelines
- Managing the transition with minimal disruption
Contributing
AgenticScrum is an open-source project, and contributions are highly welcome! Whether it's improving the setup utility, refining agent personas, adding support for new languages/frameworks, or enhancing documentation, your input is valuable.
Please refer to CONTRIBUTING.md for guidelines on how to contribute.
License
This project is intended to be licensed under an open-source license (e.g., MIT License). See the LICENSE file for details once finalized.
Works cited
- Building Multi-Agent Systems With CrewAI - A Comprehensive Tutorial - Firecrawl, accessed June 11, 2025, https://www.firecrawl.dev/blog/crewai-multi-agent-systems-tutorial
- How to build a game-building agent system with CrewAI - WorkOS, accessed June 11, 2025, https://workos.com/blog/how-to-build-a-game-building-agent-system-with-crewai
- Application structure - GitHub Pages, accessed June 11, 2025, https://langchain-ai.github.io/langgraph/concepts/application_structure/
- 10 Langgraph Projects to Build Intelligent AI Agents - ProjectPro, accessed June 11, 2025, https://www.projectpro.io/article/langgraph-projects-and-examples/1124
- BMAD-METHOD V2 in an Evolution IMO - The POWER of Custom Agents, Smaller Docs, and CHECKLISTS! - How To - Cursor - Community Forum, accessed June 11, 2025, https://forum.cursor.com/t/bmad-method-v2-in-an-evolution-imo-the-power-of-custom-agents-smaller-docs-and-checklists/87218
- Top 10 Open-Source AI Agent Frameworks to Know in 2025, accessed June 11, 2025, https://opendatascience.com/top-10-open-source-ai-agent-frameworks-to-know-in-2025/
- How to use the Microsoft Autogen framework to Build AI Agents? - ProjectPro, accessed June 11, 2025, https://www.projectpro.io/article/autogen/1139
- AutoGen Tutorial: Build Multi-Agent AI Applications - DataCamp, accessed June 11, 2025, https://www.datacamp.com/tutorial/autogen-tutorial
- Agentic Workflows: Everything You Need to Know - Automation Anywhere, accessed June 11, 2025, https://www.automationanywhere.com/rpa/agentic-workflows
- Top Agent Workflow Configuration Best Practices for Optimal Efficiency | NICE, accessed June 11, 2025, https://www.nice.com/info/agent-workflow-configuration-best-practices
- bmadcode/BMAD-METHOD: Breakthrough Method for ... - GitHub, accessed June 11, 2025, https://github.com/bmadcode/BMAD-METHOD
- BMad Code - YouTube, accessed June 11, 2025, https://www.youtube.com/@BMadCode/community
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agentic-scrum-setup-1.0.0b4.tar.gz.
File metadata
- Download URL: agentic-scrum-setup-1.0.0b4.tar.gz
- Upload date:
- Size: 147.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
027416c282a596c1fb5e6e68a3b80940c787400c1f7894e99e479afb73dcb71d
|
|
| MD5 |
c201f9c90e5590c993b3903df97a1a37
|
|
| BLAKE2b-256 |
4cf5d26d0c0a074ae6de1fe658acefd677c2da7d6d7e7ae7b187b85d88bf01d2
|
File details
Details for the file agentic_scrum_setup-1.0.0b4-py3-none-any.whl.
File metadata
- Download URL: agentic_scrum_setup-1.0.0b4-py3-none-any.whl
- Upload date:
- Size: 171.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c14ac0fe0533620dfe24c2493eec1c1a2581c9337155b4325263dbe360318a1c
|
|
| MD5 |
cf7dce6d23a06c84a021228babb78f83
|
|
| BLAKE2b-256 |
a0e027b18649c5135529d9d5ef6d6cdf34e244d127d1d30c51942232747d190e
|