Added documentation for new Tabular Editor CLI in Limited Public Prev… by gronnerup · Pull Request #313 · TabularEditor/TabularEditorDocs

gronnerup · 2026-04-20T09:48:21Z

…iew. This includes new Tabular Editor CLI item and 8 new doc pages covering installation, commands, ci/cd etc.

github-actions · 2026-04-20T09:52:36Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

github-actions · 2026-04-21T08:12:54Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

mlonsk · 2026-04-21T07:53:16Z

+      none: true
+    - product: Tabular Editor 3
+      none: true
+    - product: Tabular Editor CLI


I think it is correct to introduce a new applies_to category, but I just wonder if we need to update all our other documentation with the CLI apply_to? For example Script How to would also apply to CLI.

Hmm... good question. Some of the scripting doc pages include screenshots of the desktop application - for those I would for sure not add the CLI apply_to. For the Scripting Patterns maybe.

To keep it clean I would recommend that we create a dedicated scripting page for the CLI where we could reference other relevant scripting articles - also covering scripting limitations etc. in the CLI.

mlonsk · 2026-04-21T07:57:20Z

+> [!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.
+
+The Tabular Editor CLI authenticates to Power BI Service, Microsoft Fabric, and Azure Analysis Services using the same Power BI Desktop client ID that Tabular Editor 3 uses. Tokens are cached locally so you authenticate once and re-run commands silently until the refresh token expires (typically 90 days).


Do we need to update security-privacy.md with information around CLI? At least an apply_to is needed.

mlonsk · 2026-04-21T07:58:27Z

+Pass an XMLA endpoint, workspace name, or `powerbi://` URL as `--server`:
+
+```bash
+te connect "powerbi://api.powerbi.com/v1.0/myorg/Finance" "Revenue Model"


Add example of different organsisation "powerbi://api.powerbi.com/v1.0/SpaceParts/Finance" "Revenue Model"

mlonsk · 2026-04-21T11:47:10Z

+`te config paths` resolves where the CLI will actually look for TE3 data files — useful when debugging missing macros or BPA rules.
+
+## Setting values
+


Needs a line here about what these commands do

mlonsk · 2026-04-21T12:51:26Z

+```
+
+> [!TIP]
+> When stdout is piped, `auto` already emits JSON. Explicit `--output json` is only necessary when you want JSON on a TTY, or when a consumer expects it regardless of how the command is invoked.


What does the word consumer mean here - it is not a term we generally have used in our documentation elsewhere

mlonsk · 2026-04-21T12:53:53Z

+```
+
+## Python
+


Lacks explanation of what this subsection is about

mlonsk · 2026-04-21T12:54:16Z

+```
+
+## PowerShell
+


lacks explanation of section

mlonsk · 2026-04-21T12:56:26Z

+The Tabular Editor CLI is designed for unattended execution in continuous integration and delivery pipelines. A single binary, structured output, non-interactive mode, native CI annotations for GitHub Actions and Azure DevOps, and VSTEST-compatible test results make it a natural replacement for ad-hoc TE2 invocations.
+
+> [!WARNING]
+> During preview, we recommend against using the CLI in **production** pipelines. Commands, flags, and outputs may change before GA. Build and evaluate in non-production pipelines first; share feedback so the GA shape matches your needs.


Add link to GitHub repository to share feedback in

mlonsk · 2026-04-21T13:01:06Z

+```
+te [MyModel]>
+```
+


Picture of starting a session?

mlonsk · 2026-04-21T13:02:49Z

+| `-L` / `-LOGIN <user> <pass>` (after `-D`) | *Not yet implemented.* | Use `te auth login` with service principal or env-based credentials instead — see @te-cli-auth. |
+
+## Migration playbook
+


Readd warning about production pipelines`?

…ignore.

…TabularEditor/TabularEditorDocs into user-pg/te-cli-limitedPuPr-docs

github-actions · 2026-04-22T06:46:13Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

jeroenterheerdt · 2026-04-21T07:40:30Z

+
+The Tabular Editor CLI (`te`) is a cross-platform command-line interface for Power BI and Analysis Services semantic models. It runs on Windows, macOS, and Linux as a single self-contained executable and wraps the same model engine (TOMWrapper) that powers Tabular Editor 3 Desktop.
+
+Use it to inspect, edit, validate, deploy, refresh, and test semantic models from a terminal — against local TMDL or BIM files, Power BI Desktop, or semantic models in Fabric and Power BI Service workspaces.


Doesn't feel this is a complete sentence, and what does 'it' refer to?. Instead of "Use it to inspect" - maybe consider: "You can use the Tabular Editor CLI".

I am also missing a "why this matters". Why should one use this compared to what we had previously with the CLI and the tool itself? what new scenarios does this unlock and when should I use this vs the others?

Yes, this should be rewritten as a compact Why use the Tabular Editor CLI section

jeroenterheerdt · 2026-04-21T07:56:52Z

+- **AI agents** — token-lean structured output, predictable exit codes, machine-parseable errors.
+- **CI/CD pipelines** — non-interactive mode, GitHub Actions and Azure DevOps annotations, VSTEST-compatible test results.
+
+The same design choices — structured JSON output, a `--non-interactive` global flag, clear errors — serve all three.


These design choices were not introduced earlier in the doc - it's confusing they are mentioned just here. Shouldn't we have a section about these choices at the top?

jeroenterheerdt · 2026-04-21T09:22:05Z

+| Connect to local SSAS instance (TCP transport) | Yes | No |
+| Connect to Power BI Desktop (named-pipe transport) | Yes | No |
+
+Local SSAS and Power BI Desktop connections rely on Windows-only transport protocols. All cloud-based workflows (Power BI Service, Fabric, Azure Analysis Services) work on every platform.


shouldn't this be a banner like ![IMPORTANT]?

jeroenterheerdt · 2026-04-22T07:11:55Z


 # Command Line and Integration
 ## @command-line-options
+## [Tabular Editor CLI (Limited PuPr)](xref:te-cli)


The order here seems kind of random? Why would I want to know about commands before config?

Config is about custom configurations which most users will probably not attempt, if anything it should perhaps be lower.

github-actions · 2026-04-23T10:28:56Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

github-actions · 2026-04-23T12:37:26Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

github-actions · 2026-04-23T18:30:24Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

… auth etc.

github-actions · 2026-05-06T13:28:46Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

github-actions · 2026-05-12T20:38:57Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

…ies) (#317) * Update te-cli docs to reflect TE3 PR 3201 (CLI - Remove TE3 dependencies) Aligns te-cli-config, te-cli-commands, and te-cli-cicd with the cross-platform CLI's decoupled configuration model: - Schema: nested `bpa.*` object replaces flat `bpaRules`/`bpaOn*`; add `formatVersion`, `interactiveEditMode`, `queryLog`, `te3ExePath`; remove `te3DataDir`, `preferences`, `bpaMachineRules` - Path resolution: drop auto-detection of `%LocalAppData%\TabularEditor3`; new order is flag > env var > config > CWD fallback - New commands documented: `te bpa rules init`, `te bpa rules disable`, `te bpa rules enable`, `te macro init`, plus the built-in guard on `te bpa rules set / rm` - New flags documented: `te deploy --bpa-rules`, `te save --bpa-rules` - Environment variable renamed: `TE_BPA_RULES_PATH` -> `TE_BPA_PATH` - `TE_CONFIG` now honored by every `te config` operation - `te config paths` JSON output documented (emits null fields explicitly) - Added "Removed keys" reference table * Drop "Removed keys" section from te-cli-config No public preview build of the CLI was released with the older key names, so the migration table has no audience. Also removes the "Unknown or removed keys" wording and the [!NOTE] pointing at the deleted section. The `formatVersion` / `interactiveEditMode` paragraphs are preserved under a new "Other schema keys" heading. ---------

github-actions · 2026-05-13T10:42:25Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-313.westeurope.azurestaticapps.net

Added documentation for new Tabular Editor CLI in Limited Public Prev…

a745923

…iew. This includes new Tabular Editor CLI item and 8 new doc pages covering installation, commands, ci/cd etc.

mlonsk reviewed Apr 21, 2026

View reviewed changes

Comment thread .claude/settings.local.json Outdated

mlonsk reviewed Apr 21, 2026

View reviewed changes

Comment thread docfx.json

Delete .claude/settings.local.json

60a727c

mlonsk reviewed Apr 21, 2026

View reviewed changes

gronnerup added 2 commits April 22, 2026 08:41

Added link to the GitHub repo for issues and discussions. Updated git…

8ab7a67

…ignore.

Merge branch 'user-pg/te-cli-limitedPuPr-docs' of https://github.com/…

9daf2bf

…TabularEditor/TabularEditorDocs into user-pg/te-cli-limitedPuPr-docs

jeroenterheerdt requested changes Apr 22, 2026

View reviewed changes

Include file for preview notice

e32234f

Updates based on Jeroen's comments

bcd0add

Update config titel

c097f53

Update docs for CLI to comply with latest changes in commands, flags,…

4f26bbe

… auth etc.

cli docs refinement (#318)

63a9386

		`te config paths` resolves where the CLI will actually look for TE3 data files — useful when debugging missing macros or BPA rules.

		## Setting values

		\| `-L` / `-LOGIN <user> <pass>` (after `-D`) \| Not yet implemented. \| Use `te auth login` with service principal or env-based credentials instead — see @te-cli-auth. \|

		## Migration playbook


		The Tabular Editor CLI (`te`) is a cross-platform command-line interface for Power BI and Analysis Services semantic models. It runs on Windows, macOS, and Linux as a single self-contained executable and wraps the same model engine (TOMWrapper) that powers Tabular Editor 3 Desktop.

		Use it to inspect, edit, validate, deploy, refresh, and test semantic models from a terminal — against local TMDL or BIM files, Power BI Desktop, or semantic models in Fabric and Power BI Service workspaces.

		```

		## Python

		```

		## PowerShell

Conversation

gronnerup commented Apr 20, 2026

Uh oh!

github-actions Bot commented Apr 20, 2026

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 22, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

github-actions Bot commented May 6, 2026

Uh oh!

github-actions Bot commented May 12, 2026

Uh oh!

github-actions Bot commented May 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants