fabric-cli

Fabric CLI — Connection Management

Overview

The fabric-app-data CLI manages Fabric data source connections in a fabric.yaml file. It supports multiple profiles (dev, staging, production) and generates TypeScript config that the @microsoft/fabric-app-data consumes at runtime.

Workflow

npx fabric-app-data init                     # 1. Create fabric.yaml
npx fabric-app-data add sales --from-url "https://app.fabric.microsoft.com/..."
                                     # 2. Add connections
npx fabric-app-data generate -o src/fabric.generated.ts
                                     # 3. Generate TypeScript config

Then in your app:

Config discovery

All commands except init walk up the directory tree from the current working directory until they find a fabric.yaml. This means you can run the CLI from any subdirectory of your project (e.g. from src/queries/ or a nested package) and it will pick up the project's root fabric.yaml automatically.

init is the exception — it always writes fabric.yaml to the current working directory, so run it from the project root.

Commands

npx fabric-app-data init

Create a new fabric.yaml in the current directory.

npx fabric-app-data add

Add a connection to a profile. Two modes:

From Fabric portal URL (preferred):

Explicit IDs:

Important: Use exactly these flag names. The short flags are -w and -i. The long flags are --workspace and --item. Do NOT use --workspace-id or --item-id — those do not exist.

The URL parser extracts workspace ID, item ID, and type automatically. Supported URL segments: semanticmodels, modeling, lakehouses, warehouses. "me" is accepted as workspace ID for My Workspace items.

Options:

• -p, --profile <name> — target profile (defaults to active)

npx fabric-app-data remove <alias>

Remove a connection by alias.

npx fabric-app-data list

List all connections in a profile.

npx fabric-app-data use <profile>

Switch the active profile and auto-regenerate the config file.

npx fabric-app-data generate

Generate fabric.generated.ts from the active profile.

npx fabric-app-data query

Execute a DAX query against a semantic model using the same SDK pipeline as the running app. Aliases: execute, exec.

Options:

• -q, --query <query> — inline DAX query text
• -f, --file <path> — path to a .dax file (alternative to --query)
• -l, --limit <rows> — maximum rows to return (default: 1000, max: 1000)
• -p, --profile <name> — profile name (defaults to activeProfile)

Result trimming: By default, results are capped at 1000 rows to keep output manageable. When the result is trimmed, the JSON output includes a _cliWarning field indicating how many rows were returned out of the total. This is a CLI-only limitation — the full dataset is available in the running app. If more rows are needed, refine the DAX query with filters or aggregations instead.

fabric.yaml Structure

Generated Output

fabric.generated.ts exports a plain config object:

Add fabric.generated.ts to .gitignore — regenerate from fabric.yaml as needed.