feat: add env configuration for upstream and ssh key (#14)

Cargo.toml

@@ -8,7 +8,7 @@ description = "A tool to prune merged remote branches from the local repository.
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-clap = { version = "4.5.7", features = ["derive"] }
+clap = { version = "4.5.7", features = ["derive", "color", "env"] }
 color-eyre = "0.6.3"
 const_format = "0.2.32"
 git-version = "0.3.9"

README.md

@@ -37,3 +37,18 @@ Delete the branches
 
 ```
 > git superprune -h
+Prune local branches that no longer exist on the remote
+
+Usage: git-superprune [OPTIONS] [ROOT]
+
+Arguments:
+  [ROOT]  Root directory of the git repository
+
+Options:
+  -v, --verbose              Display verbose output
+  -u, --upstream <UPSTREAM>  run `git remote prune <upstream>` before scanning [env: SUPERPRUNE_UPSTREAM_REMOTE=origin]
+  -s, --ssh-key <SSH_KEY>    SSH key in `~/.ssh/`` to use for authentication with remote, defaults to `id_rsa` [env: SUPERPRUNE_SSH_KEY=]
+  -x, --execute              Execute the branch deletion
+  -h, --help                 Print help
+  -V, --version              Print version
+```

src/main.rs

@@ -30,11 +30,11 @@ struct Args {
     verbose: bool,
 
     /// run `git remote prune <upstream>` before scanning
-    #[clap(short, long, required = false)]
+    #[clap(short, long, required = false, env = "SUPERPRUNE_UPSTREAM_REMOTE")]
     upstream: Option<String>,
 
     /// SSH key in `~/.ssh/`` to use for authentication with remote, defaults to `id_rsa`
-    #[clap(short, long, required = false)]
+    #[clap(short, long, required = false, env = "SUPERPRUNE_SSH_KEY")]
     ssh_key: Option<String>,
 
     #[clap(short('x'), long, default_value = "false")]