# glint

A modeless terminal markdown editor with live styling — a [Bubble Tea][bubbletea]
TUI built for a notes vault. Type in a centered iA-Writer-style writing canvas
with soft-wrapping and live markdown coloring, flip to a [Glamour][glamour] read
preview, fuzzy-find notes with a live preview pane, and theme it to match your
terminal (Flexoki light/dark + charm). Open any file, jump to today's daily
note, or start a fresh document from anywhere.

## Install

```sh
brew tap humdrum/tap https://codex.humdrum.me/git/homebrew-tap.git
brew trust humdrum/tap   # Homebrew gates third-party taps
brew install glint
```

Upgrade later:

```sh
brew update && brew upgrade glint
```

## Usage

```bash
glint                 # fuzzy picker over the current directory
glint notes.md        # open a file
glint vault           # fuzzy picker over your configured vault, from anywhere
glint --daily         # open (and create) today's daily note
glint new             # start a blank scratch document
glint new ideas       # create and open <inbox>/ideas.md
glint --version       # print version
```

### Keys

| Key | Action |
| --- | --- |
| type / arrows / `Enter` / `Backspace` / `Del` | edit and move (Up/Down move by visual line) |
| `Ctrl+S` | save (an unnamed buffer prompts for a name → inbox) |
| `Ctrl+P` | toggle the Glamour read preview |
| `Ctrl+F` | fuzzy file picker (with live preview) |
| `Ctrl+D` | today's daily note |
| `Ctrl+N` | new document (in the editor) / new note from the query (in the picker) |
| `Ctrl+T` | cycle theme (flexoki-light → flexoki-dark → charm) |
| `Ctrl+Q` | quit (press twice if there are unsaved changes) |
| `Esc` | back to the editor |

## Configuration

glint reads `~/.config/glint/config.toml` (all keys optional):

```toml
vault_dir     = ""           # the vault `glint vault` opens from anywhere (e.g. "~/Notes"); unset = current dir
inbox_dir     = ""           # where `glint new` / save-as land; "" = working dir, relative = under it
daily_subdir  = "Daily"      # daily notes live in <working dir>/<daily_subdir>/
daily_format  = "2006-01-02" # Go time layout for daily-note filenames
theme         = "auto"       # auto | flexoki-light | flexoki-dark | charm  (auto detects macOS appearance)
glamour_style = ""           # override the preview style; "" follows the theme
```

**Two roots.** Bare `glint`, `glint new`, and `--daily` operate on the **working
directory** — the folder you launched from (or `$GLINT_VAULT` if set), so glint
works in whatever repo you're in. **`glint vault`** opens the picker on your
**configured `vault_dir`** from anywhere — set it to your notes vault to reach it
without `cd`-ing there.

## Themes

Three palettes, every span explicitly colored so text stays readable on light
and dark terminals: **flexoki-light**, **flexoki-dark**, and **charm**. `auto`
picks light or dark from the macOS system appearance; `Ctrl+T` cycles live. The
read preview and the whole canvas background follow the active theme.

## License

glint — Copyright (C) 2026 humdrum-tiv.

Free software under the [GNU Affero General Public License v3.0](LICENSE) (or, at
your option, any later version). You may use, study, share, and modify it; any
distributed derivative — **or modified version offered to users over a network** —
must also be AGPL-licensed with source available. It comes with **no warranty**.
See [LICENSE](LICENSE) for the full terms.

[bubbletea]: https://github.com/charmbracelet/bubbletea
[glamour]: https://github.com/charmbracelet/glamour