automatically update the markdown command line help

Cargo.toml

@@ -34,6 +34,7 @@ clap = { version = "4.4.18", features = ["derive", "env", "wrap_help"] }
 clap-markdown = "0.1.3"
 clap-verbosity-flag = "2.1.2"
 clap_mangen = "0.2.18"
+clap_complete = "4.4.10"
 
 [profile.release]
 strip = "symbols"

build.rs

@@ -1,14 +1,16 @@
+use std::{fs, io::Write};
+
 include!("src/cli.rs");
 
 fn main() -> std::io::Result<()> {
     generate_man::<Cli>()?;
+    generate_markdown::<Cli>()?;
     Ok(())
 }
 
 fn generate_man<C: clap::CommandFactory>() -> std::io::Result<()> {
     let command = C::command();
-    let out_dir =
-        std::path::PathBuf::from(std::env::var_os("OUT_DIR").ok_or(std::io::ErrorKind::NotFound)?);
+    let out_dir: PathBuf = "docs".into();
     let name = command.get_name();
     let name = if name == "yage" {
         "yage.1".to_owned()
@@ -22,3 +24,10 @@ fn generate_man<C: clap::CommandFactory>() -> std::io::Result<()> {
     std::fs::write(fname, buffer)?;
     Ok(())
 }
+
+fn generate_markdown<C: clap::CommandFactory>() -> std::io::Result<()> {
+    let md = clap_markdown::help_markdown::<Cli>();
+    let mut f = fs::File::create("docs/CommandLineHelp.md")?;
+    write!(f, "{md}")?;
+    Ok(())
+}

docs/CommandLineHelp.md

@@ -14,9 +14,9 @@ This document contains the help content for the `yage` command-line program.
 
 ## `yage`
 
-A simple tool to manage encrypted secrets in YAML files.
+A simple tool to manage encrypted secrets in YAML files with age encryption
 
-**Usage:** `yage [OPTIONS] [COMMAND]`
+**Usage:** `yage [OPTIONS] <COMMAND>`
 
 ###### **Subcommands:**
 
@@ -194,4 +194,3 @@ The input key and output public key are in the age format, which is compatible w
     This document was generated automatically by
     <a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
 </i></small>
-

docs/yage.1

@@ -0,0 +1,55 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH yage 1  "yage 0.1.0" 
+.SH NAME
+yage \- A simple tool to manage encrypted secrets in YAML files with age encryption
+.SH SYNOPSIS
+\fByage\fR [\fB\-\-completion\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR]... [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
+.SH DESCRIPTION
+A simple tool to manage encrypted secrets in YAML files with age encryption
+.SH OPTIONS
+.TP
+\fB\-\-completion\fR=\fISHELL\fR
+Generate the completion code for this shell
+.br
+
+.br
+[\fIpossible values: \fRbash, elvish, fish, powershell, zsh]
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Increase logging verbosity
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Decrease logging verbosity
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Print version
+.SH SUBCOMMANDS
+.TP
+yage\-decrypt(1)
+Decrypt the values in a YAML file
+.TP
+yage\-edit(1)
+Edit an encrypted YAML file
+.TP
+yage\-encrypt(1)
+Encrypt the values in a YAML file
+.TP
+yage\-env(1)
+Execute a command with the environment from the encrypted YAML file
+.TP
+yage\-keygen(1)
+Generate a new age key
+.TP
+yage\-pubkey(1)
+Convert private age keys to their public key
+.TP
+yage\-help(1)
+Print this message or the help of the given subcommand(s)
+.SH VERSION
+v0.1.0
+.SH AUTHORS
+Gaëtan Lehmann <gaetan.lehmann@gmail.com>