Table of Contents

Command Reference

  • 2026-05-06
  • Peer Grønnerup
Applies to:
  • ❌ Tabular Editor 2
  • ❌ Tabular Editor 3
  • ✔ Tabular Editor CLI
Important

The Tabular Editor CLI is in Limited Public Preview. It is offered for evaluation with a Tabular Editor account; no license is required during preview. Commands, flags, and outputs may change before general availability. The preview build stops functioning after 2026-09-30. We recommend against using the CLI in production CI/CD pipelines during preview. Please refer to our [license agreement](TBD: ADD LINK TO EULA)

This page gives a short description and one example per command. Every command accepts --help for exhaustive flag documentation:

te <command> --help
te <command> <subcommand> --help
Note

During preview, the CLI's --help output is the authoritative reference for flags and options. The content on this page is hand-curated and will lag --help for anything added between preview releases.

Object path syntax

Most commands accept object paths of the form:

  • Sales — a table.
  • Sales/Revenue — a measure or column.
  • Sales/Measures — a sub-container inside a table (Measures, Columns, Partitions, Hierarchies).
  • Relationships, Roles, Perspectives, Cultures — model-level containers.

Paths are consistent across te get, te set, te add, te rm, te mv, te find, te replace, and te ls.

Global options

These flags are available on every command and sit before or after the subcommand name.

