Kirby Tools
v2.6.0Hub

Introduction

Structure-aware AI content generation for the Kirby Panel.

Kirby Copilot is a plugin for Kirby CMS that integrates AI features into your Kirby projects, allowing you to generate structured content and entire page layouts directly from the Panel. This documentation will guide you through the installation, configuration and usage of the plugin.

Explore the interactive playground or install the plugin to try Kirby Copilot for yourself.

Features

Kirby Copilot offers a variety of features for AI-assisted content creation and editing. These features make the process easy for you, your clients, and your editors.

  • 🦙 Multi-model: Use OpenAI models, Google Gemini, Anthropic Claude, or Mistral AI models to generate content.
  • 🧱 Structure-Aware Generation: Generate entire layouts from a single prompt, based on your project's unique block definitions.
  • 📇 In-Context Editing: Use the Copilot button in writer/textarea fields to refine text with AI assistance. Works perfectly with selected text.
  • 🌞 Customizable prompts: Tailor AI responses with user and system instructions.
  • 🎀 Rich Context: Go beyond text. Use other fields, images, and even PDF documents as context for more accurate and relevant AI responses.
Kirby Copilot supports multiple AI providers including OpenAI models, Google Gemini, Anthropic Claude, and Mistral models. We will add support for other AI providers if there is enough demand.

Panel View Button since v2.5.0

With the copilot Panel view button, you can access the prompt dialog from anywhere in the Panel. It is especially useful for generating content for multiple fields at once, such as when creating a new page or editing an existing one.

Open the dialog, select the fields you want to generate content for, and let Kirby Copilot do the rest.

Learn more about this feature in the Panel View Button documentation.

Blocks & Layout Generation since v2.4.0

One of Kirby Copilot's key features is its ability to generate content for blocks and layout fields. This feature is especially useful for creating content for complex layouts such as landing pages, product pages, and blog posts.

Copilot reads your project's block definitions and generates content based on their structure. No additional configuration is required.

Learn more about this feature in the Blocks & Layout Generation documentation.

Writer & Textarea Toolbar Buttons

The Kirby Copilot plugin provides two toolbar buttons:

  • Writer: For writer fields, to generate rich text content.
  • Textarea: For textarea fields, to generate plain text or Markdown content.

Clicking a button opens the prompt dialog where you can enter text to generate content for the field.

Kirby Copilot writer toolbar marks

The toolbar buttons allow you to work with the selected text or the entire field content. If any text is selected, an additional selection menu will appear to choose whether to replace the selected text with the generated content or to append the generated content to the selected text.

Playground

Experience Kirby Copilot firsthand in the interactive playground.

To play with the plugin section, please enter your API key in the playground settings section. The key is required to make client-side requests to the AI provider API. For production use of the plugin, you will have to store the API key in Kirby's global configuration.

Get your API key:

When you are ready to install Kirby Copilot, follow the installation guide.

Installation

Learn how to install and configure the plugin in your Kirby project.