Getting Started

Positron Assistant supports Anthropic Claude for chat and GitHub Copilot for code completions and chat.

We’re actively expanding provider support and welcome your feedback and issue reports!

Step 1: Enable Positron Assistant

  1. Enable the setting positron.assistant.enable.
  2. Restart Positron or run the Developer: Reload Window command in the Command Palette.

Step 2: Configure language model providers

Currently, we support Anthropic and GitHub Copilot for sidebar chat and inline chat. At this time, only GitHub Copilot is available for inline code completions.

Important

Positron Assistant requires a Claude Console account with API access. See Anthropic’s Claude API and Console documentation for more information.

Positron Assistant does not support logging into Anthropic with the Claude Pro Plan, Max Plan, or other Claude subscription plans.

How to get an Anthropic API key

To use Anthropic’s Claude models in Positron Assistant, you need to bring your own API key (BYOK). To obtain an API key from Anthropic:

  1. Log in to or create an account for Anthropic’s Claude Console.
  2. Navigate to the API keys management page.
  3. Click the Create Key button.
  4. Fill out any required information and click Add to generate your API key.
  5. Copy and save the API key to a password manager or another secure location.

Add Anthropic as a language model provider

  1. Run the command Positron Assistant: Configure Language Model Providers

  2. Select Anthropic as the model provider.

    Anthropic selected in Provider modal

    Anthropic selected in Provider modal

  3. Paste your Claude Console API key into the input field and click Sign in.

Important

Positron Assistant requires a GitHub account with Copilot enabled.

How to get GitHub Copilot access

GitHub Copilot is a proprietary tool from GitHub. If you want to use GitHub Copilot, you need a subscription for GitHub Copilot in your personal GitHub account or to be assigned a seat by an organization with a subscription for GitHub Copilot for Business.

Students and faculty can use GitHub Copilot for free as part of the GitHub Education program. For more information, see the GitHub Education page.

Add GitHub Copilot as a language model provider

  1. Run the command Positron Assistant: Configure Language Model Providers

  2. Select GitHub Copilot as the model provider.

    GitHub Copilot selected in Provider modal

    GitHub Copilot selected in Provider modal

  3. Click the Sign in button to initiate GitHub’s OAuth authentication flow.

    • Complete the authentication flow in your browser, and return to Positron when finished.
Tip

If you are using Positron with a remote SSH session, you will need to authenticate to GitHub on the remote server as well. Follow along on GitHub as we make improvements in this area.

Step 3: Use Positron Assistant!

Once you’ve authenticated with at least one language model provider, you’re all set to use Positron Assistant.

  1. Click on the chat robot icon in the sidebar, or run the command Chat: Open Chat in the Command Palette to open the chat:

    Assistant Sidebar Icon

    Assistant Sidebar Icon

  2. Chat with Assistant by typing your question or request in the chat input box at the bottom of the chat pane, then pressing or the send button.

To learn more about Positron Assistant’s core features, check out the following guides: