Skip to main content

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

Project description

claude-workflow

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

Installation

Quick Start (Recommended)

# 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

uv tool install claude-workflow

Requirements

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

Usage

# 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

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

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

# Or upgrade installed tool
uv tool upgrade claude-workflow

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

claude_workflow-0.1.0.tar.gz (33.9 kB view details)

Uploaded Source

Built Distribution

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

claude_workflow-0.1.0-py3-none-any.whl (47.1 kB view details)

Uploaded Python 3

File details

Details for the file claude_workflow-0.1.0.tar.gz.

File metadata

  • Download URL: claude_workflow-0.1.0.tar.gz
  • Upload date:
  • Size: 33.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for claude_workflow-0.1.0.tar.gz
Algorithm Hash digest
SHA256 84be6f4292b6e7238639f7e422ad358ff3137d592f103e0b5f080e6190e5b9b5
MD5 b20785e2fbb585db8e7399e5dcc4b990
BLAKE2b-256 21d7e69b7745a38a63fc5712551db3ae45b949d838257ba6e82e833f2c937fef

See more details on using hashes here.

File details

Details for the file claude_workflow-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: claude_workflow-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for claude_workflow-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79edd580b238b706eac558aa279529000760940e2de635d543b262d03860c867
MD5 de9295c659ce263d50950c7578cc9cf8
BLAKE2b-256 3129d67c1746edab60906de3c4f88cb6678afc3012d35df9d91168d9b8a52cd7

See more details on using hashes here.

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