Kirby Copilot is a plugin for Kirby CMS that integrates AI features into your Kirby projects, letting you generate structured content and entire page layouts directly from the Panel. This documentation guides you through the installation, configuration, and usage of the plugin.
Kirby Copilot offers AI-assisted content creation and editing. These features make the process easy for you, your clients, and your editors.
Kirby Copilot offers three ways to generate content. Choose the one that fits your use case:
| Method | Best For | Key Features |
|---|---|---|
| Panel View Button | Multi-field generation, quick access | Generate all fields at once from any Panel view |
| Toolbar Buttons | In-field editing (writer and textarea fields) | Use selected text as context, inline generation |
| Copilot Section | Dedicated workflows | Persistent prompts, admin control, file pages |
The Panel view button is the easiest way to get started – just add it to your blueprint and generate content for multiple fields with a single prompt.
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.
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.
The Kirby Copilot plugin provides two toolbar buttons:
writer fields, to generate rich text content.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.
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.
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.