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 readable markdown rendering and a WYSIWYG experience.
- Basalt functions as a companion app for Obsidian that enables quick note editing without interrupting the terminal flow
- Basalt enables text editing in a familiar way (Obsidian, vim) without having to rely on external editors
- Basalt is a terminal based WYSIWYG markdown editor
- Basalt works as a CLI for finding / deleting / creating notes and works with the rest of the unix tooling
- Basalt is a standalone terminal note managing application that works seamlessly with Obsidian
Install basalt using cargo:
cargo install basalt-tuiOr use the precompiled binaries from the latest release.
Basalt can be customized using a configuration file located in one of the following directories:
macOS and Unix:
$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.
Key mappings can be modified or extended in the configuration file.
Each key mapping is associated with a specific pane and becomes active when that pane has focus. The [global] section applies to all panes and is evaluated first.
See the full default configuration.
See the docs for usage, configuration, and more.
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.