`runme run` arguments not documented in CLI

[christian-bromann]

Given runme version 1.0.2 (062f5eae9e600244ea23ecc69c6c1cc06c8068de) on 2023-04-18T20:49:06Z

Calling runme run --help prints

Run a selected command identified based on its unique parsed name.

Usage:
  runme run [flags]

Aliases:
  run, exec

Flags:
      --dry-run               Print the final command without executing.
  -h, --help                  Help for run
  -r, --replace stringArray   Replace instructions using sed.
  -s, --server string         Server address to connect runner to
      --tls string            Directory for TLS authentication (default "/Users/christianbromann/.config/stateful/tls")

Global Flags:
      --allow-unknown     Display snippets without known executor (default true)
      --chdir string      Switch to a different working directory before executing the command (default "/Users/christianbromann/Sites/Stateful/projects/runmejs")
      --filename string   Name of the README file (default "README.md")
      --insecure          Run command in insecure-mode

Which shows no documentation or examples of the required arguments. So users might think none are required but running runme run returns with:

accepts 1 arg(s), received 0

Let's make sure the CLI is documented correctly and has examples on how to use it.

[christian-bromann]

@sourishkrout @admc I could put something together here that is inspired from what our friends over at fly.io are doing. They use a similar stack as we do. How about the following:

• add this workflow which triggers when a tag was pushed
• have this go file generate markdown files with documentation on all commands we have
• let this script check the new files into a branch and create a PR to our docs repository

We could have a new CLI page in our docs that includes all these files. Seems straight forward and and an easy win. Wdyt?