> For the complete documentation index, see [llms.txt](https://docs.catalyx.solutions/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.catalyx.solutions/catalyx-daml-coding-assistant/getting-started.md).

# Getting Started

***

## Overview of the Required Steps

1. **Install the extension** – Add CatalyX Daml Coding Assistant to VS Code from the Visual Studio Marketplace.
2. **Sign in / register** – Create an account with your email or Google account, verify your email address, and accept the Terms and Conditions. Access is granted automatically.
3. **Start completing** – Open a `.daml` file and start typing.

If at any point you need assistance, please reach out through the [Support Center](/support-center.md).

## Step-by-Step Instructions

{% stepper %}
{% step %}
**Install the extension**

In VS Code, open the **Extensions** view (`Ctrl+Shift+X` / `Cmd+Shift+X`) and search for **CatalyX Daml Coding Assistant**, or install it directly from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=intellecteu.daml-coding-assistant). The extension requires VS Code 1.108 or newer.

<div data-with-frame="true"><figure><img src="/files/fni8mvwh1Nqi6ealUUWJ" alt="The CatalyX Daml Coding Assistant in the VS Code Extensions view"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Sign in / register**

The extension prompts you to sign in — at startup, and again when you first request a completion. Click **Log in** (you can also run the command `Daml Coding Assistant: Log In` at any time), and a browser window opens for login.

<div data-with-frame="true"><figure><img src="/files/Z2YZeSyux7uv9yKtcuCb" alt="VS Code notification asking to log in to the Daml Coding Assistant"><figcaption></figcaption></figure></div>

Around the same time, the extension asks whether you want to share code snippets to help improve the model. This is **off by default**: completions work identically either way, and you can change your choice at any time via the `daml-coding-assistant.shareCodeSnippets` setting — see [Usage & Settings](/catalyx-daml-coding-assistant/usage-and-settings.md#data-sharing-and-privacy).

<div data-with-frame="true"><figure><img src="/files/isRL7sbMPtQ1PFeE378x" alt="VS Code notification asking whether to share code snippets to help improve the model"><figcaption></figcaption></figure></div>

New users can register from the login page (**Register**) with an email address and password, or sign in directly with a Google account.

<div data-with-frame="true"><figure><img src="/files/mb7ssHqzPOn7CsLUoy9g" alt="The browser sign-in page with email, Google sign-in, and Register options"><figcaption></figcaption></figure></div>

If you register with an email address, you will receive a verification email — click the link to verify your address.

<div data-with-frame="true"><figure><img src="/files/698jEVYKqulcGQ1d70O8" alt="The verification email"><figcaption></figcaption></figure></div>

Finally, review and accept the Terms and Conditions to complete your registration.

<div data-with-frame="true"><figure><img src="/files/FwHYxjz6rPcrcrMPJqyk" alt="The Terms and Conditions acceptance page"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Start completing**

Open a `.daml` file and start typing. Suggestions appear inline as ghost text — press **Tab** to accept the full completion, or `Cmd+→` (`Ctrl+→` on Windows/Linux) to accept it word by word.

<div data-with-frame="true"><figure><img src="/files/x8DHOvw7PhBQEvVf9wn1" alt="A ghost-text completion suggested inline in a .daml file"><figcaption></figcaption></figure></div>

{% hint style="success" %}
That's it — you're set up. Head to [Usage & Settings](/catalyx-daml-coding-assistant/usage-and-settings.md) to learn about manual triggering, partial accepts, and keyboard shortcuts.
{% endhint %}
{% endstep %}
{% endstepper %}


---

# 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://docs.catalyx.solutions/catalyx-daml-coding-assistant/getting-started.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.