kit/search.json

{
  "version": 1,
  "generator": "tome",
  "site": "Kit",
  "totalPages": 22,
  "searchEndpoint": "/pagefind/pagefind.js",
  "pages": [
    {
      "id": "advanced/json-output",
      "url": "https://go-kit.dev/advanced/json-output",
      "title": "JSON Output",
      "description": "Machine-readable JSON output for scripting and automation.",
      "headings": [
        "Response format",
        "Fields",
        "Top-level",
        "Usage",
        "Message parts",
        "Parsing in scripts",
        "bash + jq",
        "Go SDK"
      ],
      "tags": [],
      "wordCount": 331
    },
    {
      "id": "advanced/subagents",
      "url": "https://go-kit.dev/advanced/subagents",
      "title": "Subagents",
      "description": "Multi-agent orchestration with Kit subagents.",
      "headings": [
        "Subprocess pattern",
        "Built-in subagent tool",
        "Extension subagents",
        "Monitoring subagents from extensions",
        "Go SDK subagents",
        "Real-time subagent events"
      ],
      "tags": [],
      "wordCount": 661
    },
    {
      "id": "advanced/testing",
      "url": "https://go-kit.dev/advanced/testing",
      "title": "Testing with tmux",
      "description": "Test Kit's TUI non-interactively using tmux.",
      "headings": [
        "Basic pattern",
        "Testing extensions",
        "Tips"
      ],
      "tags": [],
      "wordCount": 264
    },
    {
      "id": "cli/commands",
      "url": "https://go-kit.dev/cli/commands",
      "title": "Commands",
      "description": "Complete reference for all Kit CLI subcommands.",
      "headings": [
        "Authentication",
        "Model database",
        "Extension management",
        "Installing extensions from git",
        "Skills",
        "Skills CLI flags",
        "Interactive slash commands",
        "Prompt history",
        "Cancelling operations",
        "External editor",
        "Mid-turn steering",
        "Image attachments",
        "Prompt templates",
        "Creating templates",
        "Using templates",
        "Argument placeholders",
        "CLI flags",
        "ACP server"
      ],
      "tags": [],
      "wordCount": 1156
    },
    {
      "id": "cli/flags",
      "url": "https://go-kit.dev/cli/flags",
      "title": "Global Flags",
      "description": "Complete reference for all Kit CLI flags.",
      "headings": [
        "Model and provider",
        "Session management",
        "Behavior",
        "Extensions",
        "Skills",
        "Generation parameters",
        "System"
      ],
      "tags": [],
      "wordCount": 560
    },
    {
      "id": "configuration",
      "url": "https://go-kit.dev/configuration",
      "title": "Configuration",
      "description": "Configure Kit using config files, environment variables, and CLI flags.",
      "headings": [
        "Basic configuration",
        "All configuration keys",
        "Environment variables",
        "MCP server configuration",
        "MCP server fields",
        "MCP tasks (long-running tools)",
        "Custom models",
        "Custom model fields",
        "Per-model settings",
        "Per-model fields",
        "Precedence summary",
        "Theme configuration",
        "Preferences persistence"
      ],
      "tags": [],
      "wordCount": 1539
    },
    {
      "id": "development",
      "url": "https://go-kit.dev/development",
      "title": "Development",
      "description": "Build, test, and contribute to Kit.",
      "headings": [
        "Build and test",
        "Project structure",
        "Architecture overview",
        "Multi-provider LLM support",
        "MCP client-server model",
        "Extension system",
        "TUI architecture",
        "Decoupling pattern",
        "Contributing",
        "Community"
      ],
      "tags": [],
      "wordCount": 354
    },
    {
      "id": "extensions/capabilities",
      "url": "https://go-kit.dev/extensions/capabilities",
      "title": "Capabilities",
      "description": "All extension capabilities — lifecycle events, tools, commands, widgets, and more.",
      "headings": [
        "Lifecycle events",
        "Example",
        "Tools",
        "Commands",
        "Widgets",
        "Headers and footers",
        "Status bar",
        "Shortcuts",
        "Overlays",
        "Tool renderers",
        "Message renderers",
        "Editor interceptors",
        "Interactive prompts",
        "Options",
        "Subagents",
        "Monitoring subagents spawned by the main agent",
        "LLM completion",
        "Themes",
        "Custom events",
        "Session state",
        "When to use which persistence primitive",
        "Bridged SDK APIs",
        "Tree Navigation",
        "Skill Loading",
        "Template Parsing",
        "Model Resolution"
      ],
      "tags": [],
      "wordCount": 2084
    },
    {
      "id": "extensions/examples",
      "url": "https://go-kit.dev/extensions/examples",
      "title": "Examples",
      "description": "Catalog of example extensions included with Kit.",
      "headings": [
        "UI and display",
        "Workflow and automation",
        "Interactive features",
        "Agent and context",
        "Bridged SDK APIs",
        "Themes",
        "Multi-agent",
        "Development",
        "Subdirectory extensions",
        "Project-local example"
      ],
      "tags": [],
      "wordCount": 496
    },
    {
      "id": "extensions/loading",
      "url": "https://go-kit.dev/extensions/loading",
      "title": "Loading Extensions",
      "description": "How Kit discovers and loads extensions.",
      "headings": [
        "Auto-discovery",
        "Explicit loading",
        "Disabling extensions",
        "Installing from git",
        "Extension structure",
        "Single-file extensions",
        "Subdirectory extensions",
        "Package-level state"
      ],
      "tags": [],
      "wordCount": 302
    },
    {
      "id": "extensions/overview",
      "url": "https://go-kit.dev/extensions/overview",
      "title": "Extension System",
      "description": "Overview of Kit's Go-based extension system.",
      "headings": [
        "Minimal extension",
        "How extensions work",
        "Key concepts",
        "The API object",
        "The Context object"
      ],
      "tags": [],
      "wordCount": 303
    },
    {
      "id": "extensions/testing",
      "url": "https://go-kit.dev/extensions/testing",
      "title": "Testing Extensions",
      "description": "Write unit tests for your Kit extensions using the test package.",
      "headings": [
        "Overview",
        "Installation",
        "Basic Usage",
        "Testing an Extension File",
        "Testing Inline Extension Code",
        "Common Testing Patterns",
        "Testing Handler Registration",
        "Testing Tool Registration",
        "Testing Commands",
        "Testing Widgets",
        "Testing Input Handling",
        "Testing Headers and Footers",
        "Testing Status Bar",
        "Testing Print Output",
        "Testing with Prompts",
        "Testing Complete Session Flow",
        "Available Assertions",
        "Event Results",
        "Context Interactions",
        "Registration",
        "Messaging",
        "Helper Functions",
        "Advanced Usage",
        "Accessing the Mock Context",
        "Testing Multiple Extensions",
        "Running Tests",
        "Best Practices",
        "Limitations",
        "Complete Example"
      ],
      "tags": [],
      "wordCount": 1366
    },
    {
      "id": "index",
      "url": "https://go-kit.dev/",
      "title": "Kit",
      "description": "Kit is a powerful, extensible AI coding agent CLI with multi-provider support, built-in tools, and a rich extension system.",
      "headings": [
        "Features",
        "Quick links"
      ],
      "tags": [],
      "wordCount": 240
    },
    {
      "id": "installation",
      "url": "https://go-kit.dev/installation",
      "title": "Installation",
      "description": "Install Kit using npm, bun, pnpm, Go, or build from source.",
      "headings": [
        "Using npm / bun / pnpm",
        "Using Go",
        "Building from source",
        "Verifying the installation",
        "Setting up a provider"
      ],
      "tags": [],
      "wordCount": 131
    },
    {
      "id": "providers",
      "url": "https://go-kit.dev/providers",
      "title": "Providers",
      "description": "Supported LLM providers and model configuration.",
      "headings": [
        "Supported providers",
        "Model string format",
        "Model aliases",
        "Anthropic Claude",
        "OpenAI GPT",
        "Google Gemini",
        "Specifying a model",
        "Authentication",
        "API keys",
        "OAuth",
        "Custom provider URL",
        "Auto-routed providers",
        "Model database"
      ],
      "tags": [],
      "wordCount": 820
    },
    {
      "id": "quick-start",
      "url": "https://go-kit.dev/quick-start",
      "title": "Quick Start",
      "description": "Get up and running with Kit in minutes.",
      "headings": [
        "Basic usage",
        "Non-interactive mode",
        "Resuming sessions",
        "ACP server mode"
      ],
      "tags": [],
      "wordCount": 241
    },
    {
      "id": "sdk/callbacks",
      "url": "https://go-kit.dev/sdk/callbacks",
      "title": "Callbacks",
      "description": "Monitor tool calls and streaming output with the Kit Go SDK.",
      "headings": [
        "Event-based monitoring",
        "Tool call argument streaming",
        "Hook system",
        "BeforeToolCall — block tool execution",
        "AfterToolResult — modify tool output",
        "BeforeTurn — modify prompt, inject messages",
        "AfterTurn — observation only",
        "PrepareStep — intercept messages between steps",
        "Hook priorities",
        "All event types",
        "Subagent event monitoring"
      ],
      "tags": [],
      "wordCount": 958
    },
    {
      "id": "sdk/options",
      "url": "https://go-kit.dev/sdk/options",
      "title": "SDK Options",
      "description": "Configuration options for the Kit Go SDK.",
      "headings": [
        "Full options reference",
        "Options fields",
        "Core",
        "Generation parameters",
        "Provider configuration",
        "Session",
        "Tools & extensions",
        "Skills & configuration",
        "Compaction & MCP",
        "MCP OAuth Authorization",
        "MCP Tasks",
        "Per-server mode",
        "Progress callbacks",
        "Inspecting and cancelling tasks",
        "Precedence",
        "Tool configuration"
      ],
      "tags": [],
      "wordCount": 2292
    },
    {
      "id": "sdk/overview",
      "url": "https://go-kit.dev/sdk/overview",
      "title": "Go SDK",
      "description": "Embed Kit in your Go applications.",
      "headings": [
        "Installation",
        "Basic usage",
        "Functional options (NewAgent)",
        "When to use which",
        "Per-instance config isolation",
        "Multi-turn conversations",
        "Additional prompt methods",
        "Custom tools",
        "Generation & provider overrides",
        "Event system",
        "Model management",
        "Dynamic MCP servers",
        "In-process MCP servers",
        "Runtime skills and context files",
        "MCP prompts and resources",
        "MCP tasks (long-running tools)",
        "Context and compaction",
        "In-process subagents"
      ],
      "tags": [],
      "wordCount": 1518
    },
    {
      "id": "sdk/sessions",
      "url": "https://go-kit.dev/sdk/sessions",
      "title": "SDK Sessions",
      "description": "Session management in the Kit Go SDK.",
      "headings": [
        "Automatic persistence",
        "Accessing session info",
        "Configuring sessions via Options",
        "Clearing history",
        "Tree-based sessions",
        "Listing and managing sessions",
        "Custom session manager"
      ],
      "tags": [],
      "wordCount": 322
    },
    {
      "id": "sessions",
      "url": "https://go-kit.dev/sessions",
      "title": "Session Management",
      "description": "How Kit persists and manages conversation sessions.",
      "headings": [
        "Session storage",
        "Compaction",
        "Auto-cleanup",
        "Resuming sessions",
        "Continue most recent",
        "Interactive picker",
        "Open a specific session",
        "Session commands",
        "Ephemeral mode",
        "Sharing sessions",
        "Preferences persistence"
      ],
      "tags": [],
      "wordCount": 608
    },
    {
      "id": "themes",
      "url": "https://go-kit.dev/themes",
      "title": "Themes",
      "description": "Customize Kit's appearance with built-in themes, custom theme files, and the extension theme API.",
      "headings": [
        "Quick start",
        "Built-in themes",
        "Custom theme files",
        "Theme file format",
        "Partial themes",
        "Distributing themes",
        "Config file theme",
        "Extension theme API",
        "Registering a theme",
        "Switching themes",
        "Listing available themes",
        "ThemeColorConfig fields",
        "Precedence order",
        "Startup theme resolution"
      ],
      "tags": [],
      "wordCount": 1031
    }
  ]
}