[GH-ISSUE #649] Automatic documentation of the cobra CLI #325

New issue

Open

opened 2026-02-25 23:33:57 +03:00 by kerem · 0 comments

kerem commented

2026-02-25 23:33:57 +03:00

Owner

Originally created by @fmartingr on GitHub (Jul 19, 2023).
Original GitHub issue: https://github.com/go-shiori/shiori/issues/649

To avoid manually editing the documentation each time we modify the CLI, we can use the same approach hostctl uses to generate the CLI documentation.

Completion criteria

Addition of a gen-cli-docs command in the Makefile that updates the docs/CLI.md with proper documentation of the CLI.
- This command should accept a destination path (that defaults to docs/CLI.md) to use in the CI.
A CI workflow that will run the command and compare it to the submitted docs/CLI.md to check if it is up to date, failing otherwise.

Originally created by @fmartingr on GitHub (Jul 19, 2023). Original GitHub issue: https://github.com/go-shiori/shiori/issues/649 To avoid manually editing the documentation each time we modify the CLI, we can use the same approach [hostctl uses](https://guumaster.github.io/hostctl/docs/cli-usage/add_domains/) to generate the CLI documentation. ## Completion criteria - Addition of a `gen-cli-docs` command in the `Makefile` that updates the `docs/CLI.md` with proper documentation of the CLI. - This command should accept a destination path (that defaults to `docs/CLI.md`) to use in the CI. - A CI workflow that will run the command and compare it to the submitted `docs/CLI.md` to check if it is up to date, failing otherwise.