Document env vars
Closes
@@ -109,6 +109,12 @@ enum Command {
Check,
/// Publish the project to the Hex package manager
+ ///
+ /// This command uses this environment variables:
+ ///
+ /// - HEXPM_USER: (optional) The Hex username to authenticate with.
+ /// - HEXPM_PASS: (optional) The Hex password to authenticate with.
+ #[clap(verbatim_doc_comment)]
Publish {
#[clap(long)]
replace: bool,
@@ -269,6 +275,12 @@ enum Dependencies {
#[derive(Subcommand, Debug)]
enum Hex {
/// Retire a release from Hex
+ ///
+ /// This command uses this environment variables:
+ ///
+ /// - HEXPM_USER: (optional) The Hex username to authenticate with.
+ /// - HEXPM_PASS: (optional) The Hex password to authenticate with.
+ #[clap(verbatim_doc_comment)]
Retire {
package: String,
@@ -281,6 +293,12 @@ enum Hex {
},
/// Un-retire a release from Hex
+ ///
+ /// This command uses this environment variables:
+ ///
+ /// - HEXPM_USER: (optional) The Hex username to authenticate with.
+ /// - HEXPM_PASS: (optional) The Hex password to authenticate with.
+ #[clap(verbatim_doc_comment)]
Unretire { package: String, version: String },
}
@@ -290,9 +308,21 @@ enum Docs {
Build,
/// Publish HTML docs to HexDocs
+ ///
+ /// This command uses this environment variables:
+ ///
+ /// - HEXPM_USER: (optional) The Hex username to authenticate with.
+ /// - HEXPM_PASS: (optional) The Hex password to authenticate with.
+ #[clap(verbatim_doc_comment)]
Publish,
/// Remove HTML docs from HexDocs
+ ///
+ /// This command uses this environment variables:
+ ///
+ /// - HEXPM_USER: (optional) The Hex username to authenticate with.
+ /// - HEXPM_PASS: (optional) The Hex password to authenticate with.
+ #[clap(verbatim_doc_comment)]
Remove {
/// The name of the package
#[clap(long)]
