Skip to content

ptdewey/matcha

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Matcha

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: Create mode gif

Search Mode: Search mode gif

Installation

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

Usage

# run matcha
matcha

TODO: explanation and usage of modes

Configuration

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 = ""

About

TUI Note Taking Helper

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages