cfs-cli

name

cfs-cli

description

Provides guidance on using the CFSUtil command-line tool for CodeFusion Studio. USE FOR cfsutil commands, generating code from .cfsconfig files, generating workspace configuration files and creating CFS workspaces, regenerating projects in a workspace, listing, querying, or exporting SoC data models, installing and managing packages and SDKs, analyzing and querying ELF files, building, profiling, and checking compatibility of AI models, generating workspaces from AI models, updating or restoring the SoC catalog, device tree parsing, pulling Docker images, myAnalog authentication including API keys (creating, listing, and revoking a myAnalog apikey) for headless CI/CD and non-interactive login, serial port info, listing and running workspace tasks, and listing available CFS plugins (with IDs and configuration options).

CFSUtil CLI Reference

CFSUtil (cfsutil) is the CodeFusion Studio command-line utility. It provides access to CFS functionality from a terminal.

• Alias: cfs works as an alias for all cfsutil commands.
• Access: Run from the CFS Terminal in VS Code (recommended) or from the system path:
  • Windows: <CFS-Install>/Utils/cfsutil/bin/cfsutil.cmd
  • macOS/Linux: <CFS-Install>/Utils/cfsutil/bin/cfsutil
• Help: Append --help at any command level, for example, cfsutil --help, cfsutil ai --help, cfsutil ai build --help.

Important: If cfs or cfsutil commands fail, add the directory containing CFSUtil to PATH or run from the CFS Terminal. The typical directories are:

• Windows: C:/analog/cfs/<CFS_VERSION>/Utils/cfsutil/bin
• Linux: ~/analog/cfs/<CFS_VERSION>/Utils/cfsutil/bin
• macOS: ~/analog/cfs/<CFS_VERSION>/Utils/cfsutil/bin

AI commands (cfsutil ai)

Compile and manage AI models for Analog Devices embedded targets.

Windows note: Requires the Visual C++ Redistributable for Visual Studio 2015 to be installed.

Command	Description
cfsutil ai backends list	List available AI backends and supported hardware. Use -n/--name <backend> to show details for a single backend.
cfsutil ai build	Compile a model into C/C++ source using a .cfsconfig file or CLI flags.
cfsutil ai clean-cache	Clear the cache of remotely downloaded files.
cfsutil ai compat	Check model compatibility with a target SoC and core.
cfsutil ai model	Add, list, update, and remove AI models within a workspace.
cfsutil ai profile	Profile model resource usage before deployment.
cfsutil ai workspace create	Generate a workspace from an AI model file.

Common flags: --search-path / -x (additional data model directory, repeatable) — accepted by build, compat, and profile. ai workspace create uses -s instead. Not all flags apply to every subcommand.

cfsutil ai backends list              # List all backends and supported hardware
cfsutil ai backends list --name tflm  # Details for a single backend
cfsutil ai build --soc MAX32690 --core CM4 --model model.tflite
cfsutil ai compat --soc MAX32690 --core CM4 --model model.tflite
cfsutil ai profile --soc MAX32690 --core CM4 --model model.tflite

Catalog commands (cfsutil catalog)

Update or restore the local SoC metadata catalog.

cfsutil catalog update   # Update to latest online version (requires myAnalog login)
cfsutil catalog restore  # Restore the original installed version

CFS Plugins commands (cfsutil cfsplugins)

List available CFS plugins with their IDs, versions, and configuration options. Filter by SoC, board, or service type.

cfsutil cfsplugins list --soc <SOC>

Device Tree commands (cfsutil dt)

Parse and work with device tree files.

cfsutil dt parse <FILEPATH>

Docker commands (cfsutil docker)

Pull Docker images used by CFS toolchains.

cfsutil docker pull <IMAGE>          # Pull an image
cfsutil docker pull <IMAGE> -u       # Pull even if it already exists locally
cfsutil docker pull <IMAGE> -n       # Do not use credentials when pulling
cfsutil docker pull <IMAGE> -q       # Suppress pull output

ELF Utilities (cfsutil elf)

Analyze compiled ELF files.

Command	Description
cfsutil elf analyze <FILEPATH>	High-level info: platform, stack/heap, flash/SRAM sizes.
cfsutil elf info <FILEPATH> [-h] [-a] [-c] [-s]	In-depth ELF info (header, attributes, core, size). At least one of -h, -a, -c, or -s is required.
cfsutil elf memory <FILEPATH> [-s] [-t] [-y]	Symbols, sections, and segments. At least one of -s, -t, or -y is required.
cfsutil elf symbols <FILEPATH> "<SQLQUERY>"	SQL query on the symbol table (name, type, address, section, size, bind, visibility, path).

Use --format json on any ELF command for JSON output.

cfsutil elf analyze build/output.elf
cfsutil elf info build/output.elf -h -s
cfsutil elf symbols build/output.elf "SELECT name, size FROM symbols WHERE type='Function' ORDER BY size DESC LIMIT 10"

Generate command (cfsutil generate)

Generate source code from a .cfsconfig file.

cfsutil generate -i <file.cfsconfig> [-o <output-dir>] [-s <plugin-path>] [-v]

Flag	Description
-i=<file>	Required. Input .cfsconfig file.
-o=<dir>	Output directory for generated code.
-s=<path>	Additional plugin search path (repeatable).
-v	Verbose output.

cfsutil generate -i=max32690-wlp.cfsconfig -v

myAnalog Authentication (cfsutil myanalog)

Authenticate with a myAnalog account for package access and catalog updates.

cfsutil myanalog login
cfsutil myanalog logout
cfsutil myanalog status

API keys (cfsutil myanalog apikey)

API keys authenticate cfsutil without an active myAnalog session — useful in continuous integration and continuous delivery (CI/CD) and scripted environments. Set the CFS_API_KEY environment variable to the key value to use it. Creating, listing, and deleting keys require an active myAnalog session (run cfsutil myanalog login first).

Command	Description
cfsutil myanalog apikey create	Create an API key. The key value appears once — save it immediately. Flags: --description <value> (optional label), --format json|text.
cfsutil myanalog apikey list	List API keys with the ID, masked value, and expiration date of each key. Flag: --format json|text.
cfsutil myanalog apikey delete <APPKEY>	Delete an API key by ID (shown in apikey list). Flag: --format json|text.

cfsutil myanalog apikey create --description "CI pipeline key"
cfsutil myanalog apikey list
cfsutil myanalog apikey delete apikey_01234567890abcdef

Set CFS_API_KEY to use a key without an interactive login. The syntax is shell-specific:

# bash/zsh
export CFS_API_KEY="<your-api-key>"
cfsutil catalog update

# PowerShell
$env:CFS_API_KEY = "<your-api-key>"
cfsutil catalog update

:: Command Prompt
set "CFS_API_KEY=<your-api-key>"
cfsutil catalog update

Commands that support API key authentication include catalog update, ai build, docker pull, and package manager (pkg) commands.

Package Manager (cfsutil pkg)

Install and manage SDKs, plugins, and toolchains.

Command	Description
cfsutil pkg add-remote <name> <url>	Register a new package server.
cfsutil pkg auth-remote <name>	Configure username/password authentication or no authentication (--user, optional --password, or --none).
cfsutil pkg delete <pattern>	Delete packages from the local cache (wildcard * supported).
cfsutil pkg delete-remote <name>	Remove a registered remote.
cfsutil pkg dependencies <ref>	List a package's dependencies, including transitive ones. Flags: -u (unresolved requirements), --local (local cache only).
cfsutil pkg disable-remote <name>	Disable a registered remote without removing it.
cfsutil pkg enable-remote <name>	Re-enable a previously disabled remote.
cfsutil pkg info <ref>	Show package metadata without installing. Supports -f json.
cfsutil pkg install <package>	Install a package and its dependencies.
cfsutil pkg list [pattern]	List installed packages. Filter with -f KEY=VALUE (repeatable).
cfsutil pkg list-cache [pattern]	List packages in the local cache. Supports --format json.
cfsutil pkg list-remotes	List registered remotes and their auth configuration.
cfsutil pkg local-consumers <name>	List installed packages that depend on a given package.
cfsutil pkg search <pattern>	Search remotes for packages available to install.
cfsutil pkg uninstall <name>	Uninstall a package (remains in the local cache for reuse).

cfsutil pkg auth-remote myserver --user <USERNAME>   # prompts for password if --password is omitted
cfsutil pkg auth-remote myserver --none              # no authentication
cfsutil pkg install <package-name>/<version>

Plugins commands (cfsutil plugins)

Extend CFSUtil with additional oclif CLI plugins.

Port command (cfsutil port)

List information about active serial ports.

cfsutil port list

Project command (cfsutil project)

Regenerate projects defined in an existing .cfsworkspace file.

cfsutil project create -w <path/.cfsworkspace> -p <project-name> [-s <plugin-path>]

Flag	Description
-w=<path>	Required. Path to the .cfsworkspace file.
-p=<name>	Required. Name of the project to regenerate (must match the Name field in the workspace JSON).
-s=<path>	Additional plugin/data-model search path (repeatable).

Note: The workspace must already exist. This command regenerates existing projects; it cannot create new ones. The Projects array must be populated.

cfsutil project create -w /path/to/workspace/.cfs/.cfsworkspace -p "Arm Cortex-M4F"

SoCs commands (cfsutil socs)

List and query SoC data models.

