After installing the CodeFusion Studio SDK and VS Code extension, you need to tell VS Code where the SDK is installed by setting theDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/analogdevicesinc/codefusion-studio/llms.txt
Use this file to discover all available pages before exploring further.
cfs.sdk.path configuration key. Without a valid SDK path, the extension cannot locate toolchains, plugins, or cfsutil, and most CFS features will be unavailable. This page explains how to set the path, what the compatibility rules between SDK and extension versions mean in practice, how to open the CFS Terminal, and how to verify that everything is working before you start your first project.
Step 1 — Set the CFS SDK Path
When you first launch VS Code after installing CFS, or after upgrading from an earlier version, you may see a notification indicating that the SDK path is missing or incompatible.If a Notification Appears
You may see one of these messages:Error verifying the CFS SDK version…The path to the CFS SDK is missing or not valid…The selected CFS SDK (vX.Y.Z) is not compatible with the extension (vA.B.C).
- Click Download SDK to install the correct SDK version if it is not already on your machine, or
- Click Choose SDK path to browse to a valid, compatible SDK directory.
If No Notification Appears
If no notification appeared, your SDK path is likely already valid and the versions are compatible. No further action is required — but you can still verify or change the path manually at any time using the steps below.Manually Set the SDK Path
Open VS Code Settings
Open Settings using one of these methods:
- Select File > Preferences > Settings (on macOS: Code > Settings > Settings)
- Open the Command Palette (
Ctrl+Shift+P/⇧⌘P) and search for Preferences: Open Settings (UI) - Use the keyboard shortcut:
Ctrl+,on Windows/Linux,⌘,on macOS
Set the path to your SDK installation
Enter the full path to the directory where CFS is installed. Use the values for your OS below:Replace
- Windows
- macOS
- Linux
<username> with your system username and 2.2.0 with the version you have installed.Setting the Path via settings.json
You can also set the path directly in your VS Codesettings.json file. Open the Command Palette and search for Preferences: Open User Settings (JSON), then add:
- Windows
- macOS
- Linux
Step 2 — Understand Version Compatibility
The CFS SDK and VS Code extension must be version-compatible. CFS uses the following rules:| Rule | Details |
|---|---|
| Major versions must match | Extension 2.x.x requires SDK 2.x.x. An extension at version 2.x.x will not work with a 1.x.x or 3.x.x SDK. |
| SDK minor must be ≥ extension minor | Extension 2.1.x requires SDK 2.1.x or higher. It will not work with SDK 2.0.x. |
| Patch versions are compatible | Extension 2.0.1 and SDK 2.0.0 are considered compatible. |
Compatibility Quick Reference
| Extension Version | Compatible SDK Versions | Not Compatible |
|---|---|---|
| X.Y.Z | X.Y.* and above (same major X) | X.(Y-1).*, (X-1).*, (X+1).* |
Step 3 — Access the CFS Terminal
The CFS Terminal is a preconfigured terminal session in VS Code that hascfsutil and all required toolchain paths already on PATH. This is the recommended way to run cfsutil commands without any additional environment setup.
Open a new CFS Terminal
Click the dropdown arrow next to the
+ icon in the terminal panel, then select CFS Terminal from the list.Verify cfsutil is available
Run the following command to confirm If
cfsutil is accessible and the SDK path is correctly resolved:cfsutil responds with its help output, your environment is correctly configured. If it returns a “command not found” error, double-check the cfs.sdk.path setting and restart VS Code.To run
cfsutil from a system terminal outside VS Code, use the following platform-specific executable path directly:- Windows:
<CFS-Install>\Utils\cfsutil\bin\cfsutil.cmd - Linux/macOS:
<CFS-Install>/Utils/cfsutil/bin/cfsutil
Step 4 — Verify Your Installation
With the SDK path set and the CFS Terminal open, run a quick check to confirm the full environment is healthy:cfsutil commands confirms that:
- The SDK path in VS Code settings is valid
cfsutilis correctly installed and onPATHwithin the CFS Terminal- The extension and SDK versions are compatible
What to Do Next
With CFS configured, you are ready to install SDK packages and create your first workspace.Package Manager
Install SDKs, toolchains, and plugins on demand with the CFS Package Manager. Required before creating a workspace.
ADI Developer Resources
Full user guide including workspace creation, System Planner, AI Tools, and debugging documentation.