Metadata-Version: 2.4
Name: claude-workflow
Version: 0.1.0
Summary: A terminal-based orchestrator for running Claude Code workflows defined in YAML files
Project-URL: Homepage, https://github.com/michalkatanski/claude-workflow
Project-URL: Repository, https://github.com/michalkatanski/claude-workflow
Project-URL: Issues, https://github.com/michalkatanski/claude-workflow/issues
Author: Michal Katanski
License: MIT
License-File: LICENSE
Keywords: automation,claude,orchestrator,tmux,workflow
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Requires-Dist: claude-agent-sdk>=0.1.0
Requires-Dist: claude-code-tools>=0.1.0
Requires-Dist: httpx>=0.25.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: questionary>=2.0.0
Requires-Dist: rich>=13.0.0
Description-Content-Type: text/markdown

# claude-workflow

A terminal-based orchestrator for running Claude Code workflows defined in YAML files.

## Installation

### Quick Start (Recommended)

```bash
# One-time: Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Run without installing
uvx claude-workflow /path/to/project
```

### Permanent Installation

```bash
uv tool install claude-workflow
```

## Requirements

- Python 3.11+
- tmux (must be running in a tmux session)

## Usage

```bash
# Start a tmux session first
tmux new -s workflow

# Run with interactive workflow picker
claude-workflow /path/to/project

# Run specific workflow by name
claude-workflow /path/to/project -w "Build and Test"

# Run specific workflow file
claude-workflow /path/to/project -f /path/to/workflow.yml
```

## Workflow Files

Workflows are defined in YAML files in your project's `.claude/` directory.

### Example Workflow

```yaml
type: claude-workflow
version: 2
name: Build and Test

steps:
  - name: Install dependencies
    prompt: Install all project dependencies

  - name: Run tests
    prompt: Run the test suite and fix any failures

  - name: Build
    prompt: Build the project for production
```

### Required Fields

- `type: claude-workflow` - Identifies the file as a workflow
- `version: 2` - Workflow format version
- `name` - Display name for the workflow
- `steps` - List of steps to execute

## Updating

```bash
# Always run latest version
uvx claude-workflow@latest /path/to/project

# Or upgrade installed tool
uv tool upgrade claude-workflow
```

## License

MIT
