> ## Documentation Index
> Fetch the complete documentation index at: https://termmate.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started

> Install the TermMate extension in Sublime Text or VS Code, start a chat session, and select Claude Code or Codex as your active agent.

Once you have set up the prerequisite agent CLIs, you are ready to install TermMate in your favorite editor and start chatting.

## 1. Install TermMate

### Sublime Text

<img src="https://mintcdn.com/termmate/eAR6DMESBKxwyRGr/images/command-palette.png?fit=max&auto=format&n=eAR6DMESBKxwyRGr&q=85&s=de2d0fef8a55e64878230350173eafa8" alt="Install TermMate via Package Control" width="950" height="444" data-path="images/command-palette.png" />

Install TermMate via [Package Control](https://packagecontrol.io/packages/TermMate):

1. Open the Command Palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows/Linux).
2. Type `Package Control: Install Package` and press `Enter`.
3. Search for `TermMate` and press `Enter`.

<img src="https://mintcdn.com/termmate/eAR6DMESBKxwyRGr/images/package-control-install.png?fit=max&auto=format&n=eAR6DMESBKxwyRGr&q=85&s=215ed55d5c615cd48df079c40d27bd0f" alt="Select Install Package" width="950" height="444" data-path="images/package-control-install.png" />

<img src="https://mintcdn.com/termmate/eAR6DMESBKxwyRGr/images/package-control-termmate.png?fit=max&auto=format&n=eAR6DMESBKxwyRGr&q=85&s=5e74894c92209b126713053e2fa6efb8" alt="Search TermMate" width="950" height="444" data-path="images/package-control-termmate.png" />

### VS Code

Install TermMate from the Visual Studio Code Marketplace:

[marketplace.visualstudio.com → TermMate](https://marketplace.visualstudio.com/items?itemName=termmate-app.termmate-vs)

Or search **TermMate** directly in the VS Code Extensions panel (`Cmd+Shift+X`).

<img src="https://mintcdn.com/termmate/eAR6DMESBKxwyRGr/images/vs-ext-termmate.png?fit=max&auto=format&n=eAR6DMESBKxwyRGr&q=85&s=fcc1cc942085f5d673508e3f273b9088" alt="Search TermMate in VS Code" width="950" height="444" data-path="images/vs-ext-termmate.png" />

## 2. Start Chat

Once TermMate is installed, open a chat session from within your editor.

### Sublime Text

<img src="https://mintcdn.com/termmate/jE_tIGJ00l8pA6Fq/images/termmate-command.png?fit=max&auto=format&n=jE_tIGJ00l8pA6Fq&q=85&s=534891ee49bae0cf96a41f5111cc7207" alt="Run TermMate: Start Chat" width="950" height="444" data-path="images/termmate-command.png" />

* Open the Command Palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows/Linux).
* Type `TermMate: Start Chat` and press `Enter`.
* A new view will open for the TermMate chat.
* Type your message and press `Cmd+Enter` (macOS) or `Ctrl+Enter` (Windows/Linux) to send.

<img src="https://mintcdn.com/termmate/jE_tIGJ00l8pA6Fq/images/termmate-chatview.png?fit=max&auto=format&n=jE_tIGJ00l8pA6Fq&q=85&s=018b652faa42181c62d878300d73f087" alt="TermMate Chat View" width="1200" height="687" data-path="images/termmate-chatview.png" />

### VS Code

You can start a chat session in two ways:

* **Status Bar**: Click the **TermMate** item in the bottom status bar.
* **Command Palette**: Open the Command Palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows/Linux) and run `TermMate: Start Chat`.

## 3. Select Agent

When initiating a chat session, TermMate presents a native selector interface to choose your preferred underlying AI agent:

* **Sublime Text**: You can switch your active agent by clicking the **Agent button located directly above the chat input area** inside the chat view tab. This opens a selection list panel to choose your desired agent.
* **VS Code**: You can select or switch your active agent directly via the **dropdown menu located at the bottom of the chat input area** inside the Webview tab. Additionally, the bottom editor **Status Bar** displays the current active agent and model.

### Supported Agents

* **Claude Code**: Powered by Anthropic's terminal agent. Highly recommended for advanced reasoning, complex multi-file generation, and deep workspace context understanding.
* **Codex**: Powered by OpenAI's coding companion. Excellent for precise low-latency edits and interactive codebase exploration.

<Tip>
  TermMate automatically sets the working directory to your current project root. The agent can read, edit, and run commands within that scope.
</Tip>
