Document API of machine readable command line output
Opened this issue · 0 comments
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