---
title: "Introduction"
description: "AI-powered content generation and text editing for the Kirby Panel – plus a public PHP API for CLI scripts, hooks, and custom workflows."
canonical_url: "https://kirby.tools/docs/copilot/getting-started"
---

# Introduction

> AI-powered content generation and text editing for the Kirby Panel – plus a public PHP API for CLI scripts, hooks, and custom workflows.

Kirby Copilot is a plugin for [Kirby CMS](https://getkirby.com) that brings AI assistance into the Panel without forcing a workflow. Pick the surfaces that fit your blueprints – view button, toolbar, inline suggestions, section – or skip them entirely and call the same provider stack from PHP.

<tip>

Explore the [interactive playground](https://try.kirbycopilot.com) or [install the plugin](/docs/copilot/getting-started/installation) to try Kirby Copilot for yourself.

</tip>

## Features

Whether you are building sites for clients or managing content yourself, Kirby Copilot brings AI-assisted creation and editing to the Panel.

- 🦙 **Multi-Provider**: OpenAI, Anthropic, Google, or Mistral – switch anytime.
- 🧱 **Structure-Aware Generation**: Entire layouts from a single prompt, using your project's blocks.
- ⚡ **Inline Suggestions**: Ghost text after a brief pause – Tab to accept.
- 📇 **In-Context Editing**: Refine writer/textarea text, with selection awareness.
- 🌞 **Prompt Templates**: Save and reuse frequently-used prompts.
- 🎀 **Rich Context**: Other fields, images, and PDFs feed the AI.
- 🔒 **Secure by Default**: API keys stay server-side, never exposed to Panel users.
- 🛠 **PHP API**: Drive AI from CLI, hooks, and custom workflows – see [PHP classes](/docs/copilot/php-classes).

### Supported AI Providers

<card-group>
<card icon="i-simple-icons-openai" title="OpenAI" to="https://developers.openai.com/api/docs/models">

The latest GPT-5 family models for content generation.

</card>

<card icon="i-simple-icons-google" title="Google" to="https://ai.google.dev/gemini-api/docs/models">

Gemini models. Recommended for blocks and layout generation. Free tier available!

</card>

<card icon="i-simple-icons-anthropic" title="Anthropic" to="https://platform.claude.com/docs/en/about-claude/models/overview">

Claude models for nuanced content generation.

</card>

<card icon="i-simple-icons-mistralai" title="Mistral" to="https://docs.mistral.ai/models/overview">

European AI models with multilingual strengths.

</card>
</card-group>

## Choose Your Workflow

Kirby Copilot offers four ways to bring AI into the Panel. Mix and match based on your blueprints.

<table>
<thead>
  <tr>
    <th>
      Workflow
    </th>
    
    <th>
      When to Use
    </th>
    
    <th>
      Field Types
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <a href="/docs/copilot/usage/view-button">
        <icon name="i-ri-layout-top-line">
          
        </icon>
        
         View Button
      </a>
    </td>
    
    <td>
      Generate multiple fields at once, or one field with full-page context
    </td>
    
    <td>
      Any
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/docs/copilot/usage/toolbar-buttons">
        <icon name="i-ri-edit-line">
          
        </icon>
        
         Toolbar Buttons
      </a>
    </td>
    
    <td>
      In-field editing with selection awareness – append or replace
    </td>
    
    <td>
      <code>
        writer
      </code>
      
      , <code>
        textarea
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/docs/copilot/usage/inline-suggestions">
        <icon name="i-ri-magic-line">
          
        </icon>
        
         Inline Suggestions
      </a>
    </td>
    
    <td>
      Passive ghost-text completions while typing – Tab to accept
    </td>
    
    <td>
      <code>
        writer
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/docs/copilot/usage/section">
        <icon name="i-ri-dashboard-line">
          
        </icon>
        
         Copilot Section
      </a>
    </td>
    
    <td>
      Dedicated section UI for single-field generation
    </td>
    
    <td>
      Blueprint section
    </td>
  </tr>
</tbody>
</table>

New to Copilot? Add the **View Button** to a blueprint first – it's the broadest workflow and works with any field.

## View Button

With the `copilot` 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**, but it works equally well for single fields.

Open the dialog, select the fields you want to generate content for, and let your AI assistant handle the rest.

<prose-video height="540" poster="/screencasts/kirby-copilot-multi-fields-generation-poster.jpg" src="/screencasts/kirby-copilot-multi-fields-generation.mp4" width="908">



</prose-video>

<callout color="info" icon="i-ri-information-line" to="/docs/copilot/usage/view-button">

Learn more about this workflow in the **View Button** documentation.

</callout>

## Writer and Textarea Fields

Kirby Copilot integrates directly into `writer` and `textarea` fields with two complementary features:

**Inline Suggestions** appear as ghost text after a brief pause in typing – press `Tab` to accept or keep typing to dismiss. This feature is enabled by default for all writer fields.

**Toolbar Buttons** open the prompt dialog for more control. Select text before clicking to use it as context, then choose to replace or append the generated content.

<prose-video height="540" poster="/screencasts/kirby-copilot-writer-features-poster.jpg" src="/screencasts/kirby-copilot-writer-features.mp4" width="908">



</prose-video>

<callout color="info" icon="i-ri-information-line" to="/docs/copilot/usage/toolbar-buttons">

Learn more in the **Toolbar Buttons** and **Inline Suggestions** documentation.

</callout>

## Blocks & Layout Generation

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.

<tip>

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

</tip>

<prose-video height="540" poster="/screencasts/kirby-copilot-generate-layouts-poster.jpg" src="/screencasts/kirby-copilot-generate-layouts.mp4" width="908">



</prose-video>

<callout color="info" icon="i-ri-information-line" to="/docs/copilot/advanced/blocks-and-layouts">

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

</callout>

## Playground

Experience Kirby Copilot firsthand in the [interactive playground](https://try.kirbycopilot.com). Bring your own provider API key – the playground runs client-side, so you can see your key in action transparently. Production installs route through a server-side proxy and never expose keys to Panel users.

---

Every page of this site as Markdown: <https://kirby.tools/sitemap.md>