docs

go-llmspell Documentation

Welcome to the go-llmspell documentation. This directory contains comprehensive guides for understanding and using go-llmspell.

Documentation Structure

Core Documentation

• architecture.md - System architecture and design principles
• implementation-guide.md - Step-by-step implementation roadmap
• spell-development.md - Guide to writing spells in Lua, JavaScript, and Tengo

Getting Started

• getting-started.md - Quick start guide for new users
• env-setup.md - Environment and API key configuration

API Reference

• lua-stdlib.md - Lua standard library reference
• api-reference.md - Complete API documentation (coming soon)
• bridge-api.md - Bridge interface documentation (coming soon)

Examples

• spellbook.md - Collection of pre-written spells (coming soon)
• tutorials/ - Step-by-step tutorials (coming soon)

Overview

go-llmspell transforms complex LLM interactions into simple, scriptable spells. It provides:

• Multi-language Support: Write spells in Lua, JavaScript, or Tengo
• Unified API: Consistent interface across all scripting languages
• Tool Integration: Create and use custom tools in your spells
• Agent Orchestration: Build intelligent agents with access to tools
• Workflow Automation: Chain operations into complex workflows
• Security: Sandboxed execution with resource limits

Quick Links

• Project README
• Architecture Overview
• Writing Your First Spell
• Implementation Roadmap

Getting Help

• Check the Architecture for system design questions
• See Spell Development for scripting help
• Review Implementation Guide for development roadmap