Skip to main content

Install in Visual Studio Code

Visual Studio Code is the primary supported IDE for SF Veritas, with full marketplace support.

Prerequisites​

  • Visual Studio Code version 1.74.0 or higher

Method 1: Search in VS Code​

  1. Open Visual Studio Code
  2. Open the Extensions view:
    • Click the Extensions icon in the Activity Bar, or
    • Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (macOS)
  3. Search for "SF Veritas"
  4. Click Install on the "SF Veritas" extension by Sailfish AI
  5. The extension will activate automatically
  1. Visit the SF Veritas Marketplace Page
  2. Click Install
  3. Allow VS Code to open and install the extension

Method 3: Command Line​

code --install-extension sailfish-ai.sf-veritas-extension

Alternative: Install from VSIX​

If you need to install from a VSIX file (e.g., for offline installation or a specific version):

  1. Download the VSIX file from Open VSX
  2. In VS Code, open the Extensions view (Ctrl+Shift+X / Cmd+Shift+X)
  3. Click the ... (More Actions) button
  4. Select "Install from VSIX..."
  5. Navigate to and select the downloaded VSIX file
  6. Click Install and reload when prompted

Or via command line:

code --install-extension /path/to/sf-veritas-extension-x.x.x.vsix

Verify Installation​

  1. Look for the SF Veritas icon in the Activity Bar (left sidebar)
  2. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  3. Type "SF Veritas" and verify you see these commands:
    • SF Veritas: Show Console Logs
    • SF Veritas: Show Flamechart
    • SF Veritas: Start Local Server

Configuration​

After installation, you can configure the extension through VS Code settings:

  1. Open Settings (Ctrl+, / Cmd+,)
  2. Search for "SF Veritas"
  3. Key settings include:
    • Local Mode: Enable/disable the local telemetry server (default: enabled)
    • Auto Start Server: Automatically start the server when VS Code opens (default: enabled)
    • Local Server Port: Port for the telemetry server (default: 6776)

Troubleshooting​

Extension not appearing after installation​

  1. Fully close and reopen VS Code
  2. Check the Extensions view to ensure SF Veritas is listed and enabled
  3. Check the Output panel (View → Output) and select "SF Veritas" for any error messages

Port 6776 already in use​

If another application is using port 6776:

  1. Open VS Code Settings
  2. Search for sfVeritas.localServerPort
  3. Change to an available port (e.g., 6777)
  4. Restart the local server via Command Palette: SF Veritas: Restart Local Server
Using Desktop App?

If you're also using the SF Veritas Desktop App, you cannot run both simultaneously. The Desktop App will automatically stop the VS Code extension's server when it starts.

To avoid conflicts, disable the extension's auto-start:

  1. Open VS Code Settings
  2. Search for sfVeritas.autoStartServer
  3. Uncheck the setting

See Desktop Application - Migrating from VS Code Extension for more details.

Next Steps​