> 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/usage-and-settings.md).

# Usage & Settings

***

## Triggering completions

The extension suggests completions in `.daml` files based on the code around your cursor.

* **Automatic mode** (default) — suggestions appear while you type.
* **Manual mode** — set `daml-coding-assistant.triggerMode` to `manual`, then request a suggestion with VS Code's **Trigger Inline Suggestion** action (`editor.action.inlineSuggest.trigger`). The default binding is `Option+\` on macOS and `Alt+\` on Windows/Linux.

## Accepting suggestions

Suggestions appear as inline ghost text. Press **Tab** to accept the whole suggestion, or accept it piece by piece:

| Action                     | Command                                      | Default shortcut                    |
| -------------------------- | -------------------------------------------- | ----------------------------------- |
| Accept the full suggestion | `editor.action.inlineSuggest.commit`         | `Tab`                               |
| Accept the next word       | `editor.action.inlineSuggest.acceptNextWord` | `Cmd+→` (`Ctrl+→` on Windows/Linux) |
| Dismiss the suggestion     | `editor.action.inlineSuggest.hide`           | `Esc`                               |

{% hint style="info" %}
These are standard VS Code inline-suggestion shortcuts rather than extension-specific keybindings. To view or change them, open **Keyboard Shortcuts** (`Cmd+K Cmd+S` on macOS, `Ctrl+K Ctrl+S` on Windows/Linux) and search for "inline suggestion".
{% endhint %}

## Commands

Open the Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`) and type "Daml Coding Assistant":

* **Daml Coding Assistant: Log In** — sign in via the browser.
* **Daml Coding Assistant: Log Out** — clear the stored token and open the browser to end the login session there too, so a different user can sign in.
* **Daml Coding Assistant: Auth Status** — show whether you are signed in.
* **Daml Coding Assistant: Account Menu** — the actions above in one menu; also opens from the Daml Coding Assistant status-bar item.

{% hint style="warning" %}
Uninstalling the extension does not clear the stored login — VS Code keeps extension storage for reinstalls. Run **Daml Coding Assistant: Log Out** before uninstalling to fully sign out.
{% endhint %}

## Settings

All settings have working defaults; you normally do not need to change any of them.

| Setting                                   | Default                             | Description                                                                                                                      |
| ----------------------------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `daml-coding-assistant.triggerMode`       | `automatic`                         | `automatic` shows suggestions while typing; `manual` only on the trigger action.                                                 |
| `daml-coding-assistant.shareCodeSnippets` | off (asked on first use)            | Share code with the server to help improve the model. See [Data sharing and privacy](#data-sharing-and-privacy).                 |
| `daml-coding-assistant.serverUrl`         | `https://api.dca.catalyx.solutions` | The inference server to use. Change this to point at a [self-hosted](/catalyx-daml-coding-assistant/self-hosting.md) deployment. |
| `daml-coding-assistant.oidcDiscoveryUrl`  | the hosted service's login realm    | Identity-provider realm discovery URL. Advanced: change only when pointing at a different environment.                           |
| `daml-coding-assistant.oidcClientId`      | the hosted service's client ID      | OIDC public client ID. Advanced: change only when pointing at a different environment.                                           |

## Data sharing and privacy

The `daml-coding-assistant.shareCodeSnippets` setting controls whether code content is retained by the hosted service. The extension asks for your choice on first use, and completions work normally either way.

* **Off (default):** no code content from your requests is retained. Anonymous metrics are still reported: whether suggestions were accepted (a boolean only — never the suggestion text), character counts, and latency.
* **On:** the context around your cursor and the text of accepted completions are kept in the server's logs and may be used to improve the model.

Use of the hosted service is subject to the [Terms of Use](https://api.dca.catalyx.solutions/terms); data handling is described in the [Privacy Notice](https://api.dca.catalyx.solutions/privacy).

## Troubleshooting

No completions appearing?

* **Check the status bar** — the Daml Coding Assistant item (bottom right) shows whether you are signed out, signed in without access, or active. Click it to open the account menu.
* **Check your login** — run `Daml Coding Assistant: Auth Status`. It also reports an expired login token; run `Daml Coding Assistant: Log In` to sign in again.
* **Check the file type** — completions are only suggested in `.daml` files.
* **Check the logs** — open the Output panel (**View → Output**) and select the **Daml Coding Assistant Debug** channel for detailed diagnostics.

Still stuck? Reach out through the [Support Center](/support-center.md).


---

# 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/usage-and-settings.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.