extensions

Kit Extension Examples

A collection of example extensions demonstrating various Kit capabilities. These can be installed individually or as a complete collection.

Installation

Install all examples

kit install github.com/mark3labs/kit/examples/extensions

Install with interactive selection

kit install github.com/mark3labs/kit/examples/extensions --select

Install locally in your project

kit install github.com/mark3labs/kit/examples/extensions --local

Extension Index

Core Concepts

UI & Widgets

Input & Editor

Session & Context

Tools & Commands

Subagents & Background Tasks

Integrations

Themes

Rendering

Extension Details

minimal.go

The bare minimum extension showing the required structure:

• Package main
• Import kit/ext
• Export Init(api ext.API) function

plan-mode.go

A complete example demonstrating:

• Slash command (/plan)
• Keyboard shortcut (ctrl+alt+p)
• Option registration
• Status bar indicators
• System prompt injection
• Tool filtering

widget-status.go

Shows how to create persistent UI elements:

• Create widgets with SetWidget
• Update content dynamically
• Remove when done
• Handle session lifecycle

context-inject.go

Advanced context manipulation:

• Read project files
• Inject into LLM context
• Filter messages
• Use negative indices for ephemeral content

lsp-diagnostics.go

Complex real-world example:

• Multi-file extension
• External process management (LSP server)
• File watching
• Diagnostics aggregation

kit-telegram/

Full-featured Telegram integration:

• Slash command with subcommands and tab completion
• Interactive guided setup flow with prompts
• Background long-polling goroutine
• Progress message rendering edited in place
• Message queue with edit-before-dispatch
• Remote command handling from Telegram
• Status bar and widget updates
• Config persistence with atomic writes

Multi-File Extension Example

The kit-kit-agents/ directory demonstrates the multi-file pattern:

kit-kit-agents/
├── main.go          # Entry point with Init()
├── agent.go         # Agent configuration
├── manager.go       # Agent lifecycle management
└── README.md        # Documentation

When the repo is installed, all files in subdirectories with main.go are loaded as separate extensions.

Testing & Validation

After installing, test the extensions:

# List all loaded extensions
kit extensions list

# Validate all extensions
kit extensions validate

# Run with a specific extension
kit -e ~/.local/share/kit/git/github.com/mark3labs/kit/examples/extensions/plan-mode.go

Creating Your Own

1. Copy minimal.go as a starting point
2. Modify the Init() function to register your handlers
3. Use the other examples for reference on specific APIs
4. Test with kit -e your-extension.go
5. Share by pushing to a git repository!

Update

To get the latest examples:

kit install github.com/mark3labs/kit/examples/extensions --update

See Also

• Kit Extensions Guide
• API Reference
• Example Extensions Source