Allow setting some command-line options with environment variables (c…

…asey#2044)
neunenak · May 18, 2024 · bf027e3 · bf027e3
1 parent 4f18aab
commit bf027e3
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1395,7 +1395,6 @@ $ just
 The process ID is: 420
 ```
 
-
 #### String Manipulation
 
 - `append(suffix, s)`<sup>master</sup> Append `suffix` to whitespace-separated
@@ -2583,7 +2582,21 @@ $ just --show polyglot
 polyglot: python js perl sh ruby
 ```
 
-Run `just --help` to see all the options.
+Some command-line options can be set with environment variables. For example:
+
+```sh
+$ export JUST_UNSTABLE=1
+$ just
+```
+
+Is equivalent to:
+
+```sh
+$ just --unstable
+```
+
+Consult `just --help` to see which options can be set from environment
+variables.
 
 ### Private Recipes
 

diff --git a/src/config.rs b/src/config.rs
@@ -177,6 +177,7 @@ impl Config {
       .arg(
         Arg::new(arg::COLOR)
           .long("color")
+          .env("JUST_COLOR")
           .action(ArgAction::Set)
           .value_parser(PossibleValuesParser::new(arg::COLOR_VALUES))
           .default_value(arg::COLOR_AUTO)
@@ -185,6 +186,7 @@ impl Config {
       .arg(
         Arg::new(arg::COMMAND_COLOR)
           .long("command-color")
+          .env("JUST_COMMAND_COLOR")
           .action(ArgAction::Set)
           .value_parser(PossibleValuesParser::new(arg::COMMAND_COLOR_VALUES))
           .help("Echo recipe lines in <COMMAND-COLOR>"),
@@ -194,6 +196,7 @@ impl Config {
         Arg::new(arg::DRY_RUN)
           .short('n')
           .long("dry-run")
+          .env("JUST_DRY_RUN")
           .action(ArgAction::SetTrue)
           .help("Print what just would do without doing it")
           .conflicts_with(arg::QUIET),
@@ -258,6 +261,7 @@ impl Config {
         Arg::new(arg::JUSTFILE)
           .short('f')
           .long("justfile")
+          .env("JUST_JUSTFILE")
           .action(ArgAction::Set)
           .value_parser(value_parser!(PathBuf))
           .help("Use <JUSTFILE> as justfile"),
@@ -266,6 +270,7 @@ impl Config {
         Arg::new(arg::QUIET)
           .short('q')
           .long("quiet")
+          .env("JUST_QUIET")
           .action(ArgAction::SetTrue)
           .help("Suppress all output")
           .conflicts_with(arg::DRY_RUN),
@@ -325,13 +330,15 @@ impl Config {
         Arg::new(arg::VERBOSE)
           .short('v')
           .long("verbose")
+          .env("JUST_VERBOSE")
           .action(ArgAction::Count)
           .help("Use verbose output"),
       )
       .arg(
         Arg::new(arg::WORKING_DIRECTORY)
           .short('d')
           .long("working-directory")
+          .env("JUST_WORKING_DIRECTORY")
           .action(ArgAction::Set)
           .value_parser(value_parser!(PathBuf))
           .help("Use <WORKING-DIRECTORY> as working directory. --justfile must also be set")