Kirby CMS Docs llms.txt · AI Docs Browser · mdream

[llms.txt Tools](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt)

# Kirby CMS Docs llms.txt

Browse Kirby CMS Docs documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools.

getkirby.com/llms.txt

[Raw llms.txt](https://getkirby.com/llms.txt) [Raw llms-full.txt](https://getkirby.com/llms-full.txt)

Copy Markdown [](https://getkirby.com/llms.txt)

llms.txt

Guide

Quickstart

Installation & update

Exploring the Starterkit

About the docs

Migrating to Kirby

Managing content

Managing files

Rendering & logic

Panel

Page builder

Unique IDs & Permalinks

Virtual content

Configuring Kirby

Users & permissions

Multi-language

Login & Sessions

Routes

Caching

Sending emails

Plugins

Using databases

API

Headless & Integrations

Secure your project

Kirby & Privacy

Troubleshooting

Upgrades

Reference

(date: …)

(email: …)

(file: …)

(gist: …)

(image: …)

(link: …)

(tel: …)

(video: …)

Bold text

Line breaks & paragraphs

Code blocks

Email addresses

Headlines

Horizontal rules

Italic text

Links

Lists

Quotes

$field->callback()

$field->escape()

$field->excerpt()

$field->exists()

$field->html()

$field->inline()

$field->isEmpty()

$field->isFalse()

$field->isNotEmpty()

$field->isTrue()

$field->isValid()

$field->key()

$field->kirbytags()

$field->kirbytext()

$field->kirbytextinline()

$field->length()

$field->lower()

$field->markdown()

$field->model()

$field->nl2br()

$field->or()

$field->parent()

$field->permalinksToUrls()

$field->query()

$field->replace()

$field->short()

$field->slug()

$field->smartypants()

$field->split()

$field->toArray()

$field->toBlocks()

$field->toBool()

$field->toData()

$field->toDate()

$field->toEntries()

$field->toFile()

$field->toFiles()

$field->toFloat()

$field->toInt()

$field->toLayouts()

$field->toLink()

$field->toObject()

$field->toPage()

$field->toPages()

$field->toQrCode()

$field->toString()

$field->toStructure()

$field->toTimestamp()

$field->toUrl()

$field->toUser()

$field->toUsers()

$field->upper()

$field->value()

$field->widont()

$field->words()

$field->xml()

$field->yaml()

asset()

attr()

collection()

csrf()

css()

deprecated()

dump()

e()

esc()

get()

gist()

go()

h()

html()

image()

invalid()

js()

kirby()

kirbytag()

kirbytags()

kirbytext()

kirbytextinline()

load()

markdown()

option()

page()

pages()

param()

params()

qr()

r()

router()

site()

size()

smartypants()

snippet()

svg()

t()

tc()

tt()

u()

url()

video()

vimeo()

widont()

youtube()

Block blueprint

File blueprint

Page blueprint

Site blueprint

User blueprint

Blocks

Checkboxes

Color

Date

Email

Entries

Files

Gap

Headline

Hidden

Info

Layout

Line

Link

List

Multiselect

Number

Object

Pages

Radio

Range

Select

Slug

Stats

Structure

Tags

Tel

Text

Textarea

Time

Toggle

Toggles

Url

Users

Writer

Fields section

Files section

Info section

Pages section

Stats section

code

gallery

heading

image

line

list

markdown

quote

table

text

video

Files

Page

Pages

Kirby\Api\Api

Kirby\Api\Collection

Kirby\Api\Model

Kirby\Api\Upload

Kirby\Api\Controller\Changes

Kirby\Cache\ApcuCache

Kirby\Cache\Cache

Kirby\Cache\FileCache

Kirby\Cache\MemCached

Kirby\Cache\MemoryCache

Kirby\Cache\NullCache

Kirby\Cache\RedisCache

Kirby\Cache\Value

Kirby\Cms\Api

Kirby\Cms\AppCaches

Kirby\Cms\AppErrors

Kirby\Cms\App

Kirby\Cms\AppPlugins

Kirby\Cms\AppTranslations

Kirby\Cms\AppUsers

Kirby\Cms\Auth

Kirby\Cms\BlockConverter

Kirby\Cms\Block

Kirby\Cms\Blocks

Kirby\Cms\Blueprint

Kirby\Cms\Collection

Kirby\Cms\Collections

Kirby\Cms\Core

Kirby\Cms\Cors

Kirby\Cms\Email

Kirby\Cms\Event

Kirby\Cms\Events

Kirby\Cms\Fieldset

Kirby\Cms\Fieldsets

Kirby\Cms\FileActions

Kirby\Cms\FileBlueprint

Kirby\Cms\FileModifications

Kirby\Cms\FilePermissions

Kirby\Cms\File

Kirby\Cms\FilePicker

Kirby\Cms\FileRules

Kirby\Cms\Files

Kirby\Cms\FileVersion

Kirby\Cms\Find

Kirby\Cms\HasChildren

Kirby\Cms\HasFiles

Kirby\Cms\HasMethods

Kirby\Cms\HasModels

Kirby\Cms\HasSiblings

Kirby\Cms\Helpers

Kirby\Cms\Html

Kirby\Cms\Ingredients

Kirby\Cms\Item

Kirby\Cms\Items

Kirby\Cms\LanguagePermissions

Kirby\Cms\Language

Kirby\Cms\LanguageRouter

Kirby\Cms\LanguageRoutes

Kirby\Cms\LanguageRules

Kirby\Cms\Languages

Kirby\Cms\LanguageVariable

Kirby\Cms\LayoutColumn

Kirby\Cms\LayoutColumns

Kirby\Cms\Layout

Kirby\Cms\Layouts

Kirby\Cms\LazyCollection

Kirby\Cms\License

Kirby\Cms\LicenseStatus

Kirby\Cms\LicenseType

Kirby\Cms\Loader

Kirby\Cms\Media

Kirby\Cms\ModelCommit

Kirby\Cms\ModelPermissions

Kirby\Cms\ModelState

Kirby\Cms\ModelWithContent

Kirby\Cms\NestCollection

Kirby\Cms\NestObject

Kirby\Cms\Nest

Kirby\Cms\PageActions

Kirby\Cms\PageBlueprint

Kirby\Cms\PageCopy

Kirby\Cms\PagePermissions

Kirby\Cms\Page

Kirby\Cms\PagePicker

Kirby\Cms\PageRules

Kirby\Cms\PageSiblings

Kirby\Cms\Pages

Kirby\Cms\Pagination

Kirby\Cms\Permissions

Kirby\Cms\Picker

Kirby\Cms\Responder

Kirby\Cms\Response

Kirby\Cms\Role

Kirby\Cms\Roles

Kirby\Cms\R

Kirby\Cms\Search

Kirby\Cms\Section

Kirby\Cms\SiteActions

Kirby\Cms\SiteBlueprint

Kirby\Cms\SitePermissions

Kirby\Cms\Site

Kirby\Cms\SiteRules

Kirby\Cms\S

Kirby\Cms\StructureObject

Kirby\Cms\Structure

Kirby\Cms\System

Kirby\Cms\Translation

Kirby\Cms\Translations

Kirby\Cms\Url

Kirby\Cms\UserActions

Kirby\Cms\UserBlueprint

Kirby\Cms\UserPermissions

Kirby\Cms\User

Kirby\Cms\UserPicker

Kirby\Cms\UserRules

Kirby\Cms\Users

Kirby\Cms\Visitor

Kirby\Cms\Auth\Challenge

Kirby\Cms\Auth\EmailChallenge

Kirby\Cms\Auth\Status

Kirby\Cms\Auth\TotpChallenge

Kirby\Cms\System\UpdateStatus

Kirby\Content\Changes

Kirby\Content\Content

Kirby\Content\Field

Kirby\Content\ImmutableMemoryStorage

Kirby\Content\LockedContentException

Kirby\Content\Lock

Kirby\Content\MemoryStorage

Kirby\Content\PlainTextStorage

Kirby\Content\Storage

Kirby\Content\Translation

Kirby\Content\Translations

Kirby\Content\VersionCache

Kirby\Content\VersionId

Kirby\Content\Version

Kirby\Content\VersionRules

Kirby\Content\Versions

Kirby\Data\Data

Kirby\Data\Frontmatter

Kirby\Data\Handler

Kirby\Data\Json

Kirby\Data\PHP

Kirby\Data\Txt

Kirby\Data\Xml

Kirby\Data\Yaml

Kirby\Data\YamlSpyc

Kirby\Data\YamlSymfony

Kirby\Database\Database

Kirby\Database\Db

Kirby\Database\Query

Kirby\Database\Sql

Kirby\Database\Sql\Mysql

Kirby\Database\Sql\Sqlite

Kirby\Email\Body

Kirby\Email\Email

Kirby\Email\PHPMailer

Kirby\Exception\AuthException

Kirby\Exception\BadMethodCallException

Kirby\Exception\DuplicateException

Kirby\Exception\ErrorPageException

Kirby\Exception\Exception

Kirby\Exception\InvalidArgumentException

Kirby\Exception\LogicException

Kirby\Exception\NotFoundException

Kirby\Exception\PermissionException

Kirby\Field\FieldOptions

Kirby\Filesystem\Asset

Kirby\Filesystem\Dir

Kirby\Filesystem\Filename

Kirby\Filesystem\File

Kirby\Filesystem\F

Kirby\Filesystem\IsFile

Kirby\Filesystem\Mime

Kirby\Form\FieldClass

Kirby\Form\Field

Kirby\Form\Fields

Kirby\Form\Form

Kirby\Form\Validations

Kirby\Form\Field\BlocksField

Kirby\Form\Field\EntriesField

Kirby\Form\Field\LayoutField

Kirby\Form\Field\StatsField

Kirby\Form\Mixin\After

Kirby\Form\Mixin\Api

Kirby\Form\Mixin\Autofocus

Kirby\Form\Mixin\Before

Kirby\Form\Mixin\EmptyState

Kirby\Form\Mixin\Help

Kirby\Form\Mixin\Icon

Kirby\Form\Mixin\Label

Kirby\Form\Mixin\Max

Kirby\Form\Mixin\Min

Kirby\Form\Mixin\Model

Kirby\Form\Mixin\Placeholder

Kirby\Form\Mixin\Translatable

Kirby\Form\Mixin\Validation

Kirby\Form\Mixin\Value

Kirby\Form\Mixin\When

Kirby\Form\Mixin\Width

Kirby\Http\Cookie

Kirby\Http\Environment

Kirby\Http\Header

Kirby\Http\Idn

Kirby\Http\Params

Kirby\Http\Path

Kirby\Http\Query

Kirby\Http\Range

Kirby\Http\Remote

Kirby\Http\Request

Kirby\Http\Response

Kirby\Http\Route

Kirby\Http\Router

Kirby\Http\Uri

Kirby\Http\Url

Kirby\Http\Visitor

Kirby\Http\VolatileHeaders

Kirby\Http\Exceptions\NextRouteException

Kirby\Http\Request\Auth

Kirby\Http\Request\Body

Kirby\Http\Request\Data

Kirby\Http\Request\Files

Kirby\Http\Request\Query

Kirby\Http\Request\Auth\BasicAuth

Kirby\Http\Request\Auth\BearerAuth

Kirby\Http\Request\Auth\SessionAuth

Kirby\Image\Camera

Kirby\Image\Darkroom

Kirby\Image\Dimensions

Kirby\Image\Exif

Kirby\Image\Focus

Kirby\Image\Gravity

Kirby\Image\Image

Kirby\Image\Location

Kirby\Image\QrCode

Kirby\Image\Darkroom\GdLib

Kirby\Image\Darkroom\ImageMagick

Kirby\Image\Darkroom\Imagick

Kirby\Option\Option

Kirby\Option\OptionsApi

Kirby\Option\Options

Kirby\Option\OptionsProvider

Kirby\Option\OptionsQuery

Kirby\Panel\Assets

Kirby\Panel\ChangesDialog

Kirby\Panel\Dialog

Kirby\Panel\Document

Kirby\Panel\Drawer

Kirby\Panel\Dropdown

Kirby\Panel\Field

Kirby\Panel\File

Kirby\Panel\Home

Kirby\Panel\Json

Kirby\Panel\Menu

Kirby\Panel\Model

Kirby\Panel\PageCreateDialog

Kirby\Panel\Page

Kirby\Panel\Panel

Kirby\Panel\Plugins

Kirby\Panel\Redirect

Kirby\Panel\Request

Kirby\Panel\Search

Kirby\Panel\Site

Kirby\Panel\User

Kirby\Panel\UserTotpDisableDialog

Kirby\Panel\UserTotpEnableDialog

Kirby\Panel\View

Kirby\Panel\Collector\FilesCollector

Kirby\Panel\Collector\ModelsCollector

Kirby\Panel\Collector\PagesCollector

Kirby\Panel\Collector\UsersCollector

Kirby\Panel\Controller\PageTree

Kirby\Panel\Controller\Search

Kirby\Panel\Lab\Category

Kirby\Panel\Lab\Doc

Kirby\Panel\Lab\Docs

Kirby\Panel\Lab\Example

Kirby\Panel\Lab\Responses

Kirby\Panel\Lab\Snippet

Kirby\Panel\Lab\Template

Kirby\Panel\Lab\Doc\Argument

Kirby\Panel\Lab\Doc\Event

Kirby\Panel\Lab\Doc\Method

Kirby\Panel\Lab\Doc\Prop

Kirby\Panel\Lab\Doc\Slot

Kirby\Panel\Ui\Button

Kirby\Panel\Ui\Component

Kirby\Panel\Ui\FilePreview

Kirby\Panel\Ui\Stat

Kirby\Panel\Ui\Stats

Kirby\Panel\Ui\Upload

Kirby\Panel\Ui\Buttons\LanguageCreateButton

Kirby\Panel\Ui\Buttons\LanguageDeleteButton

Kirby\Panel\Ui\Buttons\LanguagesDropdown

Kirby\Panel\Ui\Buttons\LanguageSettingsButton

Kirby\Panel\Ui\Buttons\OpenButton

Kirby\Panel\Ui\Buttons\PageStatusButton

Kirby\Panel\Ui\Buttons\PreviewButton

Kirby\Panel\Ui\Buttons\SettingsButton

Kirby\Panel\Ui\Buttons\VersionsButton

Kirby\Panel\Ui\Buttons\ViewButton

Kirby\Panel\Ui\Buttons\ViewButtons

Kirby\Panel\Ui\FilePreviews\AudioFilePreview

Kirby\Panel\Ui\FilePreviews\DefaultFilePreview

Kirby\Panel\Ui\FilePreviews\ImageFilePreview

Kirby\Panel\Ui\FilePreviews\PdfFilePreview

Kirby\Panel\Ui\FilePreviews\VideoFilePreview

Kirby\Panel\Ui\Item\FileItem

Kirby\Panel\Ui\Item\ModelItem

Kirby\Panel\Ui\Item\PageItem

Kirby\Panel\Ui\Item\UserItem

Kirby\Parsley\Element

Kirby\Parsley\Inline

Kirby\Parsley\Parsley

Kirby\Parsley\Schema

Kirby\Parsley\Schema\Blocks

Kirby\Parsley\Schema\Plain

Kirby\Plugin\Asset

Kirby\Plugin\Assets

Kirby\Plugin\License

Kirby\Plugin\LicenseStatus

Kirby\Plugin\Plugin

Kirby\Query\Argument

Kirby\Query\Arguments

Kirby\Query\Expression

Kirby\Query\Query

Kirby\Query\Segment

Kirby\Query\Segments

Kirby\Query\AST\ArgumentListNode

Kirby\Query\AST\ArithmeticNode

Kirby\Query\AST\ArrayListNode

Kirby\Query\AST\ClosureNode

Kirby\Query\AST\CoalesceNode

Kirby\Query\AST\ComparisonNode

Kirby\Query\AST\GlobalFunctionNode

Kirby\Query\AST\LiteralNode

Kirby\Query\AST\LogicalNode

Kirby\Query\AST\MemberAccessNode

Kirby\Query\AST\Node

Kirby\Query\AST\TernaryNode

Kirby\Query\AST\VariableNode

Kirby\Query\Parser\Parser

Kirby\Query\Parser\Tokenizer

Kirby\Query\Parser\Token

Kirby\Query\Parser\TokenType

Kirby\Query\Runners\DefaultRunner

Kirby\Query\Runners\Runner

Kirby\Query\Runners\Scope

Kirby\Query\Visitors\DefaultVisitor

Kirby\Query\Visitors\Visitor

Kirby\Reflection\Constructor

Kirby\Sane\DomHandler

Kirby\Sane\Handler

Kirby\Sane\Html

Kirby\Sane\Sane

Kirby\Sane\Svg

Kirby\Sane\Svgz

Kirby\Sane\Xml

Kirby\Session\AutoSession

Kirby\Session\FileSessionStore

Kirby\Session\SessionData

Kirby\Session\Session

Kirby\Session\Sessions

Kirby\Session\SessionStore

Kirby\Template\Slot

Kirby\Template\Slots

Kirby\Template\Snippet

Kirby\Template\Template

Kirby\Text\KirbyTag

Kirby\Text\KirbyTags

Kirby\Text\Markdown

Kirby\Text\SmartyPants

Kirby\Toolkit\A

Kirby\Toolkit\BlockCollectionAccess

Kirby\Toolkit\Collection

Kirby\Toolkit\Component

Kirby\Toolkit\Config

Kirby\Toolkit\Controller

Kirby\Toolkit\Date

Kirby\Toolkit\Dom

Kirby\Toolkit\Escape

Kirby\Toolkit\Facade

Kirby\Toolkit\Html

Kirby\Toolkit\I18n

Kirby\Toolkit\Iterator

Kirby\Toolkit\LazyValue

Kirby\Toolkit\Locale

Kirby\Toolkit\Obj

Kirby\Toolkit\Pagination

Kirby\Toolkit\Silo

Kirby\Toolkit\Str

Kirby\Toolkit\SymmetricCrypto

Kirby\Toolkit\Totp

Kirby\Toolkit\Tpl

Kirby\Toolkit\View

Kirby\Toolkit\V

Kirby\Toolkit\Xml

Kirby\Uuid\BlockUuid

Kirby\Uuid\FieldUuid

Kirby\Uuid\FileUuid

Kirby\Uuid\HasUuids

Kirby\Uuid\Identifiable

Kirby\Uuid\ModelUuid

Kirby\Uuid\PageUuid

Kirby\Uuid\SiteUuid

Kirby\Uuid\StructureUuid

Kirby\Uuid\Uri

Kirby\Uuid\UserUuid

Kirby\Uuid\Uuid

Kirby\Uuid\Uuids

(:all)

(:alpha)

(:alphanum)

(:any)

(:num)

Array

Empty

Exception

Page

Response

String

api

auth

cache

content

cookie

cors

date

debug

editor

email

error

fatal

home

hooks

kirbytext

languages

locale

markdown

panel

query

ready

remote

routes

session

slugs

smartypants

thumbs

updates

url

whoops

yaml

servers

$kirby->url('assets')

$kirby->url('index')

$kirby->url('media')

$kirby->root('accounts')

$kirby->root('assets')

$kirby->root('blueprints')

$kirby->root('cache')

$kirby->root('collections')

$kirby->root('commands')

$kirby->root('config')

$kirby->root('content')

$kirby->root('controllers')

$kirby->root('i18n')

$kirby->root('i18n:rules')

$kirby->root('i18n:translations')

$kirby->root('index')

$kirby->root('kirby')

$kirby->root('languages')

$kirby->root('license')

$kirby->root('licenses')

$kirby->root('logs')

$kirby->root('media')

$kirby->root('models')

$kirby->root('panel')

$kirby->root('plugins')

$kirby->root('roles')

$kirby->root('sessions')

$kirby->root('site')

$kirby->root('snippets')

$kirby->root('templates')

accepted

alpha

alphanum

between

callback

contains

date

denied

different

email

empty

endsWith

filename

in

integer

ip

json

less

match

max

min

maxLength

minLength

maxWords

minWords

more

notContains

notEmpty

notIn

num

required

same

size

startsWith

tel

time

url

uuid

API

Asset methods

Auth challenges

Block methods

Block models

Blocks

Blocks methods

Blueprints

Cache driver

Collection filters

Collection methods

Collections

Commands

Controllers

Core components

Panel Created

Darkroom driver

Field methods

Field previews

Fields

File methods

File previews

File types

Files methods

Hooks

Icons

KirbyTags

Layout column methods

Layout methods

Layouts methods

Options

Page methods

Page models

Pages

Pages methods

Panel areas

Panel dialogs

Panel drawers

Panel dropdowns

Panel search

Panel view buttons

Permissions

Request auth types

Routes

Sections

Site methods

Snippets

Templates

Textarea buttons

Translations

User methods

User models

Users methods

Validators

Writer marks/nodes

file.changeName:after

file.changeName:before

file.changeSort:after

file.changeSort:before

file.create:after

file.create:before

file.delete:after

file.delete:before

file.replace:after

file.replace:before

file.update:after

file.update:before

kirbytags:after

kirbytags:before

kirbytext:after

kirbytext:before

language.create:after

language.create:before

language.delete:after

language.delete:before

language.update:after

language.update:before

page.changeNum:after

page.changeNum:before

page.changeSlug:after

page.changeSlug:before

page.changeStatus:after

page.changeStatus:before

page.changeTemplate:after

page.changeTemplate:before

page.changeTitle:after

page.changeTitle:before

page.create:after

page.create:before

page.delete:after

page.delete:before

page.duplicate:after

page.duplicate:before

page.render:after

page.render:before

page.update:after

page.update:before

panel.route:after

panel.route:before

route:after

route:before

site.changeTitle:after

site.changeTitle:before

site.update:after

site.update:before

system.exception

system.loadPlugins:after

user.changeEmail:after

user.changeEmail:before

user.changeLanguage:after

user.changeLanguage:before

user.changeName:after

user.changeName:before

user.changePassword:after

user.changePassword:before

user.changeRole:after

user.changeRole:before

user.create:after

user.create:before

user.delete:after

user.delete:before

user.login:after

user.login:before

user.logout:after

user.logout:before

user.update:after

user.update:before

CSS URLs

Email

File URLs

File versions

JavaScript URLs

Markdown parser

Search

SmartyPants parser

Snippets

Storage

Templates

Thumbs

URLs

POST /api/auth/login

POST /api/auth/logout

GET /api/auth

GET /api/languages

POST /api/languages

GET /api/languages/:code

PATCH /api/languages/:code

DELETE /api/languages/:code

GET /api/pages/:id

PATCH /api/pages/:id

DELETE /api/pages/:id

GET /api/pages/:id/children

GET|POST /api/pages/:id/children/search

POST /api/pages/:id/children

GET /api/pages/:id/blueprints

GET /api/pages/:id/files

POST /api/pages/:id/files

PATCH /api/pages/:id/files/sort

GET /api/pages/:id/files/:filename

GET|POST /api/pages/:id/files/search

GET /api/pages/:id/files/:filename/sections/:name

PATCH /api/pages/:id/files/:filename

PATCH /api/pages/:id/files/:filename/name

DELETE /api/pages/:id/files/:filename

PATCH /api/pages/:id/slug

PATCH /api/pages/:id/status

PATCH /api/pages/:id/template

PATCH /api/pages/:id/title

POST /api/pages/:id/changes/discard

POST /api/pages/:id/changes/publish

POST /api/pages/:id/changes/save

POST /api/pages/:id/files/:filename/changes/discard

POST /api/pages/:id/files/:filename/changes/publish

POST /api/pages/:id/files/:filename/changes/save

GET /api/roles

GET /api/roles/:id

GET /api/site

PATCH /api/site/

GET /api/site/children

POST /api/site/children

GET|POST /api/site/:id/search

GET /api/site/blueprints

GET /api/site/files

POST /api/site/files

PATCH /api/site/files/sort

GET /api/site/files/:filename

GET|POST /api/site/:id/files/search

PATCH /api/site/files/:filename

DELETE /api/site/files/:filename

PATCH /api/site/files/:filename/name

GET /api/site/files/:filename/sections/:name

GET /api/site/sections/:name

PATCH /api/site/title

POST /api/site/changes/discard

POST /api/site/changes/publish

POST /api/site/changes/save

POST /api/site/files/:filename/changes/discard

POST /api/site/files/:filename/changes/publish

POST /api/site/files/:filename/changes/save

GET /api/system

POST /api/system/install

POST /api/system/register

GET /api/translations

GET /api/translations/:code

GET /api/users

POST /api/users/

GET /api/users/:id

GET|POST /api/users/:id/search

PATCH /api/users/:id

DELETE /api/users/:id

PATCH /api/users/:id/email

GET /api/users/:id/files

POST /api/users/:id/files

GET|POST /api/users/:id/files/search

PATCH /api/users/:id/files/sort

GET /api/users/:id/files/:filename

PATCH /api/users/:id/files/:filename

DELETE /api/users/:id/files/:filename

PATCH /api/users/:id/files/:filename/name

GET /api/users/:id/files/:filename/sections/:name

PATCH /api/users/:id/language

PATCH /api/users/:id/name

PATCH /api/users/:id/password

PATCH /api/users/:id/role

GET /api/users/:id/sections/:name

POST /api/users/:id/changes/discard

POST /api/users/:id/changes/publish

POST /api/users/:id/changes/save

POST /api/users/:id/files/:filename/changes/discard

POST /api/users/:id/files/:filename/changes/publish

POST /api/users/:id/files/:filename/changes/save

Cookbook

Filtering via routes

Filtering collections

Filtering with tags

Grouping collections

Random content

Related articles

Search

Sorting collections

Load more with Ajax

Creating OG images

Populate Figma designs

Generating JSON

Adding authors

Creating a blog

Custom post types

Nested blocks

One-pager

Paginating posts

Subpage builder

Placeholders

Batch updating content

Kirby meets Caddy

Coding style standards

Content clean-up

Kirby meets DDEV

Deployment with Dokku

Git-based FTP-deploys

Kirby meets Docker

Alternative multisite setup

Kirby meets Nginx

PHP-based blueprints

Replacing core classes

Email testing

Kirbytext columns

Preview images for PDFs

Contact form

Create pages from frontend

Forms with attachments

Uploading files

User registration

Including CSS/JS libraries

Kirby meets PurgeCSS

Kirby meets Tailwind CSS

Going Headless

Headless kiosk app

Fetching field options

Finding translations

Import/export translations

Dropbox sync

IndieAuth for your site

Menu builder

Menus

Pagination

Previous / Next navigation

Sitemap

Anchors and ToCs

Advanced Panel area

Basic Panel area

Custom Panel field

Custom Panel section

Kirby loves CDN

Image lazy-loading

Responsive images

Basic error hunting & prevention

Fun with loops and collections

Debugging with Xdebug

PHP templating

OOP in PHP

Monolithic plugin setup

Plugin testing with PHPUnit

Plugins with/without a build process

Access forbidden

Protecting files

Extending permissions

A/B testing with Kirby

Accessing blueprints

How we built getkirby.com

Kosmos - A newsletter tool

Quicktips

Add custom HTML to your Panel

Art-directed pages

Customize Panel

Sharing templates across blueprints

Reusing KirbyTags

Filter by language

Cache fine-tuning

HTML title tag

Improve IDE support

Keep code dry

Order of KirbyText/KirbyTags hooks

Language variables

Instant page factory

Serve page on own domain

Panel branding

Skip media folder

Editable redirects

Remove rounded corners

Snippet controllers

Structured content

Add/prevent trailing slash

Translate exception messages

Add blocks to blocks field programmatically

Update file metadata

Placeholders in language strings

Glossary

API

Blueprint

Collection

Component

Content

Content representation

Controller

Document root

Field

Field Method

KirbyTag

KirbyText

Markdown

Page Model

Page

Panel

Route

Section

Site

SmartyPants

Snippet

Starterkit

Template

Vue

Whoops

YAML

## What is Kirby CMS Docs's llms.txt?

Kirby CMS Docs publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Kirby CMS Docs offers and where to find details.

Issues

Spec

5

Sections

1088

Links

96.2 KB

Size

~24.6k

Tokens

Sections: Guide · Reference · Cookbook · Quicktips · Glossary

## Add Kirby CMS Docs Docs to Your AI Assistant

Select your tool to see how to add Kirby CMS Docs's llms.txt as a documentation source.

Cursor

 Windsurf

 Claude Code

 ChatGPT

 Zed

 Copilot

1. 1

   Open any chat or composer panel
2. 2

   Type @Docs and select "Add new doc"
3. 3

   Paste the URL: https://getkirby.com/llms.txt
4. 4

   Wait for the green dot (indexing complete)
5. 5

   Reference @Docs in chat when asking about Kirby CMS Docs

Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.

## Spec Compliance 106 errors

## Frequently Asked Questions

Where is Kirby CMS Docs's llms.txt file?

Kirby CMS Docs publishes its llms.txt at https://getkirby.com/llms.txt. This file provides a structured, markdown-formatted index of Kirby CMS Docs's documentation that AI systems can consume to understand the project's APIs, guides, and references.

How do I use Kirby CMS Docs's llms.txt with AI coding assistants?

Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Kirby CMS Docs's documentation so it can provide better code suggestions and answers about Kirby CMS Docs.

What does Kirby CMS Docs's llms.txt contain?

Kirby CMS Docs's llms.txt contains 5 sections and 1088 documentation links in 96.2 KB (~24.6k tokens). Key sections include Guide, Reference, Cookbook, Quicktips, Glossary.

How many tokens does Kirby CMS Docs's llms.txt use?

The concise llms.txt index is approximately 24.6k tokens (96.2 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline.

What is Kirby CMS Docs?

The official Kirby CMS documentation for Kirby CMS, covering Guides, Reference, Cookbook and Quicktips.. Kirby CMS Docs's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Kirby CMS Docs.

Can I generate an llms.txt for my own project?

Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator.

## Browse More llms.txt Files

[Axiom Docs](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/axiom-docs) [Dynamic Documentation**Agent navigation guide:** Use the Table of Contents to identify the](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/dynamic-documentation) [ElevenLabs Documentation](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/elevenlabs-documentation) [Saleor Commerce The commerce engine for modern software development teams.](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/saleor-commerce) [Junction](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/junction) [Spree Commerce documentation](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/spree-commerce-documentation) [Mangopay docs](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/mangopay-docs) [Honeybadger Honeybadger provides all-in-one error tracking, uptime monitoring, logging, and application performance monitoring (Just Enough APM™) in one simple observability platform built for developers.](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt/honeybadger)

[View all 99 projects ](https://mdream.dev/llms-txt/kirby-cms-docs/llms-txt)

## Related Tools

[<h3>llms.txt Generator</h3>Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/kirby-cms-docs/tools/llms-txt/generator) [<h3>llms.txt Validator</h3>Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/kirby-cms-docs/tools/llms-txt/validator)

© 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license)

[GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)