Skip to content

Add support for passing most common CLI options via enviromment variables #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 1, 2025
Merged

Add support for passing most common CLI options via enviromment variables #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06834ee
Derive Debug for Cli
sirhcel Sep 30, 2025
1b1df13
Allow specifying two common options via env
sirhcel Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Rust applications or any other applications.
"""

[dependencies]
clap = { version = "4.5.48", features = ["derive"] }
clap = { version = "4.5.48", features = ["derive", "env"] }
sysfs_gpio = "0.6.2"
toml = { version = "<=0.9.6", default-features = false, features = ["parse", "serde"] }
glob = "0.3.3"
Expand Down
19 changes: 11 additions & 8 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,24 @@ use gpio_utils::config::{self, GpioConfig};
use gpio_utils::options::*;
use std::process;

#[derive(Parser)]
pub const CONFIG_ENV_VAR: &str = "GPIO_UTILS_CONFIG";
pub const SYMLINK_ROOT_ENV_VAR: &str = "GPIO_UTILS_SYMLINK_ROOT";

#[derive(Debug, Parser)]
#[command(
name = "GPIO Utils",
version,
about = "Read, Write, and Configure GPIOs"
)]
struct Cli {
/// additional configuration to use
#[arg(short, long = "config", value_name = "FILE")]
/// additional configuration to use (separator ':')
#[arg(short, long = "config", value_name = "FILE", num_args = 0.., env = CONFIG_ENV_VAR, value_delimiter = ':')]
configs: Vec<String>,
#[command(subcommand)]
command: Commands,
}

#[derive(Subcommand)]
#[derive(Debug, Subcommand)]
enum Commands {
/// Read the value of a GPIO Input
Read {
Expand Down Expand Up @@ -56,27 +59,27 @@ enum Commands {
/// The pin name (or number)
pin: String,
/// root directory for export symlinks
#[arg(short = 'r', long)]
#[arg(short = 'r', long, env = SYMLINK_ROOT_ENV_VAR)]
symlink_root: Option<String>,
},
/// Export all configured GPIOs
ExportAll {
/// Export all configured GPIOs
#[arg(short = 'r', long)]
#[arg(short = 'r', long, env = SYMLINK_ROOT_ENV_VAR)]
symlink_root: Option<String>,
},
/// Export all configured GPIOs
Unexport {
/// The pin name (or number)
pin: String,
/// root directory for export symlinks
#[arg(short = 'r', long)]
#[arg(short = 'r', long, env = SYMLINK_ROOT_ENV_VAR)]
symlink_root: Option<String>,
},
/// Unexport all configured, exported GPIOs
UnexportAll {
/// root directory for export symlinks
#[arg(short = 'r', long)]
#[arg(short = 'r', long, env = SYMLINK_ROOT_ENV_VAR)]
symlink_root: Option<String>,
},
/// Output status of a GPIO or all GPIOs if no pin is specified
Expand Down