Skip to content

Quick Start

Terminal window
tmd init

This creates the .typemd/ directory structure and SQLite database in the current directory.

Terminal window
tmd

This launches the lazygit-style two-panel interface for browsing your vault.

Create a file at objects/book/golang-in-action.md:

---
title: Go in Action
status: reading
rating: 4.5
---
# Notes
A great book about Go...

The TUI will automatically detect the new file and display it.

Terminal window
# Filter by type and property
tmd query "type=book status=reading"
# Full-text search
tmd search "concurrency"