Option Description
-m, --model <path> Path to semantic model (TMDL folder, .bim file, or TE folder).
-s, --server <endpoint> Workspace name or endpoint (e.g., MyWorkspace, powerbi://..., asazure://..., localhost).
-d, --database <name> Semantic model name on the workspace.
--local Connect to a locally running Power BI Desktop instance (Windows only).
--auth <method> Auth method: auto, interactive, spn, env, managed-identity (default: auto).
--output <format> Output format: auto, text, json, csv (default: auto — text for TTY, JSON for pipes).
--recent [N] Use a recently used model. No value = interactive picker; N = Nth most recent (1 = last used).
--non-interactive Disable all interactive prompts. Fail with an actionable error if required input is missing.
--debug Enable debug logging to stderr (connection strings, auth flow, timing).

For commands that read a model, the resolution order is: positional <model> argument → --model global flag → --server/--database (remote) → active connection from te connect → --recent.

Model I/O

load

Load a semantic model and display a summary.

te load ./model                            # TMDL folder
te load model.bim                          # BIM file
te load -s MyWorkspace -d MyModel          # Remote workspace

save

Save a model to disk. Use it to write a remote workspace model to local files, convert formats, or persist edits back to the source.

  • -o, --output-path <path> — target file or folder. Optional — when omitted, te save writes back to the source location, preserving the original format.
  • --format <fmt> — tmdl, bim, te-folder, pbip, database.json. Defaults to inferring from the loaded model (BIM source → BIM, TMDL SemanticModel/ → TMDL under definition/).
  • --force — skip validation and overwrite existing output. Some refusals (ambiguous containers, multi-SemanticModel project roots) fire even under --force.
  • --skip-bpa / --fix-bpa — bypass or auto-fix the BPA gate.
  • --skip-validation — skip DAX semantic analysis and validation for fast passthrough downloads.
  • --supporting-files — generate Fabric supporting files (.platform, definition.pbism).
te save                                    # Save back to source (no -o needed)
te save ./model.bim -o ./tmdl-out          # Convert BIM to TMDL
te save -o ./project --format pbip         # Save as a PBIP project
te save -o ./out -s my-workspace -d my-model --skip-validation   # Fast download
Tip

Use te save -o <path> -s <workspace> -d <model> to download a remote model to disk. Pair with --skip-validation for the fastest passthrough when you only need the bytes (no DAX semantic analysis).

open

Open a model in Tabular Editor 3 Desktop (requires TE3 to be installed).

te open ./my-model

init

Create a new empty semantic model at the given path.

te init ./new-model

Model editing

set

Set a property on a model object.

  • -q <property> — property name (e.g., expression, formatString, description, isHidden).
  • -i <value> — value (use - to read from stdin).
  • --save / --save-to <path> — persist changes.
te set Sales/Amount -q expression -i "SUM(Sales[Amt])" --save
te set Sales -q isHidden -i true --save

add

Add an object to the model. Pass the object path and the type via -t / --type. Relationships keep their shorthand syntax (Sales[Key]->Dim[Key]).

  • -t, --type <type> — object type. Common values: Table, Measure, Column, CalculatedColumn, Hierarchy, Role, Perspective, Culture, CalculationGroup, CalculationItem. Tab-completion is supported; full list in te add --help.
  • --if-not-exists — exit 0 without error if the object already exists. Use this for idempotent CI/CD pipelines.
te add Sales/Revenue -t Measure -i "SUM(Sales[Amount])" --save
te add Sales -t Table --save
te add "Sales[ProdKey]->Product[ProdKey]" --save                           # Relationship shorthand
te add Sales/MarketingFlag -t CalculatedColumn -i "..." --if-not-exists --save

For data-bound tables, te add also supports schema detection from SQL, Lakehouse, or Warehouse sources. See te add --help for --source, --endpoint, --source-table, --columns, etc.

rm

Remove an object. Checks dependents by default; use --force to bypass, --if-exists for idempotent removes.

te rm Sales/Revenue --save
te rm Sales/Revenue --dry-run                # Preview only
te rm Sales/OldMeasure --if-exists --save    # Idempotent

mv

Move or rename a model object.

te mv Sales/Revenue Finance/Revenue --save    # Move measure to another table
te mv Sales/Revenue Sales/TotalRevenue --save # Rename measure

replace

Find and replace text across model objects. Dry-run by default; add --save to apply.

  • --in <scope> — names, expressions, descriptions, displayFolders, formatStrings, annotations, all.
  • --regex, --case-sensitive.
te replace "OldTable" "NewTable" --in expressions --save
te replace "SUM" "SUMX" --regex --in expressions --save

Inspection

ls

List objects with filesystem-like navigation. Both model-level containers (Tables, Measures, Columns, Hierarchies, Relationships, Roles, Perspectives, Cultures) and table-scoped containers (Sales/Measures, Sales/Columns, …) are supported.

te ls                           # Tables (active model)
te ls Sales                     # Columns and measures in Sales
te ls Sales/Measures            # Measures in Sales
te ls Measures                  # All measures across the model
te ls Columns --paths-only      # One Table/Column per line, suitable for piping
te ls --type measure            # Same as `te ls Measures`

get

Get properties of a model object.

  • -q, --query <property> — fetch a single property (e.g. expression, formatString).
te get Sales/Amount -q expression          # Print DAX
te get Model -q description

find

Search for text across model objects.

  • --in <scope> — as per te replace (default all).
  • --regex, --case-sensitive, --paths-only.
te find "CALCULATE" --in expressions
te find "Revenue" --in names

diff

Compare two models for structural differences. Exit codes: 0 = identical, 1 = differences found, 2 = error.

te diff ./model-v1 ./model-v2
te diff old.bim new.bim

deps

Analyze an object's upstream and downstream dependencies, or surface unused objects across the model.

  • --unused — list measures, calculated columns, and all data columns that no DAX references and that aren't used in any relationship, hierarchy level, sort-by, variation, AlternateOf base, or calendar time role. Each result shows (hidden) in text mode and an isHidden field in JSON.
  • --hidden — narrow --unused to hidden objects only. Hidden, unused objects are the safest prune candidates because nothing user-facing depends on them.
te deps "Sales/Revenue"                   # Upstream + downstream for one object
te deps --unused                          # All unused measures and columns
te deps --unused --hidden                 # Only hidden, unused objects

Analysis and quality

validate

Validate model expressions, schema integrity, and TOM errors.

  • --ci <fmt> — emit CI annotations to stderr: vsts or github.
  • --trx <path> — write results as a VSTEST .trx file.
te validate ./model
te validate --ci github --trx results.trx

bpa run

Run Best Practice Analyzer rules against a model.

  • -r, --rules <file-or-url> — additional BPA rule file(s); repeatable.
  • --fix — apply auto-fix expressions where rules define them.
  • --fail-on <severity> — error (default) or warning.
  • --ci <fmt> / --trx <path> — CI annotations and TRX output.
  • --skip-bpa, --no-model-rules, --no-defaults, --rule <id>, --path <objectPath>, --vpax <file>, --vpa-rules.
te bpa run --fail-on error --ci github
te bpa run --fix --save
te bpa run --rule PERF_UNUSED_HIDDEN_COLUMN

bpa rules

List and inspect BPA rules from all sources (built-in, user, machine, model).

te bpa rules list              # Active rules
te bpa rules list --all        # Include disabled and ignored rules
te bpa rules list --ignored

vertipaq

Analyze VertiPaq storage statistics.

  • --columns, --relationships, --partitions, --all.
  • --export <file.vpax> / --import <file.vpax> — round-trip to VPAX.
  • --obfuscate — obfuscate names and expressions in exported VPAX.
  • --top <N>, --stats, --annotate, --save.
te vertipaq                    # Columns by size (default)
te vertipaq --all              # Tables, columns, relationships, partitions
te vertipaq --export stats.vpax
te vertipaq --import stats.vpax  # Analyze offline

format

Format DAX or M/Power Query expressions.

  • -e, --expression <text> — format a single inline expression.
  • -p, --path <objectPath> — format a specific measure/column.
  • --lang <dax|m> — default dax.
  • --save / --save-to — persist formatted expressions.
te format --save                                           # Format all DAX
te format -p Sales/Amount --save                           # Single measure
te format -e "SUM ( Sales[Amount] )"                       # Inline
te format --lang m --save                                  # Format M

Execution

query

Execute a DAX query against a deployed model.

  • -q, --query <dax> — inline query.
  • -f, --file <file.dax> — query from file.
  • --limit <N> — default 100.
  • -o, --output-file <path> — write results to file (.csv, .tsv, .json, .dax).
  • --trace, --cold, --plan, --runs <N> — performance tracing and benchmarking.
  • --no-validate — skip pre-execution DAX semantic validation.
te query -q "EVALUATE TOPN(5, 'Sales')" -s my-ws -d my-model
te query -f query.dax --output json

script

Execute one or more C# scripts against a semantic model.

  • -S, --script <file> — .cs / .csx file (repeatable).
  • -e, --expression <code> — inline C# (use - for stdin).
  • --save / --save-to / --format.
  • --dry-run, --timeout <seconds>.
te script --script fix.cs --save
te script -e "Info(Model.Tables.Count)"
echo "Info(Model.Name);" | te script -e -

macro

Manage and run Tabular Editor 3 macros from MacroActions.json.

te macro list                  # List macros
te macro run <name-or-id>      # Run a macro
te macro add <name>            # Add a macro
te macro set <name-or-id>      # Update macro properties
te macro rm <name-or-id>       # Remove a macro
te macro sort                  # Sort and re-assign IDs

te macro run accepts:

  • --on <object-path> — set the macro's selection context to one or more model objects (comma-separated paths). Equivalent to right-clicking objects in TE3 and invoking the macro from the context menu.
  • --save / --save-to — persist any changes the macro makes.

Macros that emit tables via dataTable.Output() render formatted output in the terminal, so DAX-style query macros work the same in te macro run as they do in TE3.

te macro run "Hide all measures"
te macro run "Format DAX" --on "Sales/Revenue,Sales/Margin" --save

Deployment and refresh

deploy

Deploy a semantic model to Power BI, Fabric, or Azure Analysis Services.

  • -s, --server / -d, --database — target workspace and model.
  • --deploy-full — overwrite + connections + partitions + shared expressions + roles + role members.
  • --deploy-connections, --deploy-partitions, --skip-refresh-policy, --deploy-roles, --deploy-role-members, --deploy-shared-expressions, --create-only.
  • --xmla <file> — generate XMLA/TMSL script instead of deploying (- for stdout).
  • --skip-bpa / --fix-bpa — bypass or auto-fix the BPA gate.
  • --force — skip interactive confirmation (required for CI).
  • --ci <fmt> — vsts or github.
  • --profile <name> — one-shot use of a saved Authentication and Connections profile.
te deploy ./model -s my-workspace -d my-model --force --ci github
te deploy ./model --xmla script.tmsl    # Generate TMSL only
te deploy ./model --profile staging --force
Important

te deploy runs the Best Practice Analyzer as a gate before executing. In interactive mode, a summary + confirmation prompt is shown with n as the safe default. In CI, pass --force to skip the prompt. See Custom Configuration for BPA gate configuration.

refresh

Trigger a data refresh on a deployed model.

  • --type <type> — full, dataonly, automatic, calculate, clearvalues, defragment, add (default: automatic).
  • --table <name> — refresh specific table(s); repeatable.
  • --partition <Table.Partition> — refresh specific partition(s).
  • --apply-refresh-policy, --effective-date <yyyy-MM-dd>, --max-parallelism <N>.
  • --dry-run — output the TMSL script without executing.
  • --no-progress, --trace [path].
te refresh --type full                                 # Full refresh
te refresh --table Sales --type full                    # Single table
te refresh --type full --dry-run > refresh.tmsl         # Emit TMSL only

incremental-refresh

Manage incremental refresh policies on tables.

te incremental-refresh show <table>

Additional subcommands (set, remove, apply) are documented via te incremental-refresh --help.

Testing

test run

Run a suite of DAX assertion tests against a deployed model.

  • --suite <path> — test-suite directory (default: .te-tests/).
  • --tag <tag> — only tests with this tag.
  • --fail-on <severity> — error (default) or warning.
  • --ci <fmt>, --trx <path> — CI annotations and TRX output.
te test run --ci github --trx results.trx
te test run --tag revenue

test init / spec / use / list / snapshot / compare

Additional subcommands scaffold tests, print the assertion spec format, switch the active suite, list suites, capture snapshots, and compare models. See te test --help for details.

te test init --example             # Scaffold an example suite
te test spec                       # Print the full assertion format reference
te test init --from-model --model ./my-model  # Generate stubs from your measures

Connection and auth

connect

Set (or display) the active connection for the current terminal session. See Authentication and Connections.

te connect                         # Show current active connection
te connect my-workspace my-model   # Remote
te connect ./model                 # Local
te connect --local                 # Power BI Desktop (Windows)
te connect --profile prod          # Activate a saved profile
te connect --clear                 # Clear the active connection (and any workspace mirror)

Workspace mode (-w / --workspace)

Pair a primary source with a secondary target so every subsequent --save mirrors the model between the two. Useful for keeping a local working copy of a remote workspace, or pushing local edits to a workspace as you save.

  • te connect <ws> <model> -w ./src — primary is remote; ./src receives an initial TMDL export and mirrors every save.
  • te connect ./src -w <ws> <model> — primary is local; an initial deploy pushes the model to the workspace, and subsequent saves re-deploy automatically.
  • --workspace-format <bim|tmdl> — choose the on-disk format when mirroring to a folder/file (e.g., -w ./model.bim infers BIM).
  • --force — required when the target already exists (non-empty folder, existing database). Without it, te connect shows an interactive y/n prompt with n as the safe default.

Once active, te set --save, te rm --save, te script --save, etc. all dual-save transparently. Save order is always local first, then remote so the on-disk copy reflects the latest user change even if the server push fails. Clear the mirror with te connect --clear.

te connect Finance "Revenue Model" -w ./revenue-model    # Mirror remote → local TMDL
te connect ./revenue-model -w Finance "Revenue Model"    # Mirror local → remote

auth login / status / logout

Manage cached authentication. See Authentication and Connections.

profile list / show / set / remove

Manage named connection profiles. See Authentication and Connections.

Configuration

config show / paths / init / set

View and manage CLI configuration and TE3 path overrides. See Custom Configuration.

te config show                          # Display all settings
te config paths                         # Resolved TE3 file paths
te config init                          # Create default config
te config set autoFormat true

license

Manage CLI license state.

te license activate <key>

migrate

Reference guide showing how legacy Tabular Editor 2 CLI flags map to the new CLI. Useful as a live lookup while porting a TE2-based pipeline. See Migrating from the TE2 Command Line for the full migration guide.

te migrate                   # Full flag mapping table
te migrate -A                # Look up a single TE2 flag
te migrate --output json     # Machine-readable mapping

Shell

interactive

Start a guided REPL session with a model-aware prompt. See Interactive Mode.

te interactive                                # Connect later
te interactive ./model                        # Start with a local model
te interactive -s MyWorkspace -d MyModel      # Start with a remote model

completion

Generate a shell completion script. See Installation and Setup.

te completion bash
te completion zsh
te completion pwsh

Exit codes

Exit Meaning
0 Success.
1 Generic failure (invalid arguments, command failed, validation errors, auth failure, BPA gate failed at severity ≥ error).
2 Non-zero diff (te diff) — models differ.

For fine-grained control in CI pipelines, combine exit codes with --ci <vsts/github> annotations and --trx results files — see CI/CD Integration.