shiki
TUI note-taking app in Rust — Yazi-style navigation, notebooks as independent git repos, real per-note version history, themes, and fast fuzzy search.
What is shiki?
TUI note-taking app in Rust — Yazi-style navigation, notebooks as independent git repos, real per-note version history, themes, and fast fuzzy search.
Overview of shiki
What it is
shiki is a terminal-based note-taking application written in Rust. It provides a three-pane Yazi-style navigation, treats each notebook as an independent git repository, supports Markdown with frontmatter, offers both inline and external editing, real per-note version history, 37 built-in themes, and fast fuzzy search.
Key features
- Three-pane TUI with Yazi-inspired modal navigation, responsive to terminal size (wide, narrow, or very small).
- Notebooks are independent git repos; each notebook is a plain directory with its own git history.
- Bring your own notes directory: point to an existing folder (e.g., an Obsidian vault) without migration or symlinks.
- Real per-note version history: browse and revert commits that changed a specific note.
- 37 built-in themes with a live preview picker.
- Global fuzzy search across all notebooks and in-notebook fuzzy jump.
- Inline editor with conveniences: date stamp, find/replace, bold/italic wrapping, bracket auto-pairing, list auto-continuation, multi-cursor, and spell check.
Use cases
- Personal note-taking with full version history per note.
- Managing multiple notebooks (e.g., work, personal, projects) as separate git repos.
- Using an existing Markdown vault (e.g., Obsidian) as a notebook without migration.
- Quick note capture via CLI commands (
new,capture,daily). - Collaborative note sync via git push/pull with automatic fallback.
Getting started
sh yay -S shiki-bin Prebuilt binaries are also available for Linux, Windows, and macOS. See the repository README for other installation methods.
License and pricing
MIT license, open source.
Based on the project's public README and repository metadata.