Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document API of machine readable command line output #2840

Open
3 tasks done
mink99 opened this issue Feb 19, 2025 · 0 comments
Open
3 tasks done

Document API of machine readable command line output #2840

mink99 opened this issue Feb 19, 2025 · 0 comments
Labels
topic: CLI Related to the command line interface topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@mink99
Copy link

mink99 commented Feb 19, 2025

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
@mink99 mink99 added the type: enhancement Proposed improvement label Feb 19, 2025
@per1234 per1234 added topic: documentation Related to documentation for the project topic: CLI Related to the command line interface labels Feb 19, 2025
@per1234 per1234 changed the title Simplify the Integration of Arduino-cli into external tools : JSON Document API of machine readable command line output Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: CLI Related to the command line interface topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants