Skip to main content

Documentation 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.

After installing the CodeFusion Studio SDK and VS Code extension, you need to tell VS Code where the SDK is installed by setting the 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).
The first two appear when the installation folder is missing or the path was not set during install. The third occurs when the extension auto-updated to a version that no longer matches the SDK installed on disk. To resolve either type of notification:
  • 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.
Clicking Choose SDK path will automatically search the default installation directories first. If your SDK is in a non-default location, you can browse to find it manually.

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

1

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
2

Search for the SDK path setting

Type cfs.sdk.path in the Settings search bar.
3

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:
C:\analog\cfs\2.2.0
Replace <username> with your system username and 2.2.0 with the version you have installed.
4

Restart VS Code

Restart VS Code for the path change to take effect.
You may need to restart VS Code after setting or changing the SDK path before CFS features become fully active.

Setting the Path via settings.json

You can also set the path directly in your VS Code settings.json file. Open the Command Palette and search for Preferences: Open User Settings (JSON), then add:
"cfs.sdk.path": "C:\\analog\\cfs\\2.2.0"

Step 2 — Understand Version Compatibility

The CFS SDK and VS Code extension must be version-compatible. CFS uses the following rules:
RuleDetails
Major versions must matchExtension 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 minorExtension 2.1.x requires SDK 2.1.x or higher. It will not work with SDK 2.0.x.
Patch versions are compatibleExtension 2.0.1 and SDK 2.0.0 are considered compatible.

Compatibility Quick Reference

Extension VersionCompatible SDK VersionsNot Compatible
X.Y.ZX.Y.* and above (same major X)X.(Y-1).*, (X-1).*, (X+1).*
To check your installed extension version, open the Extensions panel (Ctrl+Shift+X), select CodeFusion Studio, and read the version shown at the top of the details panel. If the extension auto-updated and is now ahead of your SDK, you can reinstall a specific extension version: click the gear icon next to the extension and choose Install Specific Version….

Step 3 — Access the CFS Terminal

The CFS Terminal is a preconfigured terminal session in VS Code that has cfsutil and all required toolchain paths already on PATH. This is the recommended way to run cfsutil commands without any additional environment setup.
1

Open the VS Code terminal panel

Select View > Terminal or use the keyboard shortcut Ctrl+`.
2

Open a new CFS Terminal

Click the dropdown arrow next to the + icon in the terminal panel, then select CFS Terminal from the list.
3

Verify cfsutil is available

Run the following command to confirm cfsutil is accessible and the SDK path is correctly resolved:
cfsutil --help
If 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 --help
A successful response showing the available cfsutil commands confirms that:
  • The SDK path in VS Code settings is valid
  • cfsutil is correctly installed and on PATH within 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.

Build docs developers (and LLMs) love