Metadata-Version: 2.4
Name: codegeass
Version: 0.2.8
Summary: Task orchestration for AI coding agents - scheduling, skills, approvals, and monitoring
Author: DonTizi
License: MIT
Project-URL: Homepage, https://github.com/dontizi/codegeass
Project-URL: Documentation, https://dontizi.github.io/codegeass/
Project-URL: Repository, https://github.com/dontizi/codegeass.git
Project-URL: Bug Tracker, https://github.com/dontizi/codegeass/issues
Project-URL: Changelog, https://github.com/dontizi/codegeass/blob/main/CHANGELOG.md
Keywords: ai,agents,claude,codex,automation,scheduling,skills,orchestration
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic>=2.0
Requires-Dist: click>=8.0
Requires-Dist: rich>=13.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: jinja2>=3.0
Requires-Dist: croniter>=1.0
Requires-Dist: fastapi>=0.100.0
Requires-Dist: uvicorn>=0.20.0
Requires-Dist: websockets>=11.0
Requires-Dist: python-telegram-bot>=21.0
Requires-Dist: httpx>=0.27.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: types-PyYAML>=6.0; extra == "dev"
Requires-Dist: types-croniter>=1.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.5; extra == "docs"
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
Requires-Dist: mkdocs-click>=0.8; extra == "docs"
Requires-Dist: mike>=2.0; extra == "docs"
Dynamic: license-file

  CodeGeass Logo

# CodeGeass