Command	Description
cfsutil socs list	List all available SoCs. Supports -f json, -v, -s <search-path>.
cfsutil socs info <SOC>	Details for a specific SoC. Flags: --boards, --cores, --packages, --docs, --format json.
cfsutil socs export <SOCNAME>	Export the SoC data model as JSON. Flags: -p <package>, -o <file>, -i <indent>, -m (minify), --gzip, -v <version>.

cfsutil socs list -f json
cfsutil socs info MAX32690 --boards --packages --cores
cfsutil socs export max32690 -p WLP -o model.json

Tasks commands (cfsutil tasks)

List and run tasks defined for a CFS workspace. The --workspace flag defaults to the current directory, so bare commands only work when run from a generated workspace (or one of its project directories). Pass --workspace explicitly to run from anywhere.

Command	Description
cfsutil tasks list	List tasks for a workspace. Flags: -w/--workspace, -p/--project, -v (also show each task's command).
cfsutil tasks run <task>	Run a task by label. Flags: -w/--workspace, -p/--project, -v, -c/--capture (capture serial output; requires --port and --project), --port, -z/--zephyrTraceFile.

cfsutil tasks list                                   # uses the current directory as the workspace
cfsutil tasks list --workspace <path>                # specify the workspace explicitly
cfsutil tasks run build                              # run the "build" task from the current directory
cfsutil tasks run build -w <path> -p <project>      # run within a specific workspace/project
cfsutil tasks run flash_run_JLink -w <path> -p <project> --capture --port COM4

Workspace commands (cfsutil workspace)

Create a CFS workspace either in two steps — generate a workspace configuration file, then create the workspace from it — or in a single workspace create call that takes the parameters directly (see One-step alternative below).

Step 1 — Discover SoC details

cfsutil socs list                                    # Find SoC name and packages
cfsutil socs info <SOC> --boards --packages --cores  # Find board, package, and core values
cfsutil cfsplugins list --soc <SOC>                  # Find template IDs

Step 2 — Generate a workspace configuration file

cfsutil workspace configure \
  --soc <SOC> --board <BOARD> \
  --core <CORE> --template-id <TEMPLATE_ID> \
  --name <workspace-name> -o <output-path>

Specify the target with --board, --package, or both — at least one is required. With --board <BOARD>, the package is inferred from the board; with --package <PACKAGE>, the target is identified directly. Supplying both is also valid and is used together for template validation:

cfsutil workspace configure \
  --soc <SOC> --package <PACKAGE> \
  --core <CORE> --template-id <TEMPLATE_ID> \
  --name <workspace-name> -o <output-path>

For multi-core projects, repeat --core/--template-id pairs:

cfsutil workspace configure \
  --soc ADSP-SC835 --board ADSPSC835-EV-SOM \
  --core FX --template-id com.analog.project.sharcfx.plugin \
  --core CM33 --template-id com.analog.project.sharcfx.plugin \
  --name myNewWorkspace -o /path/to/output

Step 3 — Create the workspace

cfsutil workspace create -i <workspace-config.json>

One-step alternative — create directly from command-line arguments

workspace create also accepts the workspace parameters directly, skipping the separate configure step. Use this when you do not need a reusable .cfsworkspace config file:

cfsutil workspace create \
  --soc <SOC> --board <BOARD> \
  --template-id <TEMPLATE_ID> --template-version <VERSION> \
  --name <workspace-name> -o <output-path>

--soc, --board, --template-id, --name, and -o/--output are all required for the one-step form. --package is optional — it is inferred from the SoC and board when omitted. This form is mutually exclusive with -i/--input: pass the parameters directly for a new workspace, or pass -i for the two-step flow, but not both. Unlike workspace configure, create takes a single workspace-level template and has no --core flag; use the two-step flow for multi-core projects.

Flag	Description
-i/--input=<path>	Path to an existing .cfsworkspace file (the two-step flow above).
-o/--output=<path>	Output path for the new workspace (excluding the workspace name).
--name=<value>	Name for the new workspace.
--soc=<value>	SoC name.
--board=<value>	Board name.
--package=<value>	Package name.
--template-id=<value>	Template ID.
--template-version=<value>	Template version.
-s/--search-path=<path>	Additional search path for templates and data models (repeatable).

Example:

cfsutil workspace create -o /tmp --name myNewWorkspace \
  --soc ADSP-SC835 --board ADSPSC835-EV-SOM \
  --template-id com.analog.sharcfx.example --template-version 1.0.1

Working with multiple .cfsconfig files

When multiple .cfsconfig files exist in .cfs/, auto-discovery can select the wrong file. Pass --config <path> where supported. For commands without --config, keep alternate configurations outside .cfs/ or give them names that do not end in .cfsconfig, then copy the desired configuration to .cfs/<soc>-<package>.cfsconfig before running the command.