Skip to main content

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.

TermMate doesn’t run its own models locally. Instead, it connects to powerful CLI-based agents. You need to install at least one of these to begin. Claude Code is Anthropic’s official terminal-based coding agent. It is currently the most capable agent supported by TermMate.
npm install -g @anthropic-ai/claude-code
After installation, run claude in your terminal once to authenticate and complete the setup.

2. Install Codex CLI

Codex is OpenAI’s state-of-the-art coding companion. TermMate communicates with it via the codex app-server.
  1. Install the Codex CLI (refer to the official OpenAI documentation for your platform).
  2. Ensure codex is available in your system PATH.

3. Loading Agent CLI

Once installed, TermMate will automatically attempt to locate these binaries. You can also manually specify their paths in the plugin settings if you have a custom installation.

4. Install TermMate

With your agents ready, install TermMate for your editor:

Sublime Text

The easiest way to install TermMate is through Package Control:
  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.

VS Code

Install TermMate from the Visual Studio Code Marketplace: marketplace.visualstudio.com → TermMate Or search TermMate directly in the VS Code Extensions panel (Cmd+Shift+X).

5. Start Your First Chat

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

VS Code

Option A — Status Bar Click the TermMate item in the VS Code status bar (bottom of the window) to instantly open a new chat session. Option B — Command Palette
  1. Open the Command Palette (Cmd+Shift+P).
  2. Run TermMate: Start Chat.
Either way, select your agent (Claude or Codex) and a chat tab will open in your editor.

Sublime Text

  1. Open the Command Palette (Cmd+Shift+P).
  2. Run TermMate: Start Chat.
  3. The chat view opens as a native tab. Type your message and press Ctrl+Enter to send.
TermMate automatically sets the working directory to your current project root. The agent can read, edit, and run commands within that scope.