> For the complete documentation index, see [llms.txt](https://docs.nimbalyst.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nimbalyst.com/setup-nimbalyst/ai-provider-setup-and-notifications.md).

# AI Provider Setup and Notifications

### **Supported AI Providers**

Nimbalyst is meant to work with your coding agents. The following are currently supported:

* Claude Agent
* OpenAI Codex
* Claude Code CLI (opt-in)
* OpenCode (Alpha)
* GitHub Copilot (Alpha)

Alpha providers are toggled on individually from their own settings panels. See [Alpha Features](/setup-nimbalyst/alpha-features.md).

You can configure Nimbalyst to also access AI Models directly.

### OpenAI Codex

OpenAI Codex is enabled by default for new Nimbalyst installations. Existing provider choices are preserved when you upgrade.

Open **Settings > Application > OpenAI Codex** to sign in, review the discovered models, or provide an API key override. By default, Codex uses the signed-in Codex or ChatGPT subscription.

Codex sessions support the same core Nimbalyst workflow as Claude Agent:

* **Inline edit cards** — Codex `file_change` tool calls render as red/green edit cards in the transcript, matching how Claude's Edit tool already renders.
* **Slash command autocomplete** — Codex slash commands surface in the same unified `/` picker as Claude Code commands.
* **Cross-agent skills and commands** — Skills and commands written for one agent run in the other, so workflow discovery is unified across providers.
* **Reasoning blocks** — Codex reasoning items map into transcript thinking blocks.
* **Worktree isolation** — sessions started in a worktree run inside that worktree and keep their edits on its branch.

### Claude Agent

<div align="left"><figure><img src="/files/SUs9Hznjb8NgBjpSl4O9" alt="" width="563"><figcaption></figcaption></figure></div>

Claude Agent is Nimbalyst's integrated Claude coding agent. Open **Settings > Application > Claude Agent** to authenticate, choose visible models, and configure its behavior.

Use your Claude subscription login or an Anthropic API key that you explicitly add in Nimbalyst. Nimbalyst does not import API keys from environment variables.

Claude Enterprise SSO is supported when your organization provides it.

#### Claude Code CLI

The raw Claude Code CLI provider is opt-in for new installations. Turn it on from the Claude Agent settings when you specifically want the native CLI terminal experience. Upgrading does not disable it if you already selected it.

When enabled, Claude models appear under separate Claude Agent and Claude Code CLI groups in the model picker.

<figure><img src="/files/CzmBI06KiOrNnxjZKnLI" alt="Nimbalyst model picker showing the Claude Agent and Claude Code CLI groups" width="189"><figcaption></figcaption></figure>

#### Effort Level

Claude Agent and Claude Code CLI support an effort selector. Higher levels let the model spend more reasoning effort on a turn at the cost of additional latency and usage.

Pick from five levels:

* **Low**
* **Medium**
* **High**
* **Extra high**
* **Max**

The selector is part of the session controls.

#### Extended Thinking

Supported Claude Agent models also show **Extended: On** and **Extended: Off**. Extended thinking stays on by default. Turn it off per session when lower latency and token use matter more than additional reasoning.

Press **Cmd/Ctrl+Shift+M** in the chat input to open the model picker from the keyboard. Search by model name or ID, then use the arrow keys and Enter to select a model.

### OpenCode (Alpha)

OpenCode is an open-source coding agent with multi-model support — it works with Claude, OpenAI, Gemini, and local models through a unified interface.

Select **OpenCode** under **Settings > Application > OpenCode**:

1. Install the OpenCode CLI (use the **Install OpenCode CLI** button or follow the OpenCode docs).
2. Toggle **Enable OpenCode** on.
3. Optionally provide an API key — model selection and provider configuration are managed through OpenCode's own settings, so no additional configuration is required here.

<figure><img src="/files/eLCzyG7jFKghKqG1ldPg" alt=""><figcaption><p>OpenCode agent provider settings</p></figcaption></figure>

### GitHub Copilot (Alpha)

GitHub Copilot is supported as a coding agent via the ACP (Agent Communication Protocol) server mode. It uses your existing Copilot CLI login for authentication.

Select **GitHub Copilot** under **Settings > Application > GitHub Copilot**:

1. Install the Copilot CLI (`npm install -g @github/copilot`, or use the **Install Copilot CLI** button).
2. Toggle **Enable GitHub Copilot** on.
3. Authenticate by running `copilot` and using the `/login` command. Model selection is managed by Copilot — no additional API key is required.

<figure><img src="/files/geM7ihq6HZsWxxQs6AJ8" alt=""><figcaption><p>GitHub Copilot agent provider settings</p></figcaption></figure>

### Integrate other AI Models with Nimbalyst (optional)

* Nimbalyst can integrate with Anthropic, OpenAI or LM Studio for Local Models
* You must provide your API key to integrate with each
* As these are not coding agents, only some features will be supported
* For LM Studio, you must have this installed locally
* Return to **Settings > Application** to change the configuration later.

### Notification that AI response is complete

Open **Settings > Application > Notifications**.

<div align="left"><figure><img src="/files/ACVA5PLsaqvTNjdagopG" alt="" width="563"><figcaption></figcaption></figure></div>

By default:

* You are notified when an AI session completes.
* When Nimbalyst is not the active window, a system notification can appear. Clicking it takes you to the workspace and session that needs attention.
* Agents can also request an attention notification during a longer workflow.

Use the Notifications page to control these behaviors.

### Completion Sounds

Nimbalyst can also play a sound when the AI or an agent finishes a turn and is ready for you again. Find it under **Settings > Application > Notifications > Completion Sounds**.

* Turn it on with **Enable Completion Sounds**.
* Pick a built-in **Sound Type** (chime, bell, or pop), or choose **custom** to use your own audio file.
* For a custom sound, click **Choose File** and pick an audio file. Supported formats are MP3, WAV, OGG, M4A, AAC, and FLAC.
* Adjust the **Volume**, and use **Test Sound** to hear your choice.


---

# 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.nimbalyst.com/setup-nimbalyst/ai-provider-setup-and-notifications.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.
