# $kirby

The `$kirby` object is the app instance of your Kirby installation. It's the central starting point to get all the different aspects of your site, like the options, urls, roots, languages, roles, etc.

****

- Full class name: `Kirby\Cms\App`
- Alias: `Kirby`
- Source: <https://github.com/getkirby/kirby/tree/5.5.3/src/Cms/App.php#L55>

****

### $kirby

- [new Kirby()](https://getkirby.com/docs/reference/objects/cms/app/__construct.md)
- [$kirby->__debugInfo()](https://getkirby.com/docs/reference/objects/cms/app/__debug-info.md)
- [$kirby->api()](https://getkirby.com/docs/reference/objects/cms/app/api.md)
- [$kirby->apply()](https://getkirby.com/docs/reference/objects/cms/app/apply.md)
- [$kirby->auth()](https://getkirby.com/docs/reference/objects/cms/app/auth.md)
- [$kirby->blueprints()](https://getkirby.com/docs/reference/objects/cms/app/blueprints.md)
- [$kirby->cache()](https://getkirby.com/docs/reference/objects/cms/app/cache.md)
- [$kirby->call()](https://getkirby.com/docs/reference/objects/cms/app/call.md)
- [$kirby->clone()](https://getkirby.com/docs/reference/objects/cms/app/clone.md)
- [$kirby->collection()](https://getkirby.com/docs/reference/objects/cms/app/collection.md)
- [$kirby->collections()](https://getkirby.com/docs/reference/objects/cms/app/collections.md)
- [$kirby->component()](https://getkirby.com/docs/reference/objects/cms/app/component.md)
- [$kirby->contentExtension()](https://getkirby.com/docs/reference/objects/cms/app/content-extension.md)
- [$kirby->contentIgnore()](https://getkirby.com/docs/reference/objects/cms/app/content-ignore.md)
- [$kirby->contentToken()](https://getkirby.com/docs/reference/objects/cms/app/content-token.md)
- [$kirby->controller()](https://getkirby.com/docs/reference/objects/cms/app/controller.md)
- [$kirby->core()](https://getkirby.com/docs/reference/objects/cms/app/core.md)
- [$kirby->csrf()](https://getkirby.com/docs/reference/objects/cms/app/csrf.md)
- [$kirby->currentLanguage()](https://getkirby.com/docs/reference/objects/cms/app/current-language.md)
- [$kirby->defaultLanguage()](https://getkirby.com/docs/reference/objects/cms/app/default-language.md)
- [Kirby::destroy()](https://getkirby.com/docs/reference/objects/cms/app/destroy.md)
- [$kirby->detectedLanguage()](https://getkirby.com/docs/reference/objects/cms/app/detected-language.md)
- [$kirby->disguiseFilePath()](https://getkirby.com/docs/reference/objects/cms/app/disguise-file-path.md)
- [$kirby->email()](https://getkirby.com/docs/reference/objects/cms/app/email.md)
- [$kirby->environment()](https://getkirby.com/docs/reference/objects/cms/app/environment.md)
- [$kirby->extend()](https://getkirby.com/docs/reference/objects/cms/app/extend.md)
- [$kirby->extension()](https://getkirby.com/docs/reference/objects/cms/app/extension.md)
- [$kirby->extensions()](https://getkirby.com/docs/reference/objects/cms/app/extensions.md)
- [$kirby->file()](https://getkirby.com/docs/reference/objects/cms/app/file.md)
- [$kirby->image()](https://getkirby.com/docs/reference/objects/cms/app/image.md)
- [$kirby->impersonate()](https://getkirby.com/docs/reference/objects/cms/app/impersonate.md)
- [Kirby::instance()](https://getkirby.com/docs/reference/objects/cms/app/instance.md)
- [$kirby->io()](https://getkirby.com/docs/reference/objects/cms/app/io.md)
- [$kirby->isCorsEnabled()](https://getkirby.com/docs/reference/objects/cms/app/is-cors-enabled.md)
- [$kirby->isNativeComponent()](https://getkirby.com/docs/reference/objects/cms/app/is-native-component.md)
- [$kirby->kirbytag()](https://getkirby.com/docs/reference/objects/cms/app/kirbytag.md)
- [$kirby->kirbytags()](https://getkirby.com/docs/reference/objects/cms/app/kirbytags.md)
- [$kirby->kirbytext()](https://getkirby.com/docs/reference/objects/cms/app/kirbytext.md)
- [$kirby->language()](https://getkirby.com/docs/reference/objects/cms/app/language.md)
- [$kirby->languageCode()](https://getkirby.com/docs/reference/objects/cms/app/language-code.md)
- [$kirby->languages()](https://getkirby.com/docs/reference/objects/cms/app/languages.md)
- [$kirby->load()](https://getkirby.com/docs/reference/objects/cms/app/load.md)
- [$kirby->markdown()](https://getkirby.com/docs/reference/objects/cms/app/markdown.md)
- [$kirby->models()](https://getkirby.com/docs/reference/objects/cms/app/models.md)
- [$kirby->multilang()](https://getkirby.com/docs/reference/objects/cms/app/multilang.md)
- [$kirby->nativeComponent()](https://getkirby.com/docs/reference/objects/cms/app/native-component.md)
- [$kirby->nonce()](https://getkirby.com/docs/reference/objects/cms/app/nonce.md)
- [$kirby->option()](https://getkirby.com/docs/reference/objects/cms/app/option.md)
- [$kirby->options()](https://getkirby.com/docs/reference/objects/cms/app/options.md)
- [$kirby->page()](https://getkirby.com/docs/reference/objects/cms/app/page.md)
- [$kirby->panelLanguage()](https://getkirby.com/docs/reference/objects/cms/app/panel-language.md)
- [$kirby->path()](https://getkirby.com/docs/reference/objects/cms/app/path.md)
- [Kirby::plugin()](https://getkirby.com/docs/reference/objects/cms/app/plugin.md)
- [$kirby->plugins()](https://getkirby.com/docs/reference/objects/cms/app/plugins.md)
- [$kirby->render()](https://getkirby.com/docs/reference/objects/cms/app/render.md)
- [$kirby->request()](https://getkirby.com/docs/reference/objects/cms/app/request.md)
- [$kirby->resolve()](https://getkirby.com/docs/reference/objects/cms/app/resolve.md)
- [$kirby->resolveFile()](https://getkirby.com/docs/reference/objects/cms/app/resolve-file.md)
- [$kirby->response()](https://getkirby.com/docs/reference/objects/cms/app/response.md)
- [$kirby->role()](https://getkirby.com/docs/reference/objects/cms/app/role.md)
- [$kirby->roles()](https://getkirby.com/docs/reference/objects/cms/app/roles.md)
- [$kirby->root()](https://getkirby.com/docs/reference/objects/cms/app/root.md)
- [$kirby->roots()](https://getkirby.com/docs/reference/objects/cms/app/roots.md)
- [$kirby->route()](https://getkirby.com/docs/reference/objects/cms/app/route.md)
- [$kirby->router()](https://getkirby.com/docs/reference/objects/cms/app/router.md)
- [$kirby->routes()](https://getkirby.com/docs/reference/objects/cms/app/routes.md)
- [$kirby->session()](https://getkirby.com/docs/reference/objects/cms/app/session.md)
- [$kirby->sessionHandler()](https://getkirby.com/docs/reference/objects/cms/app/session-handler.md)
- [$kirby->setCurrentLanguage()](https://getkirby.com/docs/reference/objects/cms/app/set-current-language.md)
- [$kirby->setCurrentTranslation()](https://getkirby.com/docs/reference/objects/cms/app/set-current-translation.md)
- [$kirby->setSite()](https://getkirby.com/docs/reference/objects/cms/app/set-site.md)
- [$kirby->site()](https://getkirby.com/docs/reference/objects/cms/app/site.md)
- [$kirby->smartypants()](https://getkirby.com/docs/reference/objects/cms/app/smartypants.md)
- [$kirby->snippet()](https://getkirby.com/docs/reference/objects/cms/app/snippet.md)
- [$kirby->storage()](https://getkirby.com/docs/reference/objects/cms/app/storage.md)
- [$kirby->system()](https://getkirby.com/docs/reference/objects/cms/app/system.md)
- [$kirby->template()](https://getkirby.com/docs/reference/objects/cms/app/template.md)
- [$kirby->thumb()](https://getkirby.com/docs/reference/objects/cms/app/thumb.md)
- [$kirby->translation()](https://getkirby.com/docs/reference/objects/cms/app/translation.md)
- [$kirby->translations()](https://getkirby.com/docs/reference/objects/cms/app/translations.md)
- [$kirby->trigger()](https://getkirby.com/docs/reference/objects/cms/app/trigger.md)
- [$kirby->url()](https://getkirby.com/docs/reference/objects/cms/app/url.md)
- [$kirby->urls()](https://getkirby.com/docs/reference/objects/cms/app/urls.md)
- [$kirby->user()](https://getkirby.com/docs/reference/objects/cms/app/user.md)
- [$kirby->users()](https://getkirby.com/docs/reference/objects/cms/app/users.md)
- [Kirby::version()](https://getkirby.com/docs/reference/objects/cms/app/version.md)
- [Kirby::versionHash()](https://getkirby.com/docs/reference/objects/cms/app/version-hash.md)
- [$kirby->visitor()](https://getkirby.com/docs/reference/objects/cms/app/visitor.md)

## How to fetch the `$kirby` object

The `$kirby` class is accessible in Kirby's templates/snippets etc. through the `$kirby` variable.

In any situation, you can define a `$kirby` object using the <a class="type-link" href="https://getkirby.com/docs/reference/templates/helpers/kirby"><code class="type type-method">kirby()</code></a> helper:

```php
$kirby = kirby();
````