[![PyPI version](https://badge.fury.io/py/codegeass.svg)](https://pypi.org/project/codegeass/)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Task orchestration for AI coding agents.

Schedule AI coding tasks across multiple projects, use reusable skills, review changes before execution, and monitor everything through a web dashboard.

## Features

- **Scheduled tasks**: Define tasks with CRON expressions
- **Multi-project**: Manage multiple repos from one installation
- **Skills system**: Reusable prompts following the [Agent Skills](https://agentskills.io) standard
- **Execution modes**: Read-only, plan-first, or autonomous
- **Plan approval**: Review changes before they're applied (Telegram/Discord/Teams)
- **Notifications**: Get notified when tasks complete or need attention
- **Dashboard**: Web UI for management and real-time monitoring
- **Multi-provider**: Works with Claude Code, OpenAI Codex, and more
- **Subscription-first**: Uses your Claude Pro/Max subscription, not API credits

## Installation

### Using pipx (Recommended)

[pipx](https://pipx.pypa.io/) installs CLI tools in isolated environments. This is the recommended method:

```bash
# Install pipx if you don't have it
# macOS
brew install pipx && pipx ensurepath

# Linux
python3 -m pip install --user pipx && pipx ensurepath

# Then install CodeGeass + start the 24/7 scheduler
pipx install codegeass
codegeass setup
```

### Using pip (in a virtual environment)

If you prefer using pip, we recommend a virtual environment:

```bash
# Create and activate a virtual environment
python3 -m venv ~/.codegeass-venv
source ~/.codegeass-venv/bin/activate

# Install CodeGeass
pip install codegeass

# Add to PATH (add this to your ~/.bashrc or ~/.zshrc)
export PATH="$HOME/.codegeass-venv/bin:$PATH"

# Setup with 24/7 scheduler
codegeass setup
```

### With notification support

```bash
pipx install "codegeass[notifications]"
```

### From Source

```bash
git clone https://github.com/DonTizi/CodeGeass.git
cd CodeGeass
pip install -e .
```

### Verify Installation

```bash
codegeass --version
```

## Quick Start

```bash
# Install
pipx install codegeass
codegeass setup

# Create a task
codegeass task create \
  --name daily-review \
  --skill code-review \
  --schedule "0 9 * * 1-5"

# Run it
codegeass task run daily-review

# Open dashboard
codegeass dashboard
```

### More Examples

```bash
# Task with a direct prompt
codegeass task create \
  --name check-tests \
  --prompt "Run the test suite and report any failures" \
  --schedule "0 3 * * *" \
  --working-dir /path/to/project

# List and monitor
codegeass task list              # List all tasks
codegeass task show daily-review # Show task details
codegeass logs list              # View execution logs
codegeass scheduler upcoming     # See upcoming runs
```

## Scheduler Management

```bash
# Check scheduler status
# macOS
launchctl list | grep codegeass

# Linux
systemctl --user status codegeass-scheduler.timer

# Uninstall scheduler
codegeass uninstall-scheduler
```

## CLI Commands

### Tasks

```bash
codegeass task list              # List all tasks
codegeass task show <name>       # Show task details
codegeass task create [opts]     # Create new task
codegeass task run <name>        # Run task manually
codegeass task stop <name>       # Stop running task
codegeass task enable <name>     # Enable task
codegeass task disable <name>    # Disable task
codegeass task delete <name>     # Delete task
```

### Skills

```bash
codegeass skill list             # List available skills
codegeass skill show <name>      # Show skill details
codegeass skill validate <name>  # Validate skill format
codegeass skill render <name>    # Preview rendered skill
```

### Scheduler

```bash
codegeass scheduler status       # Show scheduler status
codegeass scheduler run          # Run due tasks
codegeass scheduler run --force  # Run all enabled tasks
codegeass scheduler upcoming     # Show upcoming tasks
```

### Logs

```bash
codegeass logs list              # List recent logs
codegeass logs show <task>       # Show logs for task
codegeass logs tail <task>       # Tail recent logs
codegeass logs stats             # Show statistics
```

### Projects

```bash
codegeass project list           # List registered projects
codegeass project add <path>     # Register a project
codegeass project show <name>    # Show project details
codegeass project set-default <name>  # Set default project
codegeass project init [path]    # Initialize project structure
codegeass project remove <name>  # Unregister a project
codegeass project enable <name>  # Enable a project
codegeass project disable <name> # Disable a project
codegeass project update <name>  # Update project settings
```

### Notifications

```bash
codegeass notification list              # List notification channels
codegeass notification add               # Add a channel (interactive)
codegeass notification show <id>         # Show channel details
codegeass notification test <id>         # Test a channel
codegeass notification remove <id>       # Remove a channel
codegeass notification enable <id>       # Enable a channel
codegeass notification disable <id>      # Disable a channel
codegeass notification providers         # List available providers
```

### Providers

```bash
codegeass provider list          # List available code execution providers
codegeass provider info <name>   # Show provider details
codegeass provider check         # Check provider availability
```

## Notifications

Send notifications to chat platforms (Telegram, Discord, Microsoft Teams) when tasks start, complete, or fail.

### Setup

1. **Add a notification channel**:

```bash
# Add Telegram channel (interactive prompts for bot token and chat ID)
codegeass notification add --provider telegram --name "My Alerts"

# Add Discord channel (interactive prompt for webhook URL)
codegeass notification add --provider discord --name "DevOps Channel"

# Add Microsoft Teams channel (interactive prompt for webhook URL)
codegeass notification add --provider teams --name "Dev Team"
```

2. **Test the channel**:

```bash
codegeass notification test <channel-id>
```

3. **Create tasks with notifications**:

```bash
codegeass task create \
  --name daily-backup \
  --prompt "Run backup script" \
  --schedule "0 2 * * *" \
  --notify <channel-id> \
  --notify-on start \
  --notify-on complete \
  --notify-on failure
```

### Supported Providers

| Provider | Requirements | Features |
|----------|--------------|----------|
| **Telegram** | Bot token from @BotFather, Chat ID | Message editing, inline buttons, HTML formatting |
| **Discord** | Webhook URL | Markdown formatting, embeds |
| **Microsoft Teams** | Power Automate Workflows webhook URL | Adaptive Cards, Dashboard-based approvals |

### Configuration

Channels are stored in `config/notifications.yaml` (non-sensitive config).
Credentials are stored in `~/.codegeass/credentials.yaml` (secrets, not in repo).

### Message Editing

For Telegram, notifications are edited in-place rather than sending multiple messages:
- Task start: Shows "Running..."
- Task complete: Updates same message with result and duration

## Skills

Skills are Claude Code prompt templates stored in `.claude/skills/`. They follow the [Agent Skills](https://agentskills.io) open standard.

### Included Skills

- **review**: Comprehensive code review for PRs or recent changes (correctness, security, performance, maintainability, tests)
- **security-scan**: Deep security analysis with secrets detection, dependency vulnerabilities, and CWE references
- **code-review**: Automated code review with security, performance, and maintainability focus
- **security-audit**: Deep security analysis for OWASP vulnerabilities and secrets
- **test-runner**: Execute and analyze test suites
- **dependency-check**: Analyze dependencies for updates and vulnerabilities
- **refactor**: Automated code refactoring into clean, single-responsibility modules following SOLID principles

### Shared Skills

Place skills in `~/.codegeass/skills/` to make them available across all registered projects. Project-specific skills in `.claude/skills/` take priority over shared skills with the same name.

### Skill Format

```yaml
---
name: my-skill
description: What the skill does
context: fork
agent: Explore
allowed-tools: Read, Grep, Glob
---

# Skill Instructions

Instructions for $ARGUMENTS.

## Dynamic Context
- Status: !`git status`
```

## Configuration

### config/schedules.yaml

```yaml
tasks:
  - name: daily-code-review
    skill: code-review
    schedule: "0 9 * * 1-5"
    working_dir: /home/user/projects/myapp

  - name: weekly-security-audit
    skill: security-audit
    schedule: "0 2 * * 0"
    working_dir: /home/user/projects/myapp
    autonomous: true
```

### config/settings.yaml

```yaml
claude:
  default_model: sonnet
  default_timeout: 300
  unset_api_key: true

scheduler:
  check_interval: 60
  max_concurrent: 1
```

## Subscription Usage

**Important**: CodeGeass is designed to use your Claude Pro/Max subscription, NOT API credits.

The scheduler automatically unsets `ANTHROPIC_API_KEY` to ensure your subscription is used.

## Architecture

```
codegeass/
├── src/codegeass/
│   ├── core/           # Domain entities and value objects
│   │   └── entities/   # Modular entity classes (Task, Skill, Project, etc.)
│   ├── storage/        # Persistence layer (YAML, JSON)
│   │   └── project_repository.py  # Multi-project registry
│   ├── factory/        # Task and skill registries
│   │   └── skill_resolver.py  # Project + shared skills with priority
│   ├── providers/      # Universal code execution providers
│   │   ├── claude/     # Claude Code adapter
│   │   └── codex/      # OpenAI Codex adapter
│   ├── execution/      # Execution layer
│   │   ├── strategies/ # Execution strategies (headless, autonomous, skill, plan)
│   │   ├── tracker/    # Execution tracking and crash recovery
│   │   └── plan_service/  # Plan mode approval workflow
│   ├── scheduling/     # CRON parsing and job scheduling
│   ├── notifications/  # Chat notifications (Telegram, Discord, Teams)
│   │   └── callbacks/  # Interactive callback handling
│   └── cli/            # Click CLI commands
│       └── commands/   # Modular command groups (task/, project/, etc.)
├── dashboard/          # Web dashboard (React + FastAPI)
├── config/             # Configuration files
├── data/               # Runtime data (logs, sessions)
├── scripts/            # CRON runner script
└── .claude/skills/     # Claude Code skills

~/.codegeass/           # Global user configuration
├── projects.yaml       # Project registry
├── credentials.yaml    # Secrets
└── skills/             # Shared skills (all projects)
```

## Web Dashboard

A React + FastAPI dashboard for managing tasks and viewing logs.

```bash
codegeass dashboard
```

Then open http://localhost:8001

Or run manually:

```bash
cd dashboard
./setup.sh    # First-time setup
./run.sh      # Run frontend (5173) + backend (8001)
```

## Development

```bash
# Run tests
pytest tests/ -v

# Type checking
mypy src/codegeass

# Linting
ruff check src/codegeass

# Build package
python -m build
```

## Documentation

- **Live docs**: https://dontizi.github.io/codegeass/
- **Build locally**: `pip install -e ".[docs]" && mkdocs serve`

## Uninstalling

### Complete Uninstall

Remove everything (scheduler, config, logs, tasks):

```bash
codegeass uninstall --all
pipx uninstall codegeass
```

### Partial Uninstall

Remove scheduler only (keep your tasks and config):

```bash
codegeass uninstall-scheduler
pipx uninstall codegeass
```

### Uninstall Options

```bash
codegeass uninstall --all              # Remove everything
codegeass uninstall --all -y           # Skip confirmation
codegeass uninstall --all --keep-global   # Keep ~/.codegeass/
codegeass uninstall --all --keep-project  # Keep config/ and data/
```

## Troubleshooting

### Permission denied on macOS with pipx

```bash
mkdir -p ~/.local/bin && chmod 755 ~/.local/bin
pipx install codegeass
```

### Command not found after install

```bash
# Restart your terminal, or run:
source ~/.bashrc  # or ~/.zshrc
```

### Scheduler not running

```bash
# Check logs
# macOS
cat /tmp/codegeass-scheduler.log

# Linux
journalctl --user -u codegeass-scheduler -f
```

## Release Process

Releases are automated via GitHub Actions when a tag is pushed:

```bash
# Use the release skill
/release 0.2.0

# Or manually: update version, commit, tag, push
```

The workflow will:
1. Build and test the package
2. Publish to PyPI (via OIDC trusted publishing)
3. Create a GitHub release with assets
4. Deploy versioned documentation

## License

MIT
