You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(cli): remove the load, open, and replace commands
These three commands were removed from the CLI during Limited Public
Preview, so the docs should carry no trace of them:
- `replace` (PR !4065) - unguarded model-wide string replacement
- `load` (PR !4066) - superseded by `te get .` and `te ls Tables`
- `open` (PR !4071) - Windows-only TE3 Desktop launcher
Removed the three command-reference sections and every mention across
the CLI docs. Two spots needed rewriting rather than deletion:
- `te find` documented its `--in <scope>` values as "as per `te replace`";
the scope list is now inlined so the entry stands on its own.
- The `te replace` dry-run tip in te-cli-automation is now a general
preview-before-`--save` idiom.
The `open` removal also deleted the `te3ExePath` config key and the
`TE3_EXE_PATH` environment variable from CliConfig.cs and ConfigCommand.cs,
so both are dropped from the config schema, the File paths table, and the
environment variables table.
Applied the same changes to the es and zh translations under
localizedContent/ so no stale references remain anywhere in the repo.
No release-note entry: the CLI is still in preview, so these commands were
never generally available.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|`tmsl` (alias `bim`) | Whole-object TMSL/BIM serialization | Accepted by `te get` and `te list`. |
31
31
|`tmdl`| Whole-object TMDL serialization | Accepted by `te get` only (single object). |
32
32
@@ -179,7 +179,7 @@ The resulting TMSL can be reviewed in a pull request, committed, executed by the
179
179
A handful of small idioms that come up often when composing `te` commands in scripts or pipelines:
180
180
181
181
-**Idempotent creates and removes.**`te add Sales/Marker -t Measure -i "0" --if-not-exists --save` and `te remove Sales/OldMeasure --if-exists --save` both exit `0` whether or not the object existed - safe to re-run in CI.
182
-
-**Dry-run diffs.**`te replace` is dry-run by default; add `--save` only when you're satisfied with the preview.
182
+
-**Preview before persisting.**Mutating commands only touch the source when you pass `--save`; run them without it first to review what would change.
183
183
-**Emit TMSL for review.**`te deploy ./model --xmla deploy.tmsl` produces the deployment script without touching the server - useful for DBA review or manual apply.
184
184
-**Path-only output.**`te list --paths-only` and `te find --paths-only` emit one object path per line, ideal for piping to `xargs`, `te get`, or `te set`. The model-level containers (`te list Measures`, `te list Columns`) compose well with this for whole-model sweeps.
185
185
-**Benchmarking queries.**`te query --trace --cold --runs 5` runs a DAX query with cold cache, five iterations, and captures FE/SE trace events.
Copy file name to clipboardExpand all lines: content/features/te-cli/te-cli-commands.md
+1-52Lines changed: 1 addition & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -168,16 +168,6 @@ positional `<model>` argument → `--model` global flag → `--server`/`--databa
168
168
169
169
## Model I/O
170
170
171
-
### load
172
-
173
-
Load a semantic model and display a summary of the model - name, compatibility level, and high-level object counts (tables, measures, columns).
174
-
175
-
```bash
176
-
te load ./model # TMDL folder
177
-
te load model.bim # BIM file
178
-
te load -s MyWorkspace -d MyModel # Remote workspace
179
-
```
180
-
181
171
### save
182
172
183
173
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.
@@ -203,16 +193,6 @@ te save -o ./out -s my-workspace -d my-model --skip-validation # Fast download
203
193
> [!TIP]
204
194
> 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).
205
195
206
-
### open
207
-
208
-
Open a model in Tabular Editor 3 Desktop. **Windows only** (requires TE3 to be installed). With no arguments, launches TE3 with a blank workspace.
209
-
210
-
```bash
211
-
te open # Launch TE3 with a blank workspace
212
-
te open ./my-model # Open a TMDL folder in TE3
213
-
te open ./model.bim # Open a BIM file in TE3
214
-
```
215
-
216
196
### init
217
197
218
198
Create a new empty semantic model at the given path. Defaults to a TMDL model in `PowerBI` compatibility mode at compatibility level 1702.
-**Saved connection profiles** - the list of named profiles you can switch between.
24
24
@@ -109,7 +109,6 @@ The complete JSON config schema with all keys at their default values. Use this
109
109
"disableTelemetry": false,
110
110
111
111
"queryLog": null,
112
-
"te3ExePath": null,
113
112
114
113
"profiles": {}
115
114
}
@@ -123,7 +122,6 @@ Set these in your config to avoid passing the same paths on every command. Per-c
123
122
| -- | -- |
124
123
|`macros`| Explicit path to a macros JSON file (typically `MacroActions.json`). Resolved by every `te macro` command. Point at a shared file (network share, repo-local, or even the TE3 desktop file) to reuse the same set of macros across machines and between the CLI and TE3 Desktop. |
125
124
|`bpa.rules`| Ordered list of paths or URLs to BPA rule files. `te bpa run` and the deploy/save gate load **every** existing entry; `te bpa rules list` and `te config paths` use the first existing entry. Comma-separated values on `te config set bpa.rules ...` are split into the array. |
126
-
|`te3ExePath`| Explicit path to the Tabular Editor 3 Desktop executable (`TabularEditor.exe`). Used **only** by `te open` to launch the desktop app; safe to leave unset on Linux/macOS or when you don't use `te open`. If unset, `te open` falls back to a `PATH` lookup. |
127
125
|`queryLog`| Path to a log file where every `te query` invocation appends its query text and execution metadata. Useful for audit trails or analyzing query patterns over time. Supports `~` for the home directory (e.g., `~/.config/te/queries.log`). |
128
126
129
127
### Path resolution priority
@@ -145,7 +143,7 @@ All BPA-related settings live under the `bpa` object and are addressed via dotte
145
143
| Key | Default | Description |
146
144
| -- | -- | -- |
147
145
|`autoFormat`|`false`| Run the DAX Formatter on modified expressions after `te add` / `te set` / `te move` / `te macro run`. Uses the in-house formatter by default; opt into the SQL BI web service via `formatOptions.useSqlBiDaxFormatter`. |
148
-
|`validateOnMutation`|`true`| After a mutating command (`add`, `set`, `mv`, `replace --save`, `macro run`), check that every `Table[Column]` reference in the model still resolves. Catches dangling references introduced by renames or removals before they reach deploy. |
146
+
|`validateOnMutation`|`true`| After a mutating command (`add`, `set`, `mv`, `macro run`), check that every `Table[Column]` reference in the model still resolves. Catches dangling references introduced by renames or removals before they reach deploy. |
149
147
|`bpa.onMutation`|`false`| Run a scoped BPA analysis after each mutating command (`set`, `add`, `mv`, `rm`, `macro run`). Only the affected table's objects are checked, not the whole model - useful for fast feedback during iterative edits. |
150
148
|`bpa.onDeploy`|`true`| Run the BPA gate before `te deploy` executes. The deploy is aborted if any rule fires at severity >= error. Bypass per-invocation with `--skip-bpa`, or auto-fix with `--fix-bpa`. |
151
149
|`bpa.onSave`|`true`| Run the BPA gate before `te save -o` writes to disk. Bypass per-invocation with `--skip-bpa` or `--force`. |
@@ -226,7 +224,7 @@ Both `bpa.builtInRules` and `bpa.disabledBuiltInRuleIds` apply consistently to t
226
224
227
225
## Post-mutation behavior
228
226
229
-
When you run a mutating command (`te add`, `te set`, `te move`, `te replace --save`, `te macro run`), the CLI performs these checks automatically:
227
+
When you run a mutating command (`te add`, `te set`, `te move`, `te macro run`), the CLI performs these checks automatically:
230
228
231
229
1.**TOM errors** are always surfaced. Invalid DAX or M in measures, columns, partitions, or calculation items always fails the command.
232
230
2.**Schema validation** (`validateOnMutation`, default `true`) verifies that `Table[Column]` references in DAX still resolve, cross-checking metadata consistency.
@@ -245,7 +243,6 @@ Use the following CLI-specific environment variables for paths, behavior, and di
245
243
|`TE_MACROS_PATH`| Override the macros file path (second in resolution order - see above). Read by `te macro` commands. |
246
244
|`TE_BPA_RULES`| Override the BPA rules file/URL list used by `te bpa run` and `te bpa rules` subcommands. |
247
245
|`TE_BPA_CONFIG`| Override the path to the BPA gate config (`.te-bpa.json`) the deploy/save gate reads. |
248
-
|`TE3_EXE_PATH`| Path to the Tabular Editor 3 desktop binary. Used **only** by `te open`; safe to leave unset on Linux/macOS or when you don't use `te open`. Falls back to `PATH` lookup. |
249
246
|`TE_DEBUG`| Set to `1` to enable debug logging globally (same as `--debug` or `debug: true` in config). |
250
247
|`NO_SPINNER`| Set to `1` or `true` to disable animated progress indicators (alternative to `spinner: false` in config). |
251
248
|`CI`| Auto-detected. When `1` or `true`, the CLI disables the spinner and switches to plain output. Most CI runners set this automatically. |
Copy file name to clipboardExpand all lines: content/features/te-cli/te-cli-migrate.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ TE2 compatibility mode is activated in any of three ways:
26
26
27
27
1.**Binary name.** Rename `te` to `te2` (or symlink it) and the CLI runs in TE2-exact mode. This is the drop-in replacement path: swap `TabularEditor.exe` for `te2` in your existing pipeline and the same arguments work.
28
28
2.**Environment variable.** Set `TE_COMPAT=te2` before invoking `te` to force TE2 mode.
29
-
3.**Auto-detection.** If the first argument isn't a `te` subcommand (`load`, `deploy`, …) and at least one recognized TE2 flag appears somewhere in the argument list, the CLI auto-routes to TE2 mode. This means most existing TE2 invocations work without any changes.
29
+
3.**Auto-detection.** If the first argument isn't a `te` subcommand (`deploy`, `validate`, …) and at least one recognized TE2 flag appears somewhere in the argument list, the CLI auto-routes to TE2 mode. This means most existing TE2 invocations work without any changes.
30
30
31
31
```bash
32
32
# All three are equivalent - each runs in TE2 mode
0 commit comments