Project

chiron

0.0
The project is in a healthy, maintained state
A Ruby gem that sets up Claude AI development workflows, PRD templates, and journaling system for Rails and Python projects
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 2.0
~> 13.0
~> 3.0
~> 1.21

Runtime

~> 1.1
~> 1.3
~> 0.23
 Project Readme

Chiron

A Ruby gem that initializes Claude AI development workflows, PRD templates, and journaling system for Rails and Python projects. Named after the wise centaur who mentored heroes, Chiron helps you quickly set up a structured development process that integrates seamlessly with Claude Code.

Features

  • 🚀 Quick Setup: Initialize Claude workflow with one command
  • 📋 PRD Workflow: Structured Product Requirements Document creation
  • Task Management: Generate and track implementation tasks
  • 📓 Development Journal: Track progress and maintain project history
  • 🔄 Migration Tool: Easy migration from .cursor to .claude structure
  • 🎯 Quality Checks: Pre-commit checklists and TDD workflows
  • 🛠️ Customizable: Adapt workflows to your team's needs

Installation

Add this line to your application's Gemfile:

gem 'chiron'

And then execute:

bundle install

Or install it yourself as:

gem install chiron

Usage

Initialize Claude Workflow

In your project root (Rails or Python):

chiron init

This will:

  • Auto-detect your project type (Rails/Python)
  • Create .claude/commands/ directory with workflow templates
  • Generate CLAUDE.md with language-specific configuration
  • Set up tasks/ directory for PRDs and task lists
  • Initialize development journal in docs/
  • Update .gitignore appropriately

Command Options

# Initialize Rails project with options
chiron init --project-name="MyApp" --with-viewcomponents

# Initialize Python project with framework-specific patterns
chiron init --type=python --with-django
chiron init --type=python --with-fastapi

# Migrate from .cursor to .claude
chiron migrate-cursor

# Add specific workflow
chiron add-workflow test-driven

# Update workflows to latest version
chiron update

# Check setup health
chiron doctor

Workflow Structure

After initialization, you'll have:

your-project/
├── .claude/
│   ├── commands/
│   │   ├── workflows/      # Development workflows
│   │   │   ├── create-prd.md
│   │   │   ├── generate-tasks.md
│   │   │   ├── process-tasks.md
│   │   │   ├── debug-python.md    # Python debugging (Python projects)
│   │   │   ├── python-refactor.md # Python refactoring (Python projects)
│   │   │   └── flask-development.md # Flask patterns (Flask projects)
│   │   ├── conventions/    # Language/framework rules
│   │   │   ├── rails.md    # Rails-specific
│   │   │   └── python.md   # Python-specific
│   │   ├── context/        # Context commands
│   │   │   ├── quickstart.md
│   │   │   └── catchup.md
│   │   ├── journal/        # Journal management
│   │   │   ├── instructions.md
│   │   │   └── template.md
│   │   └── quality/        # Quality assurance
│   │       ├── pre-commit.md
│   │       ├── test-driven.md
│   │       └── python-testing.md  # Python testing (Python projects)
│   └── settings.json       # Claude permissions
├── CLAUDE.md              # Project-specific Claude instructions
├── tasks/                 # PRDs and task lists
└── docs/
    └── development_journal.md

Key Workflows

1. Creating a PRD

When starting a new feature, Claude will:

  • Ask clarifying questions
  • Generate a structured PRD
  • Save it as tasks/prd-[feature-name].md

2. Generating Tasks

From a PRD, Claude will:

  • Create high-level tasks
  • Break them into subtasks
  • Save as tasks/tasks-prd-[feature-name].md

3. Development Journal

Claude maintains a journal with:

  • Daily work summaries
  • Technical decisions
  • Bug fixes and features
  • Multi-developer collaboration tracking

4. Quality Checks

Before committing:

  • Run the pre-commit checklist
  • Follow TDD workflow
  • Update documentation

Example Claude Commands

After setup, you can tell Claude:

  • "Create a PRD for user authentication"
  • "Generate tasks from prd-user-auth.md"
  • "Catchup" (for project status)
  • "Update the journal"
  • "Run pre-commit checks"

Language-Specific Commands

Rails:

  • "Run RuboCop on this file"
  • "Generate an RSpec test"
  • "Create a Rails migration"

Python:

  • "Format this with Black"
  • "Create a pytest fixture"
  • "Generate a Django model"
  • "Debug this async function"
  • "Refactor this class using SOLID principles"
  • "Add type hints to this function"

Supported Project Types

Rails Projects

  • Full Rails conventions and best practices
  • RSpec testing patterns
  • Hotwire/Stimulus integration
  • ViewComponent support (optional)
  • RuboCop for code quality

Python Projects

  • Auto-detects Django, FastAPI, Flask, or generic Python
  • pytest testing patterns with fixtures and parametrization
  • Black/flake8/mypy for code quality and type checking
  • Framework-specific templates (Django ORM, FastAPI async, Flask blueprints)
  • Debugging workflows with pdb and logging
  • Refactoring patterns and SOLID principles
  • Virtual environment and dependency management best practices

Customization

All templates are customizable. After initialization:

  1. Edit files in .claude/commands/ to match your workflow
  2. Modify CLAUDE.md for project-specific instructions
  3. Add custom workflows as needed

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ebrett/chiron.

License

The gem is available as open source under the terms of the MIT License.