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

Add in-app help for CLI options + autodocumentation #2494

Closed
waydabber opened this issue Jan 2, 2024 · 2 comments
Closed

Add in-app help for CLI options + autodocumentation #2494

waydabber opened this issue Jan 2, 2024 · 2 comments
Assignees
Labels
done All tasks are completed enhancement New feature or request integration Command-line interface released Released
Milestone

Comments

@waydabber
Copy link
Owner

Add some in-app help system to the CLI options. This should possibly auto-generate a help that can then exported to a wiki page as well.

@waydabber waydabber added enhancement New feature or request in progress Implementing unreleased Not released yet in beta form integration Command-line interface labels Jan 2, 2024
@waydabber waydabber added this to the v2.2.0 milestone Jan 2, 2024
@waydabber waydabber self-assigned this Jan 2, 2024
@waydabber
Copy link
Owner Author

CLI help will not be localized (it could be, it's just a design choice as CLI commands use English anyway).

@waydabber
Copy link
Owner Author

waydabber commented Jan 8, 2024

Here is how to invoke help (using HTTP but works with CLI or URL schema integration method as well):

curl ht*tp://localhost:55777/help

The help is dynamically generated and produced in an md format so it's easy to update the integration wiki page with its contents when something changes: https://github.com/waydabber/BetterDisplay/wiki/Integration-features,-CLI

Help can be specific, so the following example will only print help for the set and get operations, feature parameter and brightness feature (as an example):

curl ht*tp://localhost:55777/help/get/set\?feature=brightness

@waydabber waydabber added done All tasks are completed pre-release available Released as beta version and removed in progress Implementing unreleased Not released yet in beta form labels Jan 8, 2024
@waydabber waydabber added released Released and removed pre-release available Released as beta version labels Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
done All tasks are completed enhancement New feature or request integration Command-line interface released Released
Projects
None yet
Development

No branches or pull requests

1 participant