feat: allow skipping groups and add readme

Signed-off-by: James Petersen <jpetersenames@gmail.com>

Author: found-it

README.md

@@ -0,0 +1,62 @@
+# Preflight CLI
+
+Internal CLI to run **pre-deployment checks** before running workloads.  
+Checks are organized into groups (e.g., `System Checks`, `Scripted Checks`) and controlled via environment variables.  
+
+---
+
+## Usage
+
+Run inside Docker:
+
+```bash
+docker run \
+  --env RUST_LOG=debug \
+  --env EDERA_PREFLIGHT_VERBOSE=true \
+  --env EDERA_PREFLIGHT_SKIP_GROUPS='ScriptedChecks;SystemChecks' \
+  --env EDERA_PREFLIGHT_SCRIPTS_DIR=/scripts \
+  <image>
+```
+
+---
+
+## Environment Variables
+
+| Variable                      | Description                                            | Example                       |
+| ----------------------------- | ------------------------------------------------------ | ----------------------------- |
+| `RUST_LOG`                    | Log level (`error`, `warn`, `info`, `debug`, `trace`). | `debug`                       |
+| `EDERA_PREFLIGHT_VERBOSE`     | Enable verbose output (`true`/`false`).                | `true`                        |
+| `EDERA_PREFLIGHT_SKIP_GROUPS` | Semicolon-separated list of groups to skip.            | `SystemChecks;ScriptedChecks` |
+| `EDERA_PREFLIGHT_SCRIPTS_DIR` | Directory containing custom shell-script checks.       | `/scripts`                    |
+
+---
+
+## Example Output
+
+```text
+[2025-09-17T05:05:33Z INFO  preflight] Running Group [System Checks] - System requirement checks
+[2025-09-17T05:05:33Z DEBUG preflight::system] total memory = 66617298944
+[2025-09-17T05:05:33Z ERROR preflight] [System Checks] Errored: group errored
+[2025-09-17T05:05:33Z INFO  preflight] [System Checks] Enough Memory: Passed
+[2025-09-17T05:05:33Z ERROR preflight] [System Checks] Should Error: Errored: Pretending to error
+[2025-09-17T05:05:33Z WARN  preflight] [System Checks] Should Fail: Failed: Pretending to fail
+[2025-09-17T05:05:33Z INFO  preflight] Running Group [Scripted Checks] - Checks composed through small shell scripts
+[2025-09-17T05:05:33Z ERROR preflight] [Scripted Checks] Errored: group errored
+[2025-09-17T05:05:33Z INFO  preflight] [Scripted Checks] Should Pass: Passed
+[2025-09-17T05:05:33Z WARN  preflight] [Scripted Checks] Should Fail: Failed: script returned Some(1)
+[2025-09-17T05:05:33Z ERROR preflight] [Scripted Checks] /totally/fake/script: Errored: No such file or directory (os error 2)
+Error: checks failed
+```
+
+* **INFO** → check passed or group started
+* **WARN** → check failed
+* **ERROR** → check errored or group errored
+
+Exit code is **non-zero** if any check/group fails or errors.
+
+---
+
+## Notes
+
+* Use `EDERA_PREFLIGHT_SKIP_GROUPS` to bypass slow or irrelevant checks.
+* Script-based checks must be **executable** and located in `EDERA_PREFLIGHT_SCRIPTS_DIR`.

src/main.rs

@@ -9,18 +9,27 @@ use anyhow::{Result, bail};
 use log::info;
 use std::env;
 
+// Skip certain groups. List is separated by ;
+fn skip_groups() -> Vec<String> {
+    let skips = env::var("EDERA_PREFLIGHT_SKIP_GROUPS").unwrap_or_default();
+    skips.split(";").map(|s| s.to_string()).collect()
+}
+
 fn main() -> Result<()> {
     env_logger::init();
 
     let groups: Vec<Box<dyn CheckGroup>> = vec![Box::new(SystemChecks), Box::new(ScriptChecks)];
 
     let mut final_result = Passed;
+    let skip_groups = skip_groups();
 
     // Run each check group
     for group in groups {
-        // if group.id() == "ScriptedChecks" {
-        //     continue;
-        // }
+        // Check if we need to explicity skip this group
+        if skip_groups.iter().any(|skip| group.id() == skip) {
+            continue;
+        }
+
         info!("Running Group [{}] - {}", group.name(), group.description());
         let check_group_result = group.run();
         check_group_result.log_group();