# Kirby Tools

> Plugins for Kirby CMS: AI content generation, translation, SEO auditing, live preview, Panel navigation, and a headless API toolkit.

## Documentation Sets

- [Kirby Tools Full Documentation](https://kirby.tools/llms-full.txt): Every documentation page for all 6 plugins, concatenated as Markdown.

## Kirby Copilot

AI-powered content generation. Composer package `johannschopplich/kirby-copilot`, options under `johannschopplich.copilot` in `config.php`. Commercial plugin – free to run locally, licensed for production. Not for: Translating existing content between languages – use Kirby Content Translator for that.

- [Introduction](https://kirby.tools/docs/copilot/getting-started.md): AI-powered content generation and text editing for the Kirby Panel – plus a public PHP API for CLI scripts, hooks, and custom workflows.
- [Installation](https://kirby.tools/docs/copilot/getting-started/installation.md): Set up your AI provider, choose from four workflows, and activate your license – up and running in minutes.
- [Global Configuration](https://kirby.tools/docs/copilot/configuration/global.md): Set up AI providers, API keys, and project-wide defaults in your config.php – applies across every Panel view and section.
- [View Button & Field Configuration](https://kirby.tools/docs/copilot/configuration/local.md): Per-blueprint controls for the view button and writer/textarea toolbar – set defaults, lock prompts, scope to specific fields.
- [System Prompt](https://kirby.tools/docs/copilot/configuration/system-prompt.md): Ships with a default that adapts to the target field, current selection, and attached files – override it globally or per blueprint.
- [View Button](https://kirby.tools/docs/copilot/usage/view-button.md): Generate content for multiple fields at once from a dedicated prompt dialog, with field targeting and response streaming.
- [Toolbar Buttons](https://kirby.tools/docs/copilot/usage/toolbar-buttons.md): Select text in writer or textarea fields and use AI to fix grammar, summarize, rewrite, or extend – right from the toolbar.
- [Inline Suggestions](https://kirby.tools/docs/copilot/usage/inline-suggestions.md): Ghost text appears as you type in writer fields – press Tab to accept, Escape to dismiss, or just keep typing to ignore.
- [Copilot Section](https://kirby.tools/docs/copilot/usage/section.md): Single-field generation with locked prompts and auto file context – ideal for image alt text, captions, and editorial workflows.
- [Field Placeholders](https://kirby.tools/docs/copilot/prompt-dialog/placeholders.md): Reference Kirby fields in user prompts with `{field}` placeholders – at submit time each one resolves to the field's actual value.
- [Prompt Templates](https://kirby.tools/docs/copilot/prompt-dialog/templates.md): Ships with five built-in templates like Fix Grammar and Summarize. Create custom templates or define team-wide presets via config.
- [File Attachments](https://kirby.tools/docs/copilot/prompt-dialog/files.md): Enrich prompts with visual and document context, including automatic image resizing and a text-extraction fallback for large PDFs.
- [Page References](https://kirby.tools/docs/copilot/prompt-dialog/page-references.md): Pull a sibling page's title and content into the prompt with an @page:// mention – the AI sees structured cross-page context.
- [Skills](https://kirby.tools/docs/copilot/prompt-dialog/skills.md): Codify your team's voice and house rules once – editors invoke them with @skill:// mentions to layer instructions onto any prompt.
- [Overview](https://kirby.tools/docs/copilot/php-classes.md): Drive Copilot from PHP – the same providers and credentials as the Panel, available to CLI commands, hooks, and custom workflows.
- [Client](https://kirby.tools/docs/copilot/php-classes/client.md): Generate text or structured JSON from any PHP context with one method call – CLI commands, hooks, custom controllers.
- [Overview](https://kirby.tools/docs/copilot/php-classes/providers.md): Switch between OpenAI, Anthropic, Gemini, or Mistral – or plug in your own provider – without changing your call sites.
- [OpenAIProvider](https://kirby.tools/docs/copilot/php-classes/providers/openai.md): Use OpenAI directly, or any OpenAI-compatible endpoint like OpenRouter, Ollama, or Cloudflare AI Gateway via a custom base URL.
- [AnthropicProvider](https://kirby.tools/docs/copilot/php-classes/providers/anthropic.md): Use Anthropic Claude with native API support – structured output is guaranteed, never falling back to free-form prose.
- [GeminiProvider](https://kirby.tools/docs/copilot/php-classes/providers/gemini.md): Recommended for blocks and layouts – Gemini handles deeply nested JSON schemas more reliably than other providers.
- [MistralProvider](https://kirby.tools/docs/copilot/php-classes/providers/mistral.md): European AI models for prose generation – structured output coverage is uneven, so prefer Gemini for blocks and layouts.
- [Exceptions](https://kirby.tools/docs/copilot/php-classes/exceptions.md): Catch upstream provider failures, missing API keys, and configuration errors with three typed exceptions.
- [Blocks & Layouts](https://kirby.tools/docs/copilot/advanced/blocks-and-layouts.md): Turn Copilot into a page builder – generate structured content for built-in and custom blocks with schema-aware AI and real-time streaming.
- [Quick Reference](https://kirby.tools/docs/copilot/advanced/reference.md): Keyboard shortcuts, properties, and supported field types at a glance.
- [Troubleshooting](https://kirby.tools/docs/copilot/advanced/troubleshooting.md): Fix generation timeouts, API key errors, malformed blocks output, and missing inline suggestions in local and production setups.

## Kirby Content Translator

Content translation in the Panel or via CLI. Composer package `johannschopplich/kirby-content-translator`, options under `johannschopplich.content-translator` in `config.php`. Commercial plugin – free to run locally, licensed for production. Not for: Generating new content from a prompt – use Kirby Copilot for that.

- [Introduction](https://kirby.tools/docs/content-translator/getting-started.md): One-click translation in the Kirby Panel – DeepL, AI providers via Kirby Copilot, or your own backend.
- [Installation](https://kirby.tools/docs/content-translator/getting-started/installation.md): Set up DeepL or AI-powered translation, choose your Panel workflow, and start translating content in minutes.
- [Migration](https://kirby.tools/docs/content-translator/getting-started/migration.md): Upgrade notes for breaking and notable changes – strategy interface, view-button defaults, HTML tag handling.
- [Global Configuration](https://kirby.tools/docs/content-translator/configuration/global.md): Set the translation backend, credentials, and project-wide defaults in config.php – applies to every view button and section.
- [View Button & Section Configuration](https://kirby.tools/docs/content-translator/configuration/local.md): Per-blueprint controls for the view button and section – override defaults, scope translatable fields, customize labels.
- [DeepL](https://kirby.tools/docs/content-translator/providers/deepl.md): Translate via DeepL with native API support – tunable request options, language-code overrides, and a free tier.
- [AI Translation](https://kirby.tools/docs/content-translator/providers/ai-translation.md): Combine Content Translator with Kirby Copilot for AI-powered translations using models from OpenAI, Google, Anthropic, or Mistral.
- [Custom Translator](https://kirby.tools/docs/content-translator/providers/custom-translator.md): Plug in any translation API or local logic – via a closure, a CallableStrategy, or your own Strategy implementation.
- [Translation Coverage](https://kirby.tools/docs/content-translator/panel/translation-coverage.md): Per-language completion rings and a focused tree of pages still missing translations – Kirby 5 only.
- [Overview](https://kirby.tools/docs/content-translator/php-classes.md): Translate Kirby pages, files, and site content from PHP – the same pipeline the Panel uses, exposed as a public API.
- [Translator](https://kirby.tools/docs/content-translator/php-classes/translator.md): Translate any page, file, or site model in place from PHP – with static helpers when you only have raw strings.
- [Overview](https://kirby.tools/docs/content-translator/php-classes/strategies.md): Pluggable translation backends – pick DeepL, Copilot AI, or a callable, or implement your own to route through any service.
- [DeepLStrategy](https://kirby.tools/docs/content-translator/php-classes/strategies/deepl-strategy.md): Translate via DeepL with automatic batching and retries – the default strategy when nothing else is configured.
- [CopilotAIStrategy](https://kirby.tools/docs/content-translator/php-classes/strategies/copilot-ai-strategy.md): Context-aware AI translation through any Copilot provider – batched, validated, and resilient to malformed model responses.
- [CallableStrategy](https://kirby.tools/docs/content-translator/php-classes/strategies/callable-strategy.md): Wrap a closure as a translation backend – the simplest extension point and the migration path off the old translateFn option.
- [Exceptions](https://kirby.tools/docs/content-translator/php-classes/exceptions.md): Which failures raise which exception – a dead provider, a misconfigured strategy, a missing key, a language the site never registered.
- [DeepL Client](https://kirby.tools/docs/content-translator/php-classes/deepl-client.md): Talk to the DeepL API directly from PHP – override language mapping, tune request options, or mock the client in tests.
- [KirbyTags](https://kirby.tools/docs/content-translator/advanced/kirbytags.md): Translate selected KirbyTag attributes while preserving structure – tag types and attribute lists are configurable.
- [Hooks](https://kirby.tools/docs/content-translator/advanced/hooks.md): Preprocess, postprocess, or skip content with before/after hooks. Surface dropped translations with the warning hook.
- [Single Page](https://kirby.tools/docs/content-translator/cli-automation/single-page.md): Copy and translate a single page’s content to any target language from the command line, without opening the Panel.
- [Batch Pages](https://kirby.tools/docs/content-translator/cli-automation/batch-pages.md): Translate all children of a page or every page on the site recursively – ideal for large multilingual launches.
- [File Metadata](https://kirby.tools/docs/content-translator/cli-automation/file-metadata.md): Translate alt text, captions, and other file metadata for every file under a page – straight from the command line.
- [Janitor Integration](https://kirby.tools/docs/content-translator/cli-automation/janitor.md): Wrap a CLI translation command in a Janitor button so editors can trigger it from the Panel without shell access.
- [AI Strategy Override](https://kirby.tools/docs/content-translator/cli-automation/ai-strategy.md): Force AI translation for a single CLI run without changing global config.

## Kirby SEO Audit

State-of-the-art SEO analysis. Composer package `johannschopplich/kirby-seo-audit`, options under `johannschopplich.seo-audit` in `config.php`. Commercial plugin – free to run locally, licensed for production. Not for: Rendering meta tags in the frontend – it audits the output, it does not produce it.

- [Introduction](https://kirby.tools/docs/seo-audit/getting-started.md): Run Yoast SEO v3 assessments on your Kirby content directly in the Panel – 28 checks for keyphrase, readability, and technical SEO.
- [Installation](https://kirby.tools/docs/seo-audit/getting-started/installation.md): Add in-Panel SEO analysis with a view button or section, configure keyphrase fields, and run your first audit in minutes.
- [Global Configuration](https://kirby.tools/docs/seo-audit/configuration/global.md): Configure the proxy used to fetch pages for analysis – essential for Docker, basic-auth-protected staging, and other restricted setups.
- [View Button & Section Configuration](https://kirby.tools/docs/seo-audit/configuration/local.md): Control keyphrase sourcing, synonym fields, and assessment filtering per blueprint.
- [Assessments for SEO and Readability](https://kirby.tools/docs/seo-audit/guide/assessments.md): All 28 SEO and readability assessments from Yoast SEO v3, with three custom Kirby additions.
- [Audit URL](https://kirby.tools/docs/seo-audit/guide/audit-url.md): Defaults to the page's preview URL so even drafts get checked – override per blueprint when you need a custom target.

## Kirby Live Preview

Real-time page preview. Composer package `johannschopplich/kirby-live-preview`, configured through blueprints rather than `config.php`. Commercial plugin – free to run locally, licensed for production. Not for: Previewing a decoupled frontend that renders outside Kirby – it previews Kirby-rendered pages.

- [Getting Started](https://kirby.tools/docs/live-preview.md): See real-time content changes in a Panel iframe, navigate between pages without leaving the editor, and customize the preview layout.
- [Configuration](https://kirby.tools/docs/live-preview/configuration.md): Every blueprint property for the Live Preview section – sticky pinning, label, dimensions, and update behavior.
- [Preview Mode](https://kirby.tools/docs/live-preview/preview-mode.md): Hide cookie banners, disable animations, and toggle other live-only logic by detecting preview mode in PHP, CSS, and JavaScript.
- [Troubleshooting](https://kirby.tools/docs/live-preview/troubleshooting.md): Fix the Safari iframe sandbox error caused by frame-ancestors and other common preview rendering issues.

## Kirby Minimap

Sidebar content navigation. Composer package `johannschopplich/kirby-minimap`, configured through blueprints rather than `config.php`. Free and open source. Not for: Frontend navigation – it is a Panel-only aid.

- [Getting Started](https://kirby.tools/docs/minimap.md): Zero-config sidebar navigation for the Kirby Panel – jump between fields and blocks in complex blueprints with a single click.
- [Fields Support](https://kirby.tools/docs/minimap/fields-support.md): See which field types are visualized in the minimap and how blocks, tabs, and nested structures appear in the sidebar.

## Kirby Headless

API-first CMS toolkit. Composer package `johannschopplich/kirby-headless`, options under `headless` in `config.php`. Free and open source. Not for: Building the frontend itself – it exposes the content, you bring the client.

- [Introduction](https://kirby.tools/docs/headless/getting-started.md): Use Kirby as a backend for frontend apps, static site generators, or mobile apps – bearer token auth, KQL enhancements, and JSON templates included.
- [Installation](https://kirby.tools/docs/headless/getting-started/installation.md): Drop-in installation with zero-config defaults – adds a KQL endpoint without affecting existing routes.
- [Authentication](https://kirby.tools/docs/headless/configuration/authentication.md): Lock the headless KQL endpoint and global routes behind a bearer token, or fall back to Kirby's native API authentication.
- [CORS](https://kirby.tools/docs/headless/configuration/cors.md): Set up cross-origin access for public APIs or authenticated frontends with support for multiple origins and dynamic closures.
- [Panel Configuration](https://kirby.tools/docs/headless/configuration/panel.md): Where the Panel's preview button sends an editor, and what a browser gets when it opens the backend URL directly.
- [KQL (Kirby Query Language)](https://kirby.tools/docs/headless/usage/kql.md): Extends the official KQL plugin – swaps basic auth for bearer tokens, caches queries, and runs them in the language the request names.
- [JSON Templates](https://kirby.tools/docs/headless/usage/json-templates.md): Return JSON from Kirby templates for full control over your API responses.
- [Field Methods](https://kirby.tools/docs/headless/usage/field-methods.md): Resolve UUIDs in blocks, layouts, and permalinks server-side – frontends consume ready-to-use URLs and IDs.
- [Page Methods](https://kirby.tools/docs/headless/usage/page-methods.md): Get frontend URLs, breadcrumb data, and multi-language metadata for navigation and language switchers in headless frontends.
- [API Builder](https://kirby.tools/docs/headless/advanced/api-builder.md): Compose routes from middleware chains – built-ins for bearer auth, file/page resolution, plus your own validators.
- [Version Migration](https://kirby.tools/docs/headless/migration.md): Upgrade from v3 to v8 with before/after examples for global route authentication, CORS config changes, and resolved blocks structure updates.

## Blog

Release announcements and background articles.

- [Kirby Copilot v2.5 – Beyond Single Fields](https://kirby.tools/blog/copilot-v25.md): Multi-field generation and custom blocks support turn Copilot into a proper content generation tool for the Kirby Panel.
- [Kirby Copilot v3 – Your Quiet Co-Writer](https://kirby.tools/blog/copilot-v3.md): A major update with server-side API proxy, inline suggestions, prompt templates, and more. Free upgrade for all users.
- [Docs Your Agent Can Read](https://kirby.tools/blog/docs-for-agents.md): Every page here has a Markdown twin, llms.txt indexes them, and each plugin ships an agent skill you can install in one command.
- [Going Open Source with Commercial Plugins](https://kirby.tools/blog/going-open-source.md): How and why Kirby Tools plugins moved from a private Composer repo to Packagist and open source.
- [Know What's Left to Translate](https://kirby.tools/blog/know-what-is-left-to-translate.md): Translation Coverage shows which languages and pages still need attention across your multilingual Kirby site.
- [Moving to Paddle](https://kirby.tools/blog/paddle-migration.md): Kirby Tools is switching from Lemon Squeezy to Paddle for payment processing. Existing licenses are unaffected.
- [Stop Repeating Yourself](https://kirby.tools/blog/stop-repeating-yourself.md): Skills let you save the tone and rules you'd otherwise retype, then drop them into any prompt with a single mention.

## Licensing

The license agreement, the Zero One Edition it differs from, and which plugin generation runs on which Kirby version.

- [License & Plugin Compatibility](https://kirby.tools/license-compatibility.md): Gen 1, Gen 2 & Gen 3 licenses, the Kirby 4–6 version matrix, and how to manage your license keys.
- [Kirby Tools Plugin License Agreement](https://kirby.tools/license.md): License Agreement for proprietary Kirby Tools plugins.
- [Kirby Tools Plugin License Agreement – Zero One Edition](https://kirby.tools/license/zero-one-edition.md): License Agreement for proprietary Kirby Tools plugins distributed as the "Zero One Edition" alongside the "Zero One" Kirby CMS Theme.

## Notes

- These plugins install via Composer or as a ZIP into `site/plugins/` and are configured in `site/config/config.php` under their `johannschopplich.*` option key.
- Commercial plugins run unlicensed in local development. Production needs a license key, activated in the Panel's system view and stored in `site/config/.kirby-tools-licenses`. Each plugin is licensed separately.
- Append `.md` to any documentation or blog URL to retrieve its Markdown source, for example `https://kirby.tools/docs/copilot/getting-started.md`.
- Changelogs, newest release first: Kirby Copilot https://kirby.tools/copilot/changelog.md, Kirby Content Translator https://kirby.tools/content-translator/changelog.md, Kirby SEO Audit https://kirby.tools/seo-audit/changelog.md, Kirby Live Preview https://kirby.tools/live-preview/changelog.md.
- Releases for the remaining plugins live on GitHub: Kirby Minimap https://github.com/johannschopplich/kirby-minimap/releases, Kirby Headless https://github.com/johannschopplich/kirby-headless/releases.
- An agent skill per plugin – install with `npx skills add https://kirby.tools`, or read the index at https://kirby.tools/.well-known/agent-skills/index.json.
- Every entry point above is documented at https://kirby.tools/ai.md.
- Retrieval keywords: kirby ai, kirby content generation, kirby panel ai, kirby writer field ai, kirby blocks generation, kirby translation, kirby multilanguage, kirby deepl, kirby translate panel, kirby cli translation, kirby seo, kirby meta tags, kirby seo analysis, kirby readability, kirby panel seo, kirby live preview, kirby panel preview, kirby instant preview, kirby preview iframe, kirby panel navigation, kirby sidebar, kirby content overview, kirby minimap, kirby headless, kirby api, kirby kql, kirby json, kirby decoupled frontend.