> For the complete documentation index, see [llms.txt](https://docs.keycloakify.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keycloakify.dev/keycloakify/v9/readme.md).

# Quick start

The best way to get started with Keycloakify is to study and play around with the starter project.

**The README of the starter repo is the tutorial!** It details everything there is to know and there is a lot of comments in the code to help you figure things out.

{% embed url="<https://github.com/codegouvfr/keycloakify-starter>" %}

Alternatively, one of the main contributors of the project wrote a tutorial on his blog article. Check it out!

{% hint style="info" %}
This video from The UI Dawg is great to give you an overview of how Keycloakify operates but don't treat it as a tutorial!\
The authoritative source is [the readme of the starter project](https://github.com/keycloakify/keycloakify-starter) and this documentation website!
{% endhint %}

{% embed url="<https://youtu.be/x3ux2JM1Bxk>" %}
Introduction video + blog post
{% endembed %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.keycloakify.dev/keycloakify/v9/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.