List all CLI options in Docs

[Geoffrotism]

I have looked through the OPA docs (https://www.openpolicyagent.org/docs/latest/) for a few weeks and still have problems knowing what CLI options I have available to me.
The Debugging Page says that I can use --explain to see trace logging but this is only available during SOME CLI commands. Like the fact that is says i can use explain but I can really only do that during EVAL or TEST and not during RUN is confusing.

A singular DOC page which lists out all of the CLI commands and flags available for each command would be so helpful.

I know this is usually available by running opa run help etc. but I don't have OPA installed locally and have it running through the docker image instead.

[anderseknert]

Hi @Geoffrotism! And thank you for suggesting this. I think the ease of providing the --help flag for the various commands has been the main reason not to duplicate the information online.. but if many feel this would help, I guess it could be considered.

If you are running OPA through Docker, docker run openpolicyagent/opa <command> --help should work as well.

[srenatus]

I've never looked at it too closely, but we've got some man page generation here, #2273. I suppose that could play a part here. If I understand you correctly, a web-accessible version of the man pages would help.

[srenatus]

https://github.com/spf13/cobra/blob/v1.2.1/doc/md_docs.md could be useful, too

[Geoffrotism]

Yes, a programmatically generated page from the CLI man would be the best solution IMO. It does exactly what I was looking for without putting a burden on the devs to keep it up to date.

[tsandall]

@Geoffrotism thanks for filing this and replying. I've filed another issue that's a bit more prescriptive about how to move forward. I'm going to close this one in favor of the new issue.