Files
kit/skill.md
T

3.7 KiB

Kit

Documentation site powered by Tome

Overview

This is the documentation for Kit. It is a static documentation site with full-text search, structured data, and machine-readable formats.

Available Resources

Resource Path Description
llms.txt /llms.txt Lightweight page index with titles, descriptions, and URLs
llms-full.txt /llms-full.txt Full raw markdown content of all pages
MCP manifest /mcp.json Machine-readable page metadata with headings and tags
skill.md /skill.md This file — agent capabilities and site structure
robots.txt /robots.txt Crawler directives with AI agent permissions
Search API /search.json Pagefind search index metadata for programmatic search

Site Structure

Pages

  • JSON Output — Machine-readable JSON output for scripting and automation.
  • Subagents — Multi-agent orchestration with Kit subagents.
  • Testing with tmux — Test Kit's TUI non-interactively using tmux.
  • Commands — Complete reference for all Kit CLI subcommands.
  • Global Flags — Complete reference for all Kit CLI flags.
  • Configuration — Configure Kit using config files, environment variables, and CLI flags.
  • Development — Build, test, and contribute to Kit.
  • Capabilities — All extension capabilities — lifecycle events, tools, commands, widgets, and more.
  • Examples — Catalog of example extensions included with Kit.
  • Loading Extensions — How Kit discovers and loads extensions.
  • Extension System — Overview of Kit's Go-based extension system.
  • Testing Extensions — Write unit tests for your Kit extensions using the test package.
  • Kit — Kit is a powerful, extensible AI coding agent CLI with multi-provider support, built-in tools, and a rich extension system.
  • Installation — Install Kit using npm, bun, pnpm, Go, or build from source.
  • Providers — Supported LLM providers and model configuration.
  • Quick Start — Get up and running with Kit in minutes.
  • Callbacks — Monitor tool calls and streaming output with the Kit Go SDK.
  • SDK Options — Configuration options for the Kit Go SDK.
  • Go SDK — Embed Kit in your Go applications.
  • SDK Sessions — Session management in the Kit Go SDK.
  • Session Management — How Kit persists and manages conversation sessions.
  • Themes — Customize Kit's appearance with built-in themes, custom theme files, and the extension theme API.

How to Use This Site

For AI Agents

  1. Quick overview: Read /llms.txt for a page index with titles and URLs
  2. Full content: Read /llms-full.txt for complete raw markdown of all pages
  3. Structured data: Parse /mcp.json for machine-readable metadata including headings, tags, and content
  4. Search: Use Pagefind search at /pagefind/pagefind.js or check /search.json for index metadata

Capabilities

  • Search provider: local