Kirby Copilot
v2.0.0Try
Getting Started

Introduction

AI-assisted content tooling without leaving your Kirby CMS Panel.

Kirby Copilot is a plugin for Kirby CMS that integrates AI capabilities into your Kirby projects, allowing you to generate content 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

To streamline content creation for you or your clients and editors, Kirby Copilot offers:

  • 🦙 Multi-model: Use OpenAI GPT, Anthropic Claude, or Mistral AI models to generate content.
  • 🧱 Blocks support: Generate content for blocks fields.
  • 📇 Text Selection: Prompt with selected text in a writer or textarea field.
  • 🌞 Customizable prompts: Tailor AI responses with user and system instructions.
  • 🎀 Context-aware responses: Include context from other fields with placeholders in user prompts to improve content relevance.
Kirby Copilot is multi-modal and supports OpenAI models such as GPT-4o, Anthropic Claude, and Mistral models. We will add support for other AI providers if there is enough demand.

Blocks Generation

One of the key features of Kirby Copilot is the ability to generate content for block fields. This feature is especially useful when creating content for complex layouts such as landing pages, product pages, or blog posts.

Kirby Copilot blocks generation

Writer & Textarea Toolbar Button

Open the prompt dialog by clicking the Copilot button in the toolbar. It allows you to work with content in a writer or textarea field. The selected text (if any) will be added to any prompt you write.

This feature is useful when you need to generate content based on existing text, or when you want to generate content for a specific part of the text. It is also useful for nested fields such as writer fields in blocks.

Kirby Copilot writer toolbar marks

Playground

Experience Kirby Copilot firsthand in the interactive playground.

To play with the plugin section, please enter your OpenAI API key in the playground settings field. If you don't have an API key yet, you can register for the OpenAI API. The key is required to make client-side requests to the OpenAI API. For production use of the plugin, you will have to store the API key in Kirby's global configuration.

The key will be saved to the session storage of your browser. It will not be stored server-side or in any other way.

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.