feat(ai-cu): add opt-in terminal Markdown previews by chienyuanchang · Pull Request #10784 · Azure/azure-dev

Chien Yuan Chang (chienyuanchang) · 2026-10-29T18:26:57Z

Summary

Add opt-in terminal Markdown previews with azd ai cu analyze --pretty (-p). Default output is Markdown/HTML text; saved results and reports are not pretty-printed.

Format Markdown and display supported HTML tables as tables or labeled cards. Unsupported tables show their source with a layout notice.
Display document metadata, page comments, and generated row labels in a shared gray; use consistent heading colors, a distinct table color, and yellow layout notices.
Include metadata delimiters and source line breaks. Document URLs are not rewritten; terminal and bidi controls are filtered.
Show animated, action-colored Analyzing <target>... progress only on interactive terminals with default output. Concurrent inputs share a rotating status line. Local targets show file names; URL targets omit credentials, query parameters, and fragments without changing the service request. Progress clears before final output and is never written to result or report files.
Display a valid https://<your-resource>.services.ai.azure.com example in missing-endpoint guidance.
Provide readable version output and highlighted provisioning guidance with blue wizard questions.

Usage and behavior

azd ai cu analyze invoice.pdf --pretty
azd ai cu analyze invoice.pdf -p

Pretty-printing requires one streamed LLM-input result. Incompatible options and multiple inputs are rejected before authentication.
--pretty / -p cannot be combined with --output json, --output none, --llm-input=false, --usage, --dry-run, --output-file, or --output-dir. Reports are supported.
Omit the flag or use --pretty=false / -p=false for default text output.
Respect NO_COLOR. Redirected or piped previews are uncolored and use an 80-column layout; progress is omitted.

Validation

Race tests passed for the affected command, analysis, configuration, and error-handling packages. Targeted preview/color, shorthand, conflict-validation, and help tests also passed.
Real PTY tests with mocked service responses passed for local files and URLs, including URL request fidelity and result/report non-contamination.
Regression coverage includes progress concurrency, cancellation and writer failures, no-color handling, and repeated endpoint-message sanitization.
Extension build, vet, lint, modernization, documentation spelling, and whitespace checks passed during implementation.
A live Linux prebuilt-layout analysis of the SDK sample invoice succeeded. Its three tables used HTML-source fallback; this is not evidence of successful formatted-table/card rendering or native Windows/macOS acceptance.

Limitations and remaining review

Long values/cards can exceed terminal width; Markdown tables can shorten long links.
Unicode alignment, right-to-left text, and emoji appearance depend on the terminal and font.
Native Windows/macOS visual acceptance and spacing/copy-paste checks remain outstanding.
Experience spec: Azure/azure-dev#10869, covering --pretty and -p; approval is pending.
No final repository-wide mage preflight or cross-platform acceptance run is claimed.

Add host-native generation prompts, a model multi-select flow, readable summaries, and regression coverage. Prepare 0.1.1-preview and date the initial release. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Address P2 analysis and analyzer error guidance and privacy-safe schema source locations. Add regressions for explicit empty selectors and full extension help paths. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Retry only validation errors for the prompted infrastructure field. Resolve authoring diagnostics against the selected alias without remapping literal spec findings or changing structured finding output. Add regression coverage and document source-location behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Render Markdown with Glamour and supported HTML tables with azd tables or cards. Preserve raw output by default, protect preview metadata and sensitive URLs, and cover command validation and multilingual rendering. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-pipelines · 2026-10-29T18:27:31Z

Azure Pipelines: Successfully started running 1 pipeline(s). 26 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run.

Preserve the merged CU provisioning and documentation updates while retaining the opt-in terminal Markdown renderer. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-sdk-automation · 2026-11-03T23:11:23Z

VSCode Extension Installation Instructions

Download the extension at https://azuresdkartifacts.z5.web.core.windows.net/azd/vscode/pr/10784/azure-dev-0.11.0-alpha.1.vsix
Extract the extension from the compressed file
In vscode
a. Open "Extensions" (Ctrl+Shift+X)
b. Click the ...\ menu at top of Extensions sidebar
c. Click "Install from VSIX"
d. Select location of downloaded file

azure-sdk-automation · 2026-11-03T23:11:46Z

microsoft.azd.extensions PR build

Note

This is an unsigned development build. Install it only if you trust this PR.

Install the extension:

azd ext install "https://azuresdkartifacts.z5.web.core.windows.net/azd/extensions/pr/10784/microsoft-azd-extensions.zip"

