docs(cli): rename --output to --output-format, --format to --serialization - #322
Merged
Merged
Conversation
otykier
commented
May 26, 2026
otykier
commented
Contributor
- Replace --output with --output-format across all te-cli pages.
- Rename save-format --format to --serialization on save/init/add/rm/mv/set/ replace/bpa run/macro/script examples.
- Add --error-format to the global options table for independent stderr formatting.
- Drop the Auto-mode language: the default is now plain text regardless of TTY, with --output-format json the explicit opt-in.
- Drop the -f short alias for te query --file (no -f aliases anywhere in the CLI).
…ation - Replace --output <fmt> with --output-format <fmt> across all te-cli pages. - Rename save-format --format to --serialization on save/init/add/rm/mv/set/ replace/bpa run/macro/script examples. - Add --error-format to the global options table for independent stderr formatting. - Drop the Auto-mode language: the default is now plain text regardless of TTY, with --output-format json the explicit opt-in. - Drop the -f short alias for te query --file (no -f aliases anywhere in the CLI).
gronnerup
approved these changes
May 26, 2026
gronnerup
added a commit
that referenced
this pull request
May 29, 2026
#313) * Added documentation for new Tabular Editor CLI in Limited Public Preview. This includes new Tabular Editor CLI item and 8 new doc pages covering installation, commands, ci/cd etc. * Delete .claude/settings.local.json * Added link to the GitHub repo for issues and discussions. Updated gitignore. * Include file for preview notice * Updates based on Jeroen's comments * Update config titel * Update docs for CLI to comply with latest changes in commands, flags, auth etc. * cli docs refinement (#318) * Update te-cli docs to reflect TE3 PR 3201 (CLI - Remove TE3 dependencies) (#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. --------- * Added limitations page and polished text on all cli doc pages * Adjusted cicd and install docs. Emphasize CLI limited preview limitations * docs(cli): refresh BPA rule limitations after resolver wiring te bpa run now consults bpa.rules and TE_BPA_PATH (the row covering that gap is removed). Add two remaining limitations: --rules is additive with the built-in defaults, and there is no per-invocation flag to skip bpa.rules without also passing --rules. * docs(cli): rename --output to --output-format, --format to --serialization (#322) - Replace --output <fmt> with --output-format <fmt> across all te-cli pages. - Rename save-format --format to --serialization on save/init/add/rm/mv/set/ replace/bpa run/macro/script examples. - Add --error-format to the global options table for independent stderr formatting. - Drop the Auto-mode language: the default is now plain text regardless of TTY, with --output-format json the explicit opt-in. - Drop the -f short alias for te query --file (no -f aliases anywhere in the CLI). * Update cli docs with correct link and verified all commands, subcommands and arguments. * Update incorrect download link * Added connect example to different org. * Update CLI Configs to reflect latest config options also adding additional description on all config settings * Added framing on the use of Python * Update intro, cicd and interactive based on review feedback * Stop tracking generated docfx.json docfx.json is generated by gen_redirects.py from docfx-template.json at build time (see README and .github/workflows/deploy.yml). It should not be committed - it was added accidentally on this branch. Add /docfx.json to .gitignore and untrack the file. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Promote platform-table caveat to IMPORTANT callout The note that local SSAS and Power BI Desktop connections are Windows-only materially constrains what macOS/Linux users can do with the CLI. Wrap it in [!IMPORTANT] so it stands out below the cross-platform feature matrix. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Moved TE CLI above old CLI in ToC and added warning on overview page regarding preview notice * Address review feedback on auth, path quoting, and CLI scripting - csharp-scripts.md: add Tabular Editor CLI to applies_to and document the TECLI preprocessor symbol (plus the TE3_3_X_OR_GREATER family and the Select* UI-helper caveat under te script) so the cross-reference from te-cli-commands.md lands on relevant content. - te-cli-auth.md: replace "caches the SP record" with "caches the credentials" - the rest of the page spells out "service principal", and "SP record" was the only short-form outlier. - te-cli-commands.md: rewrite "Bare segments cover the common case" as "Most segment names work as-is" - same meaning, plain English. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Rephase risks in pipelines during preview * Removed section on DaxFormatter limitations * Added images for preview notice and ls command * Apply review feedback on auth docs * Apply review feedback on overview and install docs * Apply review feedback on command reference * Apply review feedback across cli docs * Apply review feedback on config page --------- Co-authored-by: Morten Lønskov <morten.lonskov@tabulareditor.com> Co-authored-by: Daniel Otykier <otykier@users.noreply.github.com> Co-authored-by: Maria José Ferreira <171664470+MariaJoseFF@users.noreply.github.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.