Skip to main content

​
Overview

The Sphinx extension is available from multiple sources depending on which editor you use. This guide covers installation for VS Code, Cursor, and other VS Code-compatible editors.

​
Requirements

Before installing Sphinx, ensure you have:
  • VS Code 1.96.0 or later (or a compatible editor like Cursor)
  • Python 3.8+ installed
  • A Jupyter kernel (the extension will guide you if one isn’t available)
The Microsoft Jupyter extension (ms-toolsai.jupyter) is automatically installed as a dependency when you install Sphinx.

​
VS Code Marketplace

For users of Visual Studio Code:
1

Open VS Code

Launch Visual Studio Code on your computer.
2

Open the Extensions view

Click the Extensions icon in the Activity Bar, or press Cmd+Shift+X (macOS) / Ctrl+Shift+X (Windows/Linux).
3

Search for Sphinx

Type “Sphinx” in the search box and look for Sphinx by sphinx.
4

Install the extension

Click the Install button.
Direct link: Sphinx on VS Code Marketplace

​
Quick Install via Command Line

You can also install directly from the terminal: 
code --install-extension sphinx.sphinx-code

​
Open VSX Registry

For users of Cursor, Windsurf, or other editors that use the Open VSX Registry:
1

Open your editor

Launch Cursor, VS Codium, or your preferred VS Code-compatible editor.
2

Open the Extensions view

Click the Extensions icon in the Activity Bar, or use the keyboard shortcut (Cmd+Shift+X / Ctrl+Shift+X).
3

Search for Sphinx

Type “Sphinx” in the search box.
4

Install the extension

Click Install on the Sphinx extension.
Direct link: Sphinx on Open VSX

​
Manual Installation (VSIX)

If you need to install from a .vsix file (for air-gapped environments or specific versions):
1

Download the VSIX file

Obtain the .vsix file from your organization or the Sphinx team.
2

Open VS Code

Launch VS Code or your compatible editor.
3

Install from VSIX

Open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) and run:
Extensions: Install from VSIX...
4

Select the file

Navigate to and select your .vsix file.
5

Reload

Reload the window when prompted.

​
Command Line VSIX Installation

code --install-extension path/to/sphinx-code-x.x.x.vsix
For Cursor: 
cursor --install-extension path/to/sphinx-code-x.x.x.vsix

​
Verify Installation

After installation, verify Sphinx is working:
  1. Open or create a Jupyter notebook (.ipynb file)
  2. Look for the Sphinx icon in the Activity Bar (left sidebar)
  3. Press Cmd+T (macOS) or Ctrl+T (Windows/Linux)
  4. The Sphinx chat panel should open
If you see the Sphinx panel and can sign in, the installation was successful!

​
Sign In

After installing, you’ll need to sign in to use Sphinx:
  1. Open the Sphinx panel (Cmd+T / Ctrl+T)
  2. Click Sign In
  3. Authenticate with your Sphinx account in the browser
  4. Return to your editor—you’re ready to go!
Don’t have an account? Visit sphinx.ai to sign up.

​
Troubleshooting

  1. Reload the VS Code window (Cmd+Shift+P → “Reload Window”)
  2. Check that the extension is enabled in the Extensions view
  3. Ensure you’re running VS Code 1.96.0 or later
Install it manually:
code --install-extension ms-toolsai.jupyter
Or search for “Jupyter” in the Extensions view and install the Microsoft Jupyter extension.
  1. Check your internet connection
  2. Try signing out and back in (Command Palette → “Sphinx: Log Out”)
  3. Clear your browser cookies for the Sphinx auth domain
  4. Contact [email protected] if issues persist
The Cmd+T / Ctrl+T shortcut might conflict with other extensions. You can:
  1. Open the Command Palette and run “Sphinx: Open Chat”
  2. Or rebind the shortcut in VS Code’s Keyboard Shortcuts settings
Sphinx requires network access to:
  • api.prod.sphinx.ai — API requests
  • Auth0 authentication endpoints
Contact your IT team to allowlist these domains if you’re behind a corporate firewall.

​
Updating Sphinx

Extensions typically update automatically. To manually check for updates:
  1. Open the Extensions view
  2. Click the … menu (top-right of the Extensions panel)
  3. Select Check for Extension Updates
Or from the Command Palette: “Extensions: Check for Extension Updates”

​
Uninstalling

To remove Sphinx:
  1. Open the Extensions view
  2. Find Sphinx in your installed extensions
  3. Click Uninstall
  4. Reload when prompted
Command line: 
code --uninstall-extension sphinx.sphinx-code