Skip to content

VS Code Extension

The Synthesize extension adds rich language support for .synth files.

Features

  • Syntax highlighting for the .synth format
  • Snippets for common test patterns
  • Validation on save — catch structural problems before generating
  • Commands (Command Palette):
  • Synthesize: Generate Robot Tests
  • Synthesize: Run Tests
  • Synthesize: Preview Suite
  • Synthesize: Sign In
  • Keyboard shortcuts (active in .synth files):
  • Generate: Cmd+Shift+G (macOS) / Ctrl+Shift+G
  • Run: Cmd+Shift+R (macOS) / Ctrl+Shift+R

The extension activates automatically when you open a .synth file or a workspace containing synth.yaml.

Install

code --install-extension synthesize-ai.vscode-synthesize

Or search Synthesize in the VS Code Extensions panel.

Settings

Setting Default Purpose
synth.cliPath synth Path to the synthesize CLI executable
synth.autoValidate true Validate .synth files on save
synth.previewOnSave false Auto-refresh the preview panel on save
synth.defaultOutputDir (empty) Default output directory for generated files

Requirements

The extension shells out to the CLI for generation and execution, so install the CLI first:

pip install synthesize-ai

If the synthesize command isn't on your PATH, point synth.cliPath at it.