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 a Features section to the CLI page on the website #261

Open
stevenpav-helm opened this issue Feb 24, 2025 · 3 comments
Open

Add a Features section to the CLI page on the website #261

stevenpav-helm opened this issue Feb 24, 2025 · 3 comments

Comments

@stevenpav-helm
Copy link

I just took air for a spin, but could not find any information here, or on the post website, about how to actually call air from the command line. Moreover, calling

air --help

only tells me I need a COMMAND, but not the list of available commands. It was only after some searching through the docs that I found I could call

air format .

This is not immediately apparent from any of the docs.

@DavisVaughan
Copy link
Collaborator

DavisVaughan commented Feb 24, 2025

Image

<COMMAND> is followed by a Commands header, I am hopeful that is pretty clear about what you should call

@stevenpav-helm
Copy link
Author

Hmm, thanks, I somehow missed that as well. I should say, the command line usage is not documented in the otherwise very good HTML documentation for this package. For example command line interface only details how to install the CLI tool, but not how to use it.

@DavisVaughan DavisVaughan changed the title document CLI usage somewhere Add a Features section to the CLI page on the website Feb 25, 2025
@DavisVaughan
Copy link
Collaborator

Ah yea we should probably add some more detail there, I think that makes sense

@DavisVaughan DavisVaughan reopened this Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants