matcha

command module
v0.0.0-...-8bc919e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2025 License: MIT Imports: 4 Imported by: 0

README

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 string array 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)
noteExts string array Note file extensions to be used by Matcha

Example configuration:

noteSources = [
    "~/notes",
]
defaultExt = ".md"
useTemplate = false
templateDir = ""
noteExts = [
    ".md",
    ".txt",
    ".tex",
    ".typ",
]

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL