Skip to content

Vooster-AI/pipeline-kit

Repository files navigation

Pipeline Kit

AI agent pipeline orchestration CLI with interactive TUI, built with Rust for performance and distributed via npm for convenience.

npm version License: MIT CI codecov Security Audit

Features

  • Multi-Agent Pipelines: Orchestrate multiple AI agents (Claude, Gemini, Cursor) in sequential workflows
  • Interactive TUI: Real-time process monitoring with dashboard and detail views built with ratatui
  • Slash Commands: Execute commands with autocomplete (/start, /pause, /resume, /kill, /list)
  • Event-Driven: Async communication between core engine and UI for responsive interactions
  • Cross-Platform: Native binaries for macOS, Linux, Windows (x64 and ARM64)
  • Git Integration: Optional git commit automation after pipeline completion
  • Human Review Points: Pause pipelines for manual review before continuing

Quick Start

Installation

# Install globally via npm
npm install -g pipeline-kit

# Or use directly with npx
npx pipeline-kit

Initialize Your Project

The easiest way to get started is with the init command:

# Initialize .pipeline-kit directory with templates
pipeline-kit init

# Or use minimal templates (1 agent, 1 pipeline)
pipeline-kit init --minimal

# Initialize in a specific directory
pipeline-kit init --path ~/my-project

This will create:

  • .pipeline-kit/config.toml - Global configuration
  • .pipeline-kit/agents/ - Agent definitions (developer, reviewer)
  • .pipeline-kit/pipelines/ - Pipeline workflows (simple-task, code-review)

Manual Setup (Alternative)

If you prefer manual setup instead of using init:

  1. Create configuration directory:
mkdir -p .pipeline-kit/{agents,pipelines}
  1. Configure an agent (.pipeline-kit/agents/developer.md):
---
name: developer
description: A helpful coding assistant
model: claude-sonnet-4.5
color: blue
---

You are a helpful coding assistant. Your goal is to help users with their programming tasks efficiently and accurately.
  1. Create a pipeline (.pipeline-kit/pipelines/code-review.yaml):
name: code-review
master:
  model: claude-sonnet-4.5
  system-prompt: |
    You are the master orchestrator for a code review pipeline.
    Coordinate between agents to ensure high-quality code.
  process:
    - developer
    - reviewer
    - HUMAN_REVIEW
sub-agents:
  - developer
  - reviewer
  1. Set up API keys:
# For Claude
export ANTHROPIC_API_KEY=your_api_key

# For Gemini
export GEMINI_API_KEY=your_api_key

# For Cursor
export CURSOR_API_KEY=your_api_key
  1. Launch the TUI:
pipeline-kit
  1. Start a pipeline: Type /start simple-task in the command input and press Enter.

Configuration

Directory Structure

your-project/
├── .pipeline-kit/
│   ├── config.toml              # Global settings
│   ├── agents/                  # Agent definitions
│   │   ├── developer.md
│   │   ├── reviewer.md
│   │   └── researcher.md
│   └── pipelines/               # Pipeline workflows
│       ├── code-review.yaml
│       ├── feature-dev.yaml
│       └── bug-fix.yaml

Global Configuration (config.toml)

# Enable git integration
git = true

# Default timeout for agent execution (seconds)
timeout = 300

Agent Configuration

Agents are defined in Markdown files with YAML frontmatter:

---
name: agent-name
description: Brief description
model: claude-sonnet-4.5  # or gemini-1.5-pro, cursor-default
color: blue               # UI color: blue, green, yellow, red, etc.
---

System prompt for the agent goes here.
You can use multiple paragraphs and markdown formatting.

Key responsibilities:
- Task 1
- Task 2

Supported Models:

  • Claude: claude-sonnet-4.5, claude-opus-4, claude-haiku-4
  • Gemini: gemini-1.5-pro, gemini-1.5-flash
  • Cursor: cursor-default

Pipeline Configuration

Pipelines are defined in YAML:

name: pipeline-name

# Master agent coordinates the workflow
master:
  model: claude-sonnet-4.5
  system-prompt: |
    Your role as the master orchestrator.
    Coordinate between sub-agents to achieve the goal.

  # Sequential process steps
  process:
    - researcher      # First sub-agent
    - developer       # Second sub-agent
    - HUMAN_REVIEW    # Pause for manual review
    - reviewer        # Final sub-agent

# List of sub-agents used in this pipeline
sub-agents:
  - researcher
  - developer
  - reviewer

# Optional: Required reference files
required-reference-file: false

Special Keywords:

  • HUMAN_REVIEW: Pauses the pipeline for manual review. Resume with /resume <process-id>

Usage

TUI Mode (Interactive)

Launch the interactive terminal UI:

pipeline-kit

Keyboard Controls:

  • ↑/↓ or j/k: Navigate between processes
  • Tab: Autocomplete slash commands
  • Enter: Execute command
  • Esc: Clear input
  • PageUp/PageDown: Fast scroll in detail view
  • q or Ctrl+C: Quit

CLI Mode (Non-Interactive)

Execute commands directly from the command line:

# Initialize a new project
pipeline-kit init
pipeline-kit init --minimal
pipeline-kit init --force

# Start a pipeline (TUI mode)
pipeline-kit

# Show help
pipeline-kit --help

Slash Commands

Available commands in TUI mode:

Command Description Example
/start <name> Start a new pipeline /start code-review
/pause <id> Pause a running process /pause a1b2c3d4
/resume <id> Resume a paused process /resume a1b2c3d4
/kill <id> Kill a running process /kill a1b2c3d4
/list List all active processes /list
/detail <id> Show process details /detail a1b2c3d4

Tip: Use Tab for command autocomplete and process ID suggestions.

Supported Agents

Pipeline Kit supports multiple AI providers through adapters:

Claude (Anthropic)

export ANTHROPIC_API_KEY=your_api_key

Models:

  • claude-sonnet-4.5 (recommended)
  • claude-opus-4
  • claude-haiku-4

Features: Streaming responses, tool calling, vision support

Gemini (Google)

export GEMINI_API_KEY=your_api_key

Models:

  • gemini-1.5-pro
  • gemini-1.5-flash

Features: Streaming responses, multimodal input

Cursor

export CURSOR_API_KEY=your_api_key

Models:

  • cursor-default

Features: Code-focused assistant

Example Workflows

Code Review Pipeline

name: code-review
master:
  model: claude-sonnet-4.5
  system-prompt: |
    Orchestrate a thorough code review process.
    Ensure code quality, testing, and documentation.
  process:
    - developer       # Implements the feature
    - reviewer        # Reviews the code
    - HUMAN_REVIEW    # Manual approval
sub-agents:
  - developer
  - reviewer

Feature Development Pipeline

name: feature-dev
master:
  model: claude-sonnet-4.5
  system-prompt: |
    Guide the development of a new feature from planning to implementation.
  process:
    - researcher      # Research requirements
    - architect       # Design the solution
    - developer       # Implement the feature
    - tester          # Write tests
    - HUMAN_REVIEW    # Final review
sub-agents:
  - researcher
  - architect
  - developer
  - tester

Bug Fix Pipeline

name: bug-fix
master:
  model: claude-sonnet-4.5
  system-prompt: |
    Coordinate debugging and fixing process.
  process:
    - debugger        # Identify the issue
    - developer       # Implement the fix
    - tester          # Verify the fix
sub-agents:
  - debugger
  - developer
  - tester

Architecture

Pipeline Kit uses a monorepo architecture with clear separation of concerns:

┌─────────────────┐
│   User (CLI)    │
└────────┬────────┘
         │
         ▼
┌─────────────────────┐
│  TypeScript Wrapper │  (Platform detection & binary launcher)
│  pipeline-kit-cli   │
└────────┬────────────┘
         │
         ▼
┌──────────────────────────────────────────┐
│         Rust Binary (pipeline-kit-rs)    │
├──────────────────────────────────────────┤
│  ┌────────┐           ┌──────────────┐  │
│  │  TUI   │ ◄────────►│    Core      │  │
│  │(ratatui)│  Op/Event │  (Business)  │  │
│  └────────┘           └───┬──────────┘  │
│                           │              │
│                  ┌────────┼────────┐     │
│                  │        │        │     │
│              ┌───▼──┐ ┌───▼────┐ ┌▼────┐│
│              │State │ │Pipeline│ │Agent││
│              │Mgr   │ │Engine  │ │Mgr  ││
│              └──────┘ └────────┘ └─────┘│
└──────────────────────────────────────────┘

Key Components:

  • pk-protocol: Shared data structures and IPC definitions
  • pk-core: Business logic (StateManager, PipelineEngine, AgentManager)
  • pk-tui: Interactive terminal UI with widgets
  • pk-cli: Binary entry point that wires everything together

Development

Want to contribute? See CONTRIBUTING.md for:

  • Development setup
  • Project structure details
  • Testing strategy
  • Coding conventions
  • PR submission guidelines

Quick Development Setup

# Clone repository
git clone https://github.com/Vooster-AI/pipeline-kit.git
cd pipeline-kit

# Build Rust workspace
cd pipeline-kit-rs
cargo build --release

# Run tests
cargo test --workspace

# Run the TUI
cargo run --release --bin pipeline

Troubleshooting

Binary Not Found

If you get "binary not found" error:

# Check vendor directory
ls -la node_modules/pipeline-kit/vendor/

# Reinstall to download binaries
npm install -g pipeline-kit --force

API Key Issues

Ensure environment variables are set:

# Check if API keys are set
echo $ANTHROPIC_API_KEY
echo $GEMINI_API_KEY
echo $CURSOR_API_KEY

# Set in your shell profile (~/.bashrc, ~/.zshrc)
export ANTHROPIC_API_KEY=your_key_here

Configuration Not Found

Pipeline Kit looks for .pipeline-kit/ in:

  1. Current directory
  2. Parent directories (up to repository root)
  3. Home directory (~/.pipeline-kit/)

Verify your configuration directory exists:

ls -la .pipeline-kit/

Platform Support

Platform Architecture Binary Name Status
macOS Intel (x64) macos-x64 ✅ Supported
macOS Apple Silicon (ARM64) macos-arm64 ✅ Supported
Linux x86_64 linux-x64 ✅ Supported
Linux ARM64 linux-arm64 ✅ Supported
Windows x64 windows-x64 ✅ Supported
Windows ARM64 windows-arm64 ⚠️ Experimental

License

MIT License - see LICENSE file for details.

Credits

Built with reference to the excellent codex-cli architecture.

Links


Made with ❤️ by the Vooster AI team

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •