README

Kirby Copilot

Kirby Copilot is a plugin for Kirby CMS that integrates AI features into your Kirby projects, letting you generate and refine content – from simple text to complex page layouts – directly from the Panel. This documentation guides you through the installation, configuration, and usage of the plugin.

Tip

Explore the interactive playground or install the plugin to try Kirby Copilot for yourself.

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: Choose from leading AI providers – configure once and switch anytime.
🧱 Structure-Aware Generation: Generate entire layouts from a single prompt, based on your project's unique block definitions.
⚡ Inline Suggestions: Ghost text appears after a brief pause. Press Tab to accept.
📇 In-Context Editing: Use the Copilot button in writer/textarea fields to refine text. Works perfectly with selected text.
🌞 Prompt Templates: Tailor AI responses with user instructions. Save frequently used prompts as templates.
🎀 Rich Context: Use other fields, images, and PDF documents as context for relevant AI responses.
🔒 Secure by Default: API keys are protected via server-side proxy – never exposed to Panel users.

Licensing

Kirby Copilot is a commercial plugin that requires a license. You can install and test the plugin locally without a license. However, production environments require a valid license. You can purchase a license from the Kirby Copilot Website.

Getting Started

To get started, please refer to the documentation for guidance on installation, configuration, and usage.

Here are some quick links:

Support and Questions

We are committed to support you if you have any questions or issues with Kirby Copilot. There are several ways to get support:

GitHub Discussions: Join the community and engage in discussions on our GitHub Discussions page.
Email Support: You can ask questions and seek assistance by emailing us at hello@kirby.tools. Please use the GitHub discussions if you have a general question or comment about Kirby Content Translator.
GitHub Issues: For reporting bugs or requesting new features, please use the GitHub Issues page.

We encourage you to use the resources above to connect with us and other users of Kirby Copilot.

For the sake of reproducible bug reports, please include the following information in your bug reports:

Kirby & Kirby Copilot version
Browser environment (name, version, operating system)
Global and section configuration (without any sensitive information)
Steps to reproduce the bug (if no reproduction is provided)
Screenshots or screen recordings if applicable

Warning

Please ensure to never include any API keys or other sensitive information in bug reports, feature requests, or any other public communication channel.

Feedback

We value your feedback and ideas for improving Kirby Copilot. If you have any suggestions, please feel free to reach out to us via email or preferably by creating a new discussion on our GitHub Discussions page.

johannschopplich / kirby-copilot

Maintainers

Details