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.

Sign up for GitHub

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

Jump to bottom

Document CLI commands and usage #143

Open
Dekkonot opened this issue May 28, 2024 · 1 comment
Open

Document CLI commands and usage #143

Dekkonot opened this issue May 28, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@Dekkonot
Copy link
Member

We currently don't document usage of the CLI at all in the docs. While this isn't terrible because we have a very helpful --help flag built into the CLI, I think we should include the CLI in docs still.

I'd probably want to look at how other tools do their documentation before tackling this.
@Dekkonot Dekkonot added the enhancement New feature or request label May 28, 2024
@Barocena
Copy link
Contributor

we can use this layout for CLI usage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Dekkonot @Barocena