Skip to content

README.md

Latest commit

 

History

History
171 lines (125 loc) · 6.67 KB

README.md

File metadata and controls

171 lines (125 loc) · 6.67 KB

Pocket Documentation Hub

Welcome to the comprehensive documentation for Pocket, a graph execution engine for building LLM workflows.

🚀 Quick Start by Use Case

Use Case 1: Run Workflows with CLI (No Coding Required)

Perfect for most users who want to run workflows defined in YAML:

  1. Install Pocket CLI - Get up and running in minutes
  2. Getting Started Tutorial - Create your first workflow
  3. YAML Schema Reference - Define workflows in YAML
  4. Command Reference - All CLI commands

Example:

# Install via Homebrew
brew install agentstation/tap/pocket

# Run a workflow
pocket run workflow.yaml

Use Case 2: Embed in Go Applications

For developers building Go applications:

  1. Library Getting Started - Build workflows in Go
  2. Embedding Guide - Integrate into your application
  3. API Reference - Complete API documentation

Example:

import "github.com/agentstation/pocket"

node := pocket.NewNode[string, string]("process",
    pocket.WithExec(processFunc),
)

📚 Documentation Structure

🖥️ CLI Documentation

Everything you need to use Pocket as a command-line tool.

📦 Library Documentation

For embedding Pocket in your Go applications.

🎯 Core Concepts

Understand the fundamental architecture of Pocket's graph execution engine.

🔌 Node Types

Documentation for all available node types.

🔄 Workflow Examples

Real-world workflow examples organized by complexity.

📖 Guides

Step-by-step guides for specific topics.

🔧 Patterns

Common patterns for building sophisticated workflows.

🚀 Advanced Topics

Deep dives into advanced features.

🛠️ Development

For contributors and plugin developers.

📋 Reference

Detailed reference documentation.

🎓 Learning Paths

For CLI Users

  1. Start with CLI Installation
  2. Follow the Getting Started Tutorial
  3. Learn the YAML Schema
  4. Explore Workflow Examples
  5. Install Plugins for extended functionality

For Go Developers

  1. Begin with Library Getting Started
  2. Understand Core Architecture
  3. Learn the Prep/Exec/Post Pattern
  4. Master Type Safety
  5. Study Embedding Patterns

For Plugin Developers

  1. Read Plugin System Overview
  2. Choose your approach:
  3. Follow Plugin Development Guide
  4. See Plugin Examples

🔍 Quick Links

📝 Contributing to Documentation

We welcome documentation improvements! If you find errors or have suggestions:

  1. Open an issue describing the improvement
  2. Submit a PR with your changes
  3. Ensure examples are tested and working

See our Contributing Guide for more details.