Installation

Step 1: Install the Plugin

Although it is a commercial plugin, you can download and test it in your local environment before purchasing.

composer require johannschopplich/kirby-copilot

Step 2: AI Provider Configuration

Configure the AI provider by setting the API key in the global Kirby configuration. The AI model is optional – sensible defaults are provided for each provider.

For example, to get started with Google Gemini, create a new Google API key and add it to the configuration:

return [
    'johannschopplich.copilot' => [
        'provider' => 'google',
        'providers' => [
            'google' => [
                'model' => 'gemini-3-pro-preview',
                'apiKey' => 'YOUR_API_KEY'
            ]
        ]
    ]
];

Step 3: Choose Your Workflow

Kirby Copilot offers four ways to generate content. Each method integrates seamlessly into the Panel and can be mixed and matched based on your needs.

If you are unsure where to start, we recommend adding the copilot view button to your blueprint first.

buttons:
  - copilot # Choose position
  - preview
  - settings
  - languages
  - status

text:
  type: writer
  marks:
    - copilot
    - copilot-suggestions

text:
  type: textarea
  buttons:
    - copilot

copilotSection:
  type: copilot
  field: blocks

Step 4: Buy a License

You can test the plugin locally. However, you need to purchase a license to use the plugin in production environments.

Visit the product page on Lemon Squeezy and purchase a license. Then, open any Panel page that contains the Copilot view button or section. You will see a license activation notice. Click the Activate link to open the activation form:

Enter the email you used for the purchase and the order number and hit the submit button. Done! Thanks for supporting our work. Once you activate your license, the license activation buttons will disappear.