unit-docs
unit-docs copied to clipboard
docs: add CLI doc draft
Adds the doc for the unitctl cli
To do:
- Add the links to the binaries or remove the section
- Decide whether to add the compiling instructions here or keep them as a link to the repo
Decide whether to add the compiling instructions here or keep them as a link to the repo
My vote is to link to the repo for this. The instructions may change along with planned improvements to the unitctl design. If we link to the repo unitctl readme then readers will always be pointed to the most up to date instructions.
Add the links to the binaries or remove the section
I believe a good option here is to link to the github releases section in the Unit repo, as that will populate with download links for the CLI.
Add the links to the binaries or remove the section
I believe a good option here is to link to the github releases section in the Unit repo, as that will populate with download links for the CLI.
I don't see a releases section in the Unit repo currently
I see that we have a global section for options. I am curious if there should perhaps be a section for options per subcommand?
I also note that there is a subcommand missing (export).
the list of command and options is based on the documentation in the repo. The export command is missing there too. Where could I get a comprehensive list of the options for each command?
Add the links to the binaries or remove the section
I believe a good option here is to link to the github releases section in the Unit repo, as that will populate with download links for the CLI.
I don't see a releases section in the Unit repo currently
https://github.com/nginx/unit/releases The section is there, and will be populated with the upcoming 1.33 release
I see that we have a global section for options. I am curious if there should perhaps be a section for options per subcommand? I also note that there is a subcommand missing (export).
the list of command and options is based on the documentation in the repo. The export command is missing there too. Where could I get a comprehensive list of the options for each command?
https://github.com/nginx/unit/tree/master/tools/unitctl#export-configuration-from-a-running-unit-instance
It is listed here.
EDIT: I see that you found and included it, thank you :)