Skip to main content

Claude Code Scheduler Framework - Orchestrate automated Claude Code sessions

Project description

CodeGeass Logo

CodeGeass

PyPI version Python 3.10+ License: MIT

Claude Code Scheduler Framework - Orchestrate automated Claude Code sessions with templates, prompts and skills, executed via CRON with your Pro/Max subscription.

Features

  • Scheduled Tasks: Define tasks with CRON expressions for automated execution
  • Multi-Provider Support: Use Claude Code, OpenAI Codex, or other AI coding assistants
  • Multi-Project Support: Manage multiple projects from a single installation with shared skills
  • Skills Integration: Use Claude Code skills (.claude/skills/) for consistent, reusable prompts
  • Multiple Strategies: Headless, autonomous, or skill-based execution
  • Session Management: Track execution history with detailed logs
  • CLI Interface: Full-featured command line tool for task management
  • Web Dashboard: React + FastAPI dashboard for monitoring and management
  • Notifications: Telegram, Discord, and Microsoft Teams notifications with plan approval support
  • 24/7 Service: Automatic scheduler for macOS (launchd) and Linux (systemd)

Installation

Using pipx (Recommended)

pipx installs CLI tools in isolated environments. This is the recommended method:

# 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:

# 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

pipx install "codegeass[notifications]"

From Source

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

Verify Installation

codegeass --version

Quick Start

1. Full Setup (One Command)

codegeass setup

This will:

  • Detect your OS (macOS/Linux)
  • Install the 24/7 background scheduler
  • Show you the next steps

2. Initialize a Project

cd /path/to/your/project
codegeass init

3. Create a Task

# Using a skill
codegeass task create \
  --name daily-review \
  --skill code-review \
  --schedule "0 9 * * 1-5" \
  --working-dir /path/to/project

# Using 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

4. Manage Tasks

codegeass task list              # List all tasks
codegeass task show daily-review # Show task details
codegeass task run daily-review  # Run manually

5. Monitor

codegeass logs list              # View execution logs
codegeass scheduler upcoming     # See upcoming runs
codegeass dashboard              # Open web dashboard

Scheduler Management

# Check scheduler status
# macOS
launchctl list | grep codegeass

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

# Uninstall scheduler
codegeass uninstall-scheduler

CLI Commands

Tasks

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

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

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

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

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

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

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:
# 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"
  1. Test the channel:
codegeass notification test <channel-id>
  1. Create tasks with notifications:
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 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

---
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

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

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.

codegeass dashboard

Then open http://localhost:8001

Or run manually:

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

Development

# Run tests
pytest tests/ -v

# Type checking
mypy src/codegeass

# Linting
ruff check src/codegeass

# Build package
python -m build

Documentation

Uninstalling

Complete Uninstall

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

codegeass uninstall --all
pipx uninstall codegeass

Partial Uninstall

Remove scheduler only (keep your tasks and config):

codegeass uninstall-scheduler
pipx uninstall codegeass

Uninstall Options

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

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

Command not found after install

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

Scheduler not running

# 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:

# 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

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

codegeass-0.2.2.tar.gz (485.4 kB view details)

Uploaded Source

Built Distribution

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

codegeass-0.2.2-py3-none-any.whl (532.5 kB view details)

Uploaded Python 3

File details

Details for the file codegeass-0.2.2.tar.gz.

File metadata

  • Download URL: codegeass-0.2.2.tar.gz
  • Upload date:
  • Size: 485.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codegeass-0.2.2.tar.gz
Algorithm Hash digest
SHA256 f8d09c0b9a287627b2c7e8ff1151c1497fff6fdfe31e6eb5531cb9ce215eba66
MD5 31baea7307c75d4ee0d9a8aba180e834
BLAKE2b-256 e81eaf03548d683bc4b91bc8fd0eb46c3cacd1d8c2fb4288409cbef5435cbe7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for codegeass-0.2.2.tar.gz:

Publisher: release.yml on DonTizi/CodeGeass

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codegeass-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: codegeass-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 532.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codegeass-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 af176881a8993071f71a3f6bc39c46bf4ade47208f268d53236f3daa333f5804
MD5 e04c3d9f94a7bae601f3ebaa67ad177d
BLAKE2b-256 5f9f1bfcfcd512eadd333c935ab3384f843fc692e17e8acd498a9fe71d0c5f91

See more details on using hashes here.

Provenance

The following attestation bundles were made for codegeass-0.2.2-py3-none-any.whl:

Publisher: release.yml on DonTizi/CodeGeass

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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