> For the complete documentation index, see [llms.txt](https://guides-mechboards.gitbook.io/guides/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guides-mechboards.gitbook.io/guides/other-guides/using-zmk-studio.md).

# Using ZMK Studio

You can use ZMK Studio via the [desktop application](https://github.com/zmkfirmware/zmk/releases) or the [web app](https://zmk.studio/).

{% hint style="warning" %}
The desktop application allows you to change your keymap using Bluetooth. The web app **requires** you to connect one half of the keyboard via USB cable. 
{% endhint %}

{% hint style="danger" %}
Make sure to connect your keyboard to your device using Bluetooth
{% endhint %}

* Load ZMK Studio
* Select your device within ZMK

{% hint style="info" %}
Some devices require Studio Unlock to access ZMK Studio - you can find how on their respective Getting Started pages.
{% endhint %}

<figure><img src="/files/FZ3H5QgDSQJXHGuLUzty" alt=""><figcaption><p>This example uses the USB method</p></figcaption></figure>

<figure><img src="/files/UVPW7xNHYmJuSXx4Fsbd" alt=""><figcaption><p>Here is the Studio Unlock warning. you can find how to unlock your device on their respective Getting Started pages</p></figcaption></figure>

Once unlocked you'll be greeted with the overview screen, showing the keymap layout and on the left column the different layers.&#x20;

<figure><img src="/files/rQTeF2wUg6kYBOa3zqLP" alt=""><figcaption></figcaption></figure>

Clicking a key brings up the editor area, where you can reassign your key.&#x20;

<figure><img src="/files/9g9RIibYiXvqdV2mzPJV" alt=""><figcaption></figcaption></figure>

For further information, follow the ZMK Documentation

{% embed url="<https://zmk.dev/docs>" %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://guides-mechboards.gitbook.io/guides/other-guides/using-zmk-studio.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.