TUI Application to manage Obsidian notes
TUI Application to manage Obsidian vaults and notes directly from the terminal ✨.
Basalt is a cross-platform TUI (Terminal User Interface) for managing Obsidian vaults and notes. It runs on Windows, macOS, and Linux. Basalt is not a replacement for Obsidian. Instead, it provides a minimalist terminal interface with a WYSIWYG experience.
Install Basalt using Cargo:
cargo install basalt-tuiOr download a pre-compiled binary from the latest release, extract it, and move the basalt binary to a location in your PATH.
Basalt can be customized using a TOML configuration file. The file does not exist by default — create it manually when you want to override the defaults.
macOS and Linux:
$HOME/.basalt.toml$XDG_CONFIG_HOME/basalt/config.toml
Windows:
%USERPROFILE%\.basalt.toml%APPDATA%\basalt\config.toml
If configuration files exist in multiple locations, only the first one found is used. The home directory configuration takes precedence.
Warning
This behavior may change in future versions to merge all found configurations instead.
See the full configuration reference for key mappings, custom commands, and defaults.
- Getting started
- User interface
- Configuration
- Editing and Formatting
- Files and Folders
- Known Limitations
Contributions are welcome, primarily for bug fixes. Feature work is considered on a case-by-case basis — please open an issue first to discuss.
See CONTRIBUTING.md for development setup, code style, and contribution guidelines.