Version: 0.14.0-pr.10784.7033695
Merge commit: fb9f753

azure-sdk-automation · 2026-11-03T23:13:20Z

azure.ai.projects PR build

Note

This is an unsigned development build. Install it only if you trust this PR.

Install the extension:

azd ext install "https://azuresdkartifacts.z5.web.core.windows.net/azd/extensions/pr/10784/azure-ai-projects.zip"

Version: 1.0.0-beta.16.pr.10784.7033699
Merge commit: fb9f753

azure-sdk-automation · 2026-11-03T23:13:27Z

azure.ai.toolboxes PR build

Note

This is an unsigned development build. Install it only if you trust this PR.

Install the extension:

azd ext install "https://azuresdkartifacts.z5.web.core.windows.net/azd/extensions/pr/10784/azure-ai-toolboxes.zip"

Version: 1.0.0-beta.13.pr.10784.7033701
Merge commit: fb9f753

azure-sdk-automation · 2026-11-03T23:13:44Z

microsoft.azd.concurx PR build

Note

This is an unsigned development build. Install it only if you trust this PR.

Install the extension:

azd ext install "https://azuresdkartifacts.z5.web.core.windows.net/azd/extensions/pr/10784/microsoft-azd-concurx.zip"

Version: 0.1.0-pr.10784.7033698
Merge commit: fb9f753

azure-sdk-automation · 2026-11-03T23:14:13Z

azure.ai.agents PR build

Note

This is an unsigned development build. Install it only if you trust this PR.

Install the extension:

azd ext install "https://azuresdkartifacts.z5.web.core.windows.net/azd/extensions/pr/10784/azure-ai-agents.zip"

Version: 1.0.0-beta.23.pr.10784.7033696
Merge commit: fb9f753

azure-sdk-automation · 2026-11-03T23:14:21Z

azure.ai.skills PR build

Note

This is an unsigned development build. Install it only if you trust this PR.

Install the extension:

azd ext install "https://azuresdkartifacts.z5.web.core.windows.net/azd/extensions/pr/10784/azure-ai-skills.zip"

Version: 1.0.0-beta.10.pr.10784.7033700
Merge commit: fb9f753

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-sdk-automation · 2026-11-04T22:42:51Z

azure.ai.content-understanding PR build

Note

This is an unsigned development build. Install it only if you trust this PR.

Install the extension:

azd ext install "https://azuresdkartifacts.z5.web.core.windows.net/azd/extensions/pr/10784/azure-ai-content-understanding.zip"

Version: 0.1.2-preview.pr.10784.7038901
Merge commit: c354323

Keep metadata delimiters, page comments and source line breaks. Align H1 styling with other headings, replace the blanket preview banner with table layout notices, and mark generated card row labels as dim comments. Retain existing URL safety filtering. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

🟡 Changes recommended

Approval is blocked by two active review issues: the new user-facing --pretty option lacks a linked approved experiences spec, and the PR description contradicts the intentionally preserved URL components.

2 open issues

What changed in this PR

Adds opt-in terminal pretty-printing for azd ai cu analyze --pretty while preserving existing Markdown, HTML, JSON, report, and saved-result behavior by default. It also improves version output, provisioning guidance styling, documentation, and release metadata.

Changes:

Adds Markdown, metadata, HTML table, and wide-table card rendering with terminal-safety filtering and color support.
Adds validation for incompatible options and multiple-input pretty-printing.
Updates version output, provisioning prompts, documentation, dependencies, tests, and changelog entries.
Review follow-ups include moving multiple-input validation before output planning, adding the flag to offline help coverage, providing the experiences-spec reference, and correcting stale URL-redaction claims in the PR description.

File	Description
`cli/azd/extensions/azure.ai.content-understanding/version.txt`	Bumps the extension preview version.
`cli/azd/extensions/azure.ai.content-understanding/README.md`	Documents default and pretty-printed analysis output.
`cli/azd/extensions/azure.ai.content-understanding/internal/preview/safety.go`	Filters terminal and bidi control characters.
`cli/azd/extensions/azure.ai.content-understanding/internal/preview/render.go`	Implements Markdown, metadata, table, card, and color rendering.
`cli/azd/extensions/azure.ai.content-understanding/internal/preview/render_test.go`	Tests rendering, safety, links, tables, cards, colors, layout, and cancellation.
`cli/azd/extensions/azure.ai.content-understanding/internal/preview/multilingual_test.go`	Tests multilingual table and card behavior.
`cli/azd/extensions/azure.ai.content-understanding/internal/preview/metadata.go`	Detects and preserves generated metadata blocks.
`cli/azd/extensions/azure.ai.content-understanding/internal/preview/metadata_test.go`	Tests metadata boundaries and opaque content.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/version.go`	Improves human-readable version output while preserving JSON output.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/root_test.go`	Tests version output behavior.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/infra.go`	Highlights commands, paths, and identifiers in provisioning guidance.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/infra_prompts.go`	Adds styling for prompts and guidance.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/infra_prompts_test.go`	Tests prompt, guidance, and no-color behavior.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/infra_host.go`	Styles subscription-selection prompts.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/diagnostics.go`	Adds guidance text highlighting helpers.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/analyze.go`	Registers, validates, and invokes `--pretty`.
`cli/azd/extensions/azure.ai.content-understanding/internal/cmd/analyze_render_test.go`	Tests pretty-print behavior, conflicts, redirects, reports, and output preservation.
`cli/azd/extensions/azure.ai.content-understanding/go.mod`	Promotes rendering libraries to direct dependencies.
`cli/azd/extensions/azure.ai.content-understanding/extension.yaml`	Updates the manifest version.
`cli/azd/extensions/azure.ai.content-understanding/docs/usage.md`	Documents pretty-print behavior, limitations, and compatibility.
`cli/azd/extensions/azure.ai.content-understanding/docs/provisioning.md`	Documents provisioning guidance and prompt colors.
`cli/azd/extensions/azure.ai.content-understanding/cspell.yaml`	Adds preview-specific spelling overrides.
`cli/azd/extensions/azure.ai.content-understanding/CHANGELOG.md`	Adds release notes for the feature and UX updates.

This pull request requires changes.

_{Review effort: Lite}

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

🟡 Changes recommended

An unresolved critical safety issue allows semicolonless encoded control characters to bypass preview filtering, and the new flag still lacks the required approved experiences-spec reference.

3 open issues

1 resolved since last review

Update the PR description to reflect preserved URL components

_{Review effort: Lite}

+	flags.BoolVarP(&options.pretty, "pretty", "p", false,
+		"Pretty-print one streamed LLM-input result in the terminal (default: original text)")


Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

🔵 Needs a closer look

Native Windows/macOS visual acceptance and repository-wide cross-platform validation remain outstanding for the terminal rendering and PTY-dependent progress behavior.

1 open issue

Provide the approved spec link for the new analyze flags

2 resolved since last review

_{Review effort: Lite}

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

🔵 Needs a closer look

Human assessment is needed because the change contains critical output-mode behavior that can corrupt documented JSON responses on interactive terminals, alongside a documentation inconsistency about supported flag combinations.

1 open issue

Provide the approved spec link for the new analyze flags

_{Review effort: Lite}

Chien Yuan Chang (chienyuanchang) and others added 6 commits October 27, 2026 09:56

fix(ai-cu): wrap analysis failure diagnostic for lint

69e7fb7

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

test(ai-cu): canonicalize analysis diagnostic output fixture

9469f0f

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

microsoft-github-policy-service Bot assigned Chien Yuan Chang (chienyuanchang) Oct 29, 2026

github-actions Bot added the ext-content-understanding azure.ai.content-understanding extension label Oct 29, 2026

Merge origin/main into ai-cu/terminal-markdown-rendering

749ccca

Preserve the merged CU provisioning and documentation updates while retaining the opt-in terminal Markdown renderer. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Chien Yuan Chang (chienyuanchang) changed the base branch from ai-cu/infra-interactive-parity to main November 3, 2026 22:31

fix(ai-cu): clarify version output and separate update notices

737e201

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Yung-Shin Lin (yungshinlintw) requested changes Nov 4, 2026

View reviewed changes

Chien Yuan Chang (chienyuanchang) and others added 8 commits November 4, 2026 10:22

refine test data

d58b9d3

fix(ai-cu): highlight provisioning guidance and prompt questions

73862d5

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

fix(ai-cu): rename terminal preview flag to pretty

6a20f26

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

docs(ai-cu): focus terminal preview guidance on user behavior

7172ecc

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

fix(ai-cu): clarify pretty-print help and color terminal tables

36bc5f6

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

docs(ai-cu): add release notes for terminal pretty-printing

5db056f

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

chore(ai-cu): bump extension version to 0.1.2-preview

226f84e

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

fix(ai-cu): preserve reference links across HTML tables

48c678e

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Chien Yuan Chang (chienyuanchang) mentioned this pull request Nov 5, 2026

fix(ai-cu): surface actionable analysis failure diagnostics #10857

Draft

Yung-Shin Lin (yungshinlintw) reviewed Nov 6, 2026

View reviewed changes

Comment thread cli/azd/extensions/azure.ai.content-understanding/internal/preview/render.go Resolved

Yung-Shin Lin (yungshinlintw) requested changes Nov 6, 2026

View reviewed changes

Chien Yuan Chang (chienyuanchang) and others added 2 commits November 6, 2026 11:07

reserve the completed URL

a0e165d

Chien Yuan Chang (chienyuanchang) marked this pull request as ready for review November 6, 2026 20:27

Chien Yuan Chang (chienyuanchang) requested a review from a team as a code owner November 6, 2026 20:27

Copilot AI lite review requested due to automatic review settings November 6, 2026 20:27

Copilot started reviewing on behalf of Chien Yuan Chang (chienyuanchang) November 6, 2026 20:27

View session

Copilot AI reviewed Nov 6, 2026

View reviewed changes

Comment thread cli/azd/extensions/azure.ai.content-understanding/internal/cmd/analyze.go Resolved

Comment thread cli/azd/extensions/azure.ai.content-understanding/internal/preview/render_test.go Resolved

Chien Yuan Chang (chienyuanchang) and others added 2 commits November 6, 2026 13:35

fix(ai-cu): show console analysis progress and correct endpoint guidance

22a1a00

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

fix(ai-cu): remove dimming from preview metadata and comments

ae4a56a

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Yung-Shin Lin (yungshinlintw) reviewed Nov 6, 2026

View reviewed changes

Comment thread cli/azd/extensions/azure.ai.content-understanding/CHANGELOG.md Resolved

feat(ai-cu): add pretty shorthand and simplify user documentation

fa34888

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI lite review requested due to automatic review settings November 6, 2026 22:04

Copilot started reviewing on behalf of Chien Yuan Chang (chienyuanchang) November 6, 2026 22:05

View session

Copilot AI reviewed Nov 6, 2026

View reviewed changes

fix(ai-cu): filter semicolonless encoded terminal controls

1c1dd44

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI lite review requested due to automatic review settings November 6, 2026 22:28

Copilot started reviewing on behalf of Chien Yuan Chang (chienyuanchang) November 6, 2026 22:29

View session

Copilot AI reviewed Nov 6, 2026

View reviewed changes

Chien Yuan Chang (chienyuanchang) mentioned this pull request Nov 6, 2026

docs(ai-cu): specify terminal pretty-printing experience #10869

Closed

fix(ai-cu): render empty cells and headerless preview tables

3b2c1ca

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI lite review requested due to automatic review settings November 7, 2026 00:13

Copilot started reviewing on behalf of Chien Yuan Chang (chienyuanchang) November 7, 2026 00:13

View session

Copilot AI reviewed Nov 7, 2026

View reviewed changes

Yung-Shin Lin (yungshinlintw) approved these changes Nov 7, 2026

View reviewed changes

		flags.BoolVarP(&options.pretty, "pretty", "p", false,
		"Pretty-print one streamed LLM-input result in the terminal (default: original text)")

Conversation

Chien Yuan Chang (chienyuanchang) commented Oct 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Usage and behavior

Validation

Limitations and remaining review

Uh oh!

azure-pipelines Bot commented Oct 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-sdk-automation Bot commented Nov 3, 2026

VSCode Extension Installation Instructions

Uh oh!

azure-sdk-automation Bot commented Nov 3, 2026

microsoft.azd.extensions PR build

Uh oh!

azure-sdk-automation Bot commented Nov 3, 2026

azure.ai.projects PR build

Uh oh!

azure-sdk-automation Bot commented Nov 3, 2026

azure.ai.toolboxes PR build

Uh oh!

azure-sdk-automation Bot commented Nov 3, 2026

microsoft.azd.concurx PR build

Uh oh!

azure-sdk-automation Bot commented Nov 3, 2026

azure.ai.agents PR build

Uh oh!

azure-sdk-automation Bot commented Nov 3, 2026

azure.ai.skills PR build

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

azure-sdk-automation Bot commented Nov 4, 2026

azure.ai.content-understanding PR build

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Chien Yuan Chang (chienyuanchang) commented Oct 29, 2026 •

edited

Loading

azure-pipelines Bot commented Oct 29, 2026 •

edited

Loading