Matcha is a beautiful and featureful note taking helper program built for the terminal. Matcha lets you quickly search and edit your notes, create new ones from templates, and more.
Matcha is built with Bubble Tea.
Create Mode:
Search Mode:
With Go install:
go install github.com/ptdewey/matcha@latest(Ensure your Go binary installation location is in your PATH)
From source:
git clone https://github.com/ptdewey/matcha.git
cd matcha
go mod tidy
go build
# add to path or run with ./matcha# run matcha
matchaTODO: explanation and usage of modes
Matcha looks for one of the following configuration files in your home directory:
matcha.toml.matcha.toml.matcharc
Currently, matcha provides the following configuration options:
| Option | Type | Description |
|---|---|---|
| noteSources | list of string paths | Note directories to be used by Matcha |
| defaultExt | string | Default file extension for new notes used when none is specified |
| useTemplate | boolean | Whether or not to attempt to create new notes with template by default (experimental/WIP) |
| templateDir | string | Path to template directories for creating new notes (experimental/WIP) |
Example configuration:
noteSources = [
"~/notes",
]
defaultExt = ".md"
useTemplate = false
templateDir = ""