The Catalog Manager is a background service in CodeFusion Studio that retrieves and maintains the SoC catalog — a structured collection of metadata for every Analog Devices processor and microcontroller supported by CFS. This catalog underpins key features such as the System Planner and workspace creation, supplying up-to-date information on documentation links, processor cores, supported boards, and package configurations. Keeping the catalog current ensures that newly released ADI devices and updated SoC configurations are immediately available in the IDE.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.
What the SoC catalog contains
The SoC catalog is a set of JSON data models (provided by thecfs-data-models package) that describe the hardware characteristics of every supported ADI SoC. Each entry in the catalog covers:
Documentation
Links to datasheets and reference manuals for each supported SoC.
Processor cores
Core architecture details for the device, including Arm, RISC-V, and DSP cores.
Supported boards
Evaluation kits and development boards associated with the SoC.
Package configurations
Physical package types and pin configurations available for the device.
Catalog storage locations
The Catalog Manager maintains two copies of the catalog:| Copy | Location | Purpose |
|---|---|---|
| Backup (install-time) | <install_dir>/Data/SoC/catalog.zip | The original catalog bundled with your CFS installation. Used as the restore point. |
| Working copy | <${userHome}>/cfs/<cfs_version_number>/.catalog | The active catalog used by CFS at runtime. Updated online or via cfsutil. |
The working copy location can be overridden with the
cfs.catalogManager.catalogLocation VS Code setting. If you change this setting, ensure the specified directory is writable.CFS settings
The Catalog Manager exposes two configurable settings in VS Code:| Setting | Key | Description |
|---|---|---|
| Offline Mode | cfs.catalogManager.checkForUpdates | When enabled, CFS uses the most recently cached catalog data and does not attempt to contact the update service. Use this when working without an internet connection. |
| Catalog Location | cfs.catalogManager.catalogLocation | Overrides the default working copy directory for the catalog. Useful when the default home directory path is not suitable for your environment. |
Updating the catalog
Run the following command to download the latest SoC catalog from the Analog Devices cloud service and replace the current working copy:When to update
After upgrading CodeFusion Studio
After upgrading CodeFusion Studio
A new CFS release may bundle a newer catalog backup, but the cloud version may be ahead of the installer. Run
cfsutil catalog update after upgrading to ensure you have the very latest SoC data.When new SoC support is released
When new SoC support is released
Analog Devices regularly adds new microcontrollers and DSPs to the catalog. If you are targeting a device that does not appear in the System Planner or workspace creation dialog, update the catalog to pick up newly added SoC definitions.
When board or package information changes
When board or package information changes
Catalog updates can include revised documentation links, corrected package configurations, or new evaluation board listings for existing SoCs. Updating ensures this information is current in your local installation.
Restoring the catalog
If the working catalog becomes corrupted, or if you want to revert to the version that shipped with your CFS installation, run:<install_dir>/Data/SoC/catalog.zip.
Troubleshooting
| Error | Possible cause | Resolution |
|---|---|---|
Catalog Manager failed to initialize with error: [message] | The catalog ZIP is missing or cfs.catalogManager settings are misconfigured. | Verify that <install_dir>/Data/SoC/catalog.zip exists. Check whether cfs.catalogManager.catalogLocation has been changed. Restore correct settings and restart CodeFusion Studio. |
Failed to get catalog: [error details] | The Catalog Manager could not fetch the catalog from the cloud. | Check your internet connection. If the cloud service is unavailable, enable Offline Mode in CFS settings. If the problem persists, delete the .catalog folder and restart CodeFusion Studio. |
For details on configuring VS Code settings in CodeFusion Studio, refer to the CFS Settings documentation.