Getting Started

Introduction

Let AI help you generate content from within the 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 to try Kirby Copilot for yourself.

Kirby Copilot panel plugin

Features

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

  • 🦙 Multi-model: Use OpenAI GPT models or Mistral AI models to generate content.
  • 🧱 Blocks support: Generate content for blocks fields.
  • 🌞 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.
  • 🛎️ Playground: Try out the plugin's features with an interactive live demo.
Kirby Copilot is multi-modal and supports OpenAI models such as GPT-4o and Mistral models. We will add support for other AI providers if there is enough demand.

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.