Skip to content

docs(cli): remove the load, open, and replace commands - #380

Open
MariaJoseFF wants to merge 1 commit into
mainfrom
user-mjf/docs-cli-remove-load-open-replace
Open

docs(cli): remove the load, open, and replace commands#380
MariaJoseFF wants to merge 1 commit into
mainfrom
user-mjf/docs-cli-remove-load-open-replace

Conversation

@MariaJoseFF

@MariaJoseFF MariaJoseFF commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Removes all documentation for the three TE CLI commands that were deleted from the CLI during Limited Public Preview.

Why

Command Removal PR Rationale
replace !4065 Unguarded model-wide string replacement could silently corrupt expressions or names sharing a substring with the pattern
load !4066 Printed a one-off model summary; everything it showed is available from te get . and te ls Tables
open !4071 Windows-only TE3 Desktop launcher, already achievable with TabularEditor3.exe <model>

Since the CLI has not reached GA, these commands were never generally available, so the docs carry no trace of them and no release-note entry was added.

Changes

Deleted the three command-reference sections and every mention across the CLI docs. Two spots were rewritten rather than deleted:

  • te find documented its --in <scope> values as "as per te replace". That would have become a dangling reference, so the scope list is now inlined.
  • te-cli-automation had a "Dry-run diffs" tip entirely about te replace. It is now a general note about what mutating commands do without --save.

The open removal also deleted the te3ExePath config key and the TE3_EXE_PATH environment variable from CliConfig.cs and ConfigCommand.cs. Both are dropped from the config schema JSON, the File paths table, and the environment variables table.

Files touched: te-cli-commands, te-cli, te-cli-config, te-cli-automation, te-cli-migrate, te-cli-skill, and Command-line-Options.

Scope

English source only. The es and zh translations under localizedContent/ still contain the removed commands and are intentionally left out of this PR to keep the review diff readable. They need to be handled separately - either the localization pipeline regenerates them from the English source, or a follow-up PR updates them by hand.

Verification

Every added or reworded line was checked against the CLI source, not just the deletions:

Added wording Verified against
te find --in scope list (names, expressions, descriptions, displayFolders, formatStrings, annotations, all, default all) FindCommand.cs option description, identical string; FindReplaceUtils.ParseScope accepts exactly these tokens
"Mutating commands ... print Changes not saved. Use --save to persist." That exact string in AddCommand, SetCommand, MvCommand, RmCommand, FormatCommand, ScriptCommand, MacroCommand
te remove --dry-run reports without applying RmCommand.cs: "Show what would be removed without doing it"
te migrate auto-detection example subcommands (deploy, validate) Both registered in Program.cs

No xref:te-cli-commands#load, #open, or #replace anchors remain in content/, so there are no broken cross-references in the English docs.

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

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 that
  could corrupt names or expressions merely sharing a substring
- `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. Verified
  against FindCommand.cs, whose option description is the identical string,
  and FindReplaceUtils.ParseScope, which accepts exactly those tokens.
- The `te replace` dry-run tip in te-cli-automation is now a general note
  on what mutating commands do without `--save`. Verified against
  AddCommand, SetCommand, MvCommand, RmCommand, FormatCommand,
  ScriptCommand and MacroCommand, which all emit "Changes not saved. Use
  --save to persist.", and RmCommand's --dry-run ("Show what would be
  removed without doing it").

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.

English source only. The es and zh translations under localizedContent/
still reference these commands and are handled separately, either by the
localization pipeline or in a follow-up.

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>
@MariaJoseFF
MariaJoseFF force-pushed the user-mjf/docs-cli-remove-load-open-replace branch from 82d531d to fc72e6a Compare August 14, 2026 07:49
@github-actions

Copy link
Copy Markdown

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

@MariaJoseFF
MariaJoseFF marked this pull request as ready for review August 14, 2026 07:59
@MariaJoseFF

Copy link
Copy Markdown
Collaborator Author

@mlonsk, this PR is to be merged into the next CLI release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant