[![Kirby Copilot](./.github/social-card.png)](https://kirbycopilot.com)

# Kirby Copilot

Kirby Copilot is a plugin for [Kirby CMS](https://getkirby.com) that integrates AI capabilities into your Kirby projects, allowing you to generate content directly from the Panel.

## Features

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

- 🦙 **Multi-model**: Use OpenAI GPT, Anthropic Claude, 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.

## 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](https://kirbycopilot.com/buy).

## Getting Started

To get started, please refer to the [documentation](https://kirbycopilot.com/docs/getting-started) for guidance on installation, configuration, and usage.

Here are some quick links:

- [Installation](https://kirbycopilot.com/docs/getting-started/installation)
- [Global Configuration](https://kirbycopilot.com/docs/configuration/global)
- [Section Configuration](https://kirbycopilot.com/docs/configuration/section)

## 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](https://github.com/kirby-tools/community/discussions).
- **Email Support**: You can ask questions and seek assistance by emailing us at [hello@kirbycopilot.com](mailto:hello@kirbycopilot.com). Please use the GitHub discussions if you have a general question or comment about Kirby Copilot.
- **GitHub Issues**: For reporting bugs or requesting new features, please use the [GitHub Issues page](https://github.com/kirby-tools/community/issues).

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](https://github.com/kirby-tools/community/discussions).

## License

[Kirby Copilot Plugin License Agreement](./LICENSE.md) License © 2024-PRESENT [Johann Schopplich](https://github.com/johannschopplich)
