Skip to content

JSON Formatted Output Support #184

Description

Relevant area(s)

  • WinGet CLI

Description of the new feature / enhancement

Parent / tracking issue for structured, machine-readable output in WinGet.

To enable automation and consumption by other tools, WinGet commands should be able to emit structured output (e.g. JSON) in addition to the default human-readable tables. Parsing the default console output is brittle; a stable structured format lets scripts and tools consume results reliably.

This issue tracks the overall effort; individual slices are tracked as sub-issues / related work below.

Scope

  • A consistent --format json (and potentially other structured formats) across commands that produce output — e.g. list, upgrade, search, show, export.
  • A stable, documented schema for each command's structured output.
  • Where appropriate, keep the shape of the structured output (field names and structure) aligned with the objects returned by the WinGet PowerShell module, so consumers get a consistent schema across the CLI and the module rather than two divergent shapes.
  • Well-defined behavior for empty results and error paths so output stays parseable.

Related work and sub-issues

Out of scope (separate concerns)

  • Output verbosity — how much WinGet prints to the console (tracked in Client Verbosity Settings #161).
  • Diagnostic log level — a distinct concern from output format.

Updated with GitHub Copilot.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Issue-FeatureThis is a feature request for the Windows Package Manager client.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions