Glazed Help Browser

Packages

Available packages

Sections

Terminology & Glossary
📖 Documentation
Navigation
57 sectionsv0.1
📄 Documentation

Documentation Index

57 sections available

📖 Topics

Autosaving Conversations in Pinocchio

Configure automatic saving of conversation histories

Chatapp Protobuf Schemas and Shared Plugins

Reference for Pinocchio chatapp protobuf contracts, segment-aware message entities, and shared reasoning/tool-call plugins.

Engine Profiles in Geppetto

Engine-only profile registries for resolving `InferenceSettings` in Geppetto.

Events, Streaming, and Watermill in Geppetto

Engine-first event publishing with EventSink, Watermill routing, and context-carried sinks for streaming AI.

Geppetto documentation index

Task-based index for Geppetto docs and example programs.

Geppetto JavaScript API Reference

Reference for the native `require("geppetto")` API exposed through goja.

Geppetto JavaScript API User Guide

Practical guide for writing scripts against the hard-cut Geppetto JavaScript API.

MD-Extract - Extract content from markdown files

Extract and process different types of blocks from markdown files

Opinionated Runner API

App-facing `pkg/inference/runner` package for building simple and event-driven inference programs from resolved runtime input.

Pinocchio ChatBuilder Guide

Build terminal chat UIs with the unified ChatBuilder/ChatSession API and Watermill event routing.

Pinocchio Profile Resolution

How Pinocchio builds hidden base settings and merges engine profiles without contaminating the underlying baseline.

Pinocchio Runtime Symbol Migration Playbook

Upgrade third-party integrations from legacy runtime symbol names to canonical names after alias removal.

Pinocchio TUI Integration Playbook (Debugging + Ops)

Operational checklist and debugging playbook for Pinocchio terminal TUI integrations using Bobatea timeline entities and Watermill event routing.

Protobuf JSONL RPC Output

Use `--rpc` or `--output jsonl` to stream protobuf-defined Pinocchio chat frames for scripts and subprocess clients.

Temporizer - Creating temporary files

Using temporizer for managing temporary context files

Token Count Modes

Choosing between local estimates and provider-native token counting

Using catter to gather source code for LLMs

Process and analyze source code for LLM context preparation and token analysis

Webchat Debugging and Operations

Operational procedures for diagnosing and troubleshooting webchat issues.

Webchat Frontend Architecture

Frontend architecture for the sessionstream-backed webchat application.

Webchat Frontend Integration

How frontend clients integrate with the sessionstream-backed chat API, WebSocket transport, and snapshot hydration.

Webchat Runtime Truth Migration Playbook

Migrate and validate per-turn runtime truth with conversation current-runtime semantics.

🎓 Tutorials

Add a New Event Handler

Step-by-step guide to implement a custom event handler, subscribe it to the router, and parse incoming events.

Add a New Tool

Step-by-step guide to define a tool, register it, attach the registry to context, and configure tool calling on a Turn.

Bootstrap binary StepSettings from defaults, config, registries, and profile

Applications now bootstrap StepSettings from defaults/config/env/flags only; profiles no longer patch them.

Build a Streaming Inference Command with Tool Calling

Step-by-step tutorial to build a Cobra command that streams model output and supports tool calling using Geppetto.

Build a Streaming Tool-Loop Agent with Glazed Flags

Step-by-step tutorial for building a small Glazed CLI that streams events, runs a tool loop, and keeps engine settings hidden in app bootstrap.

Build Scoped JavaScript Eval Tools

Intern-friendly developer guide to designing, wiring, and debugging `eval_xxx` tools with `pkg/inference/tools/scopedjs`.

Building a Middleware with a Renderer and Wiring It into a Timeline-Driven App

Step-by-step guide to creating a Geppetto middleware that emits UI events and a Bubble Tea renderer to display them in the Pinocchio timeline.

Building a React + Go LLM Chat App on Sessionstream and Pinocchio

Step-by-step playbook for building a sessionstream-backed React chat app with Go handlers, Geppetto inference, hydration, websockets, and custom widgets.

CLI Command Migration Guide (Glazed + Bootstrap + Profiles)

Step-by-step guide to migrate a Cobra command to the current Glazed + bootstrap path with profile resolution and shared inference-debug output.

Embeddings Workflows

Build applications using embeddings for semantic search, with single/batch generation and caching strategies.

Event Routing and Structured Logging

Build an application that routes inference events to multiple handlers and produces structured JSON/YAML logs.

Getting Started with the Geppetto JavaScript API

Build and run a session-centered Geppetto JavaScript script.

Linting in Geppetto (go/analysis and custom vettools)

How Geppetto runs linting, how to add custom go/analysis analyzers, and how turnsdatalint works

Middlewares in Geppetto (Turn-based)

A practical guide to writing, composing, and using middlewares with Turn-based engines.

Migrate to Geppetto Sections and Values (No Compatibility Layer)

Hard-cut migration guide from old Geppetto layer/parameter symbols to the new section/value facade API.

Migrating Legacy Pinocchio Config to Unified Profile Documents

Step-by-step migration guide from legacy Pinocchio config keys to the unified app/profile/profiles document model.

Migration playbook: legacy profiles.yaml to runtime registry YAML

Legacy profile-map migration has been removed after the StepSettingsPatch hard cut.

Migration playbook: move to Session/EngineBuilder/ExecutionHandle

Step-by-step guide to migrate from the legacy inference lifecycle APIs to geppetto/pkg/inference/session.

OAuth profile login and renewable credentials

Log into a profile with PKCE and keep renewable OAuth state in one owner-only registry.

Operate SQLite-backed profile registry

Runbook for operating, inspecting, backing up, and recovering SQLite-backed profile registry storage.

Pinocchio Companion: Migrating CLI Verbs to the Geppetto Bootstrap Path

Pinocchio-specific companion to the generic Geppetto CLI bootstrap migration tutorial.

Pinocchio TUI Integration Guide (Tool-Loop / Agent Mode)

Step-by-step guide to embed Pinocchio’s Bubble Tea + Bobatea terminal chat UI with the extracted tool-loop backend and agent forwarder.

Progressive Structured Data Extraction

Step-by-step guide to extract structured data from streaming LLM output using filtering sinks and custom extractors.

Run JavaScript Runner Scripts

Use `pinocchio js` to run JavaScript scripts with Pinocchio config defaults and Geppetto's session-centered JS API.

Session Management in Geppetto

Managing multi-turn interactions with session.Session — turn history, inference lifecycle, and async execution.

Structured Data Extraction from Streaming Output

Build an application that extracts structured data from streaming LLM output in real-time.

Structured Sinks and the FilteringSink

Extracting structured data from LLM text streams using tagged blocks and the FilteringSink.

Tools in Geppetto (Turn-based)

A complete guide to defining, attaching, and executing tools with Turns. Tool registries are carried via `context.Context` (Turn state stays serializable).

Turns and Blocks in Geppetto

Understanding the Run/Turn/Block data model and how engines and middleware use it

Understanding and Using the Embeddings Package

A guide to the embeddings package in Geppetto, covering embedding generation, caching, and integrating with applications.

Understanding and Using the Geppetto Inference Engine Architecture (Turn-based)

A comprehensive guide to the Turn-based inference engine architecture, covering engines, streaming, and provider implementations.

Understanding and Using the Rerank Package

A guide to the rerank package in Geppetto, covering cross-encoder reranking, the llama.cpp adapter, profile integration, and the JavaScript API.

Use renewable bearer credentials with OpenAI-compatible engines

Inject host-owned renewable bearer credentials without placing refresh state in inference settings.

Using Scoped Tool Databases

Build a read-only scoped SQLite tool with `geppetto/pkg/inference/tools/scopeddb`, choose prebuilt or lazy registration, and keep queries safe.

Webchat Getting Started

Quick start for running the Pinocchio webchat backend and React UI locally.

Wire provider credentials for JS and go runner

Resolve provider credentials through Geppetto/Pinocchio profiles and pass final settings to engines.