Skip to content

Document API of machine readable command line output #2840

Open
@mink99

Description

@mink99

Describe the request

The JSON Output, structure and semantics are not really documented, changes in the output of the various commands will break applications that rely on parsing this output.
Without a fully documented JSON and a dedicated changelog, currenty the creation/update of parsers (in c++) relies on creating samples of various output, running them through quicktype (https://app.quicktype.io/) and merging the results (and praying that there were sufficient samples).

So I would ask to provide proper and full documentation and changelogs for the various json outputs.

Describe the current behavior

The JSON Output of various commands , structure and semantics are not really documented, changes in the output of the various commands will break applications that rely on parsing this output.

Arduino CLI version

all

Operating system

Windows

Operating system version

10,11

Additional context

No response

Issue checklist

  • I searched for previous requests in the issue tracker
  • I verified the feature was still missing when using the nightly build
  • My request contains all necessary details

Metadata

Metadata

Assignees

No one assigned

    Labels

    topic: CLIRelated to the command line interfacetopic: documentationRelated to documentation for the projecttype: enhancementProposed improvement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions