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.1-pro-preview',
                'apiKey' => 'YOUR_API_KEY'
            ]
        ]
    ]
];

Step 3: Choose Your Workflow

Kirby Copilot offers four ways to generate content. Mix and match them as needed.

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

buttons:
  - copilot # Choose position
  - open # `buttons` replaces Kirby's
  - preview # defaults, so list them all
  - "-"
  - settings
  - languages
  - status

text:
  type: writer
  marks:
    # Removes every other mark – see the guide
    - copilot
    - copilot-suggestions

text:
  type: textarea
  buttons:
    # Removes every other button – see the guide
    - 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 buy page and purchase a license. The easiest way to activate your license is to go to the system view in the Kirby Panel and click on Activate now:

Enter the email you used for the purchase and your license key, then hit the submit button. You will find your license key in your order confirmation email or at hub.kirby.tools. Done! Thanks for supporting our work. Once you activate your license, the license activation buttons will disappear.