Refactor CLI documentation

[ruben-arts]

To improve our CLI documentation there are a few points we would like to get to.

Auto generate as much as possible to avoid duplicate information

Auto generate the documentation from the CLI/Rust code so the information is alligned and auto updated.
For example nushell has tools for that aswell.

Test the documentation

Use snippets to get the code example from a file that will be tested in CI. To make sure the documented commands keep working while the code moves.

Split the reference into a page per subcommand

Take an example from npm or deno
Where the single page per command allows for more information without creating an unreadable file.