Add basalt CLI layer (#510)

Author: erikjuhani

Cargo.lock

@@ -1,6 +1,6 @@
 # Changelog
 
-## [0.12.5](https://github.com/erikjuhani/basalt/releases/tag/basalt/0.12.5) (Unreleased)
+## [0.12.5](https://github.com/erikjuhani/basalt/releases/tag/basalt/0.12.5) (May, 16 2026)
 
 ### Added
 
@@ -17,6 +17,13 @@
 > the scrollbar is always shown if we have more than 4 items regardless if
 > we have space to show all items and not needing a scrollbar.
 
+- [8e248e7](https://github.com/erikjuhani/basalt/commit/8e248e736afd27a36ba941479f68c8fa858bda9f) Add basalt CLI layer
+
+> Initial CLI layer with --version and --help flags. The version output is
+> in a "standard" format similar to cargo version output `0.12.5 (abc123def 2026-05-15)`.
+>
+> The values are populated by a build phase (compile time) using env vars.
+
 ### Changed
 
 - [022d988](https://github.com/erikjuhani/basalt/commit/022d988f1709a10d4ef45449e4a138390b585339) Add indentation to floating rename input by @erikjuhani
@@ -131,7 +138,7 @@
 > case, which then effectively retains the scroll position of the
 > viewport.
 
-- [79082f3](https://github.com/erikjuhani/basalt/commit/79082f317efc499febb6bc7c892cd7f6c84b2887) Use config symbols for status bar component badge
+- [79082f3](https://github.com/erikjuhani/basalt/commit/79082f317efc499febb6bc7c892cd7f6c84b2887) Use config symbols for status bar component badge by @erikjuhani
 
 > Pass the configured symbol preset into StatusBar so the active component
 > badge falls back to ASCII-safe glyphs when the Ascii preset is selected.

basalt/CHANGELOG.md

@@ -13,6 +13,7 @@ default-run = "basalt"
 
 [dependencies]
 basalt-core = { path = "../basalt-core", version = "0.9.0" }
+clap = { version = "4.6.1", features = ["derive", "string"] }
 ratatui = { version = "0.30.0" }
 crossterm = "0.29.0"
 pulldown-cmark = "0.13.0"

basalt/Cargo.toml

@@ -0,0 +1,60 @@
+use std::{env, path::Path, process::Command};
+
+fn main() {
+    let Some(commit_info) = commit_info() else {
+        return;
+    };
+
+    let version = env::var("CARGO_PKG_VERSION").unwrap();
+
+    println!(
+        "cargo:rustc-env=BASALT_COMMIT_SHORT_HASH={}",
+        commit_info.short_hash
+    );
+    println!("cargo:rustc-env=BASALT_COMMIT_HASH={}", commit_info.hash);
+    println!("cargo:rustc-env=BASALT_COMMIT_DATE={}", commit_info.date);
+    println!("cargo:rustc-env=BASALT_VERSION={version}");
+}
+
+struct CommitInfo {
+    hash: String,
+    short_hash: String,
+    date: String,
+}
+
+fn commit_info() -> Option<CommitInfo> {
+    let manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
+    let workspace_root = Path::new(&manifest_dir).parent()?;
+
+    // Not a git directory
+    if !workspace_root.join(".git").exists() {
+        return None;
+    }
+
+    // Reference for commit info output: https://github.com/rust-lang/cargo/blob/a967402/build.rs#L60
+    let output = match Command::new("git")
+        .arg("log")
+        .arg("-1")
+        .arg("--date=short")
+        .arg("--format=%H %h %cd")
+        .arg("--abbrev=9")
+        .output()
+    {
+        Ok(output) if output.status.success() => Some(output),
+        _ => None,
+    }?;
+
+    let stdout = String::from_utf8(output.stdout).unwrap();
+    let stdout = stdout.trim();
+    let mut parts = stdout.split_whitespace().map(|s| s.to_string());
+
+    let hash = parts.next()?;
+    let short_hash = parts.next()?;
+    let date = parts.next()?;
+
+    Some(CommitInfo {
+        hash,
+        short_hash,
+        date,
+    })
+}

basalt/build.rs

@@ -0,0 +1,38 @@
+use clap::Parser;
+
+use crate::version;
+
+const VERSION_INFO: version::VersionInfo = version::VersionInfo::from_env();
+
+#[derive(Parser)]
+#[command(name = "basalt", version = VERSION_INFO.to_string())]
+pub struct Cli {}
+
+#[cfg(test)]
+mod tests {
+    use clap::CommandFactory;
+
+    use crate::{cli::Cli, version};
+
+    #[test]
+    fn version_output() {
+        let help = Cli::command()
+            .version(
+                version::VersionInfo {
+                    version: "0.12.5",
+                    short_hash: "abc123def",
+                    date: "2026-05-15",
+                }
+                .to_string(),
+            )
+            .render_version()
+            .to_string();
+        insta::assert_snapshot!(help)
+    }
+
+    #[test]
+    fn help_output() {
+        let help = Cli::command().render_help().to_string();
+        insta::assert_snapshot!(help)
+    }
+}

basalt/src/cli.rs

@@ -1,4 +1,5 @@
 pub mod app;
+pub mod cli;
 pub mod command;
 pub mod config;
 pub mod explorer;
@@ -13,3 +14,4 @@ pub mod text_counts;
 pub mod toast;
 pub mod vault_selector;
 pub mod vault_selector_modal;
+pub mod version;

basalt/src/lib.rs

@@ -1,9 +1,12 @@
+use clap::Parser;
 use std::path::PathBuf;
 
 use basalt_core::obsidian::{self, Error, Vault};
-use basalt_tui::app::App;
+use basalt_tui::{app::App, cli::Cli};
 
 fn main() -> Result<(), Error> {
+    let _cli = Cli::parse();
+
     let obsidian_config = obsidian::config::load().unwrap();
     let vaults = obsidian_config.vaults();
 

basalt/src/main.rs

@@ -0,0 +1,9 @@
+---
+source: basalt/src/cli.rs
+expression: help
+---
+Usage: basalt
+
+Options:
+  -h, --help     Print help
+  -V, --version  Print version

basalt/src/snapshots/basalt_tui__cli__tests__help_output.snap

@@ -0,0 +1,5 @@
+---
+source: basalt/src/cli.rs
+expression: help
+---
+basalt 0.12.5 (abc123def 2026-05-15)

basalt/src/snapshots/basalt_tui__cli__tests__version_output.snap

@@ -0,0 +1,34 @@
+use std::fmt;
+
+#[derive(Debug, Clone, PartialEq, Default)]
+pub struct VersionInfo {
+    pub version: &'static str,
+    pub short_hash: &'static str,
+    pub date: &'static str,
+}
+
+impl VersionInfo {
+    pub const fn from_env() -> Self {
+        Self {
+            version: env!("BASALT_VERSION"),
+            short_hash: env!("BASALT_COMMIT_SHORT_HASH"),
+            date: env!("BASALT_COMMIT_DATE"),
+        }
+    }
+}
+
+impl fmt::Display for VersionInfo {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{} ({} {})", self.version, self.short_hash, self.date)
+    }
+}
+
+#[test]
+fn version_format() {
+    let info = VersionInfo {
+        version: "0.12.5",
+        short_hash: "abc123def",
+        date: "2026-05-15",
+    };
+    assert_eq!(info.to_string(), "0.12.5 (abc123def 2026-05-15)");
+}