# glow

> Terminal-based markdown reader with TUI browser and CLI formatter for local files and remote URLs

Stars: 27.9k · Language: Go · License: MIT · Categories: Productivity

- Repository: https://github.com/charmbracelet/glow
- Page: https://www.trmn.sh/tools/glow

## Install

- Homebrew: `brew install glow`
- Go: `go install github.com/charmbracelet/glow/v2@latest`
- Arch Linux: `pacman -S glow`

## Overview

Glow is a terminal-based markdown reader that provides both a text user interface (TUI) and command-line interface for rendering markdown files. The TUI mode automatically discovers markdown files in the current directory or Git repository, allowing users to browse and read documentation directly in the terminal with a high-performance pager that supports familiar keystrokes from `less`.

The CLI mode accepts markdown from various sources including local files, stdin, GitHub/GitLab repositories, and HTTP URLs. It can fetch README files directly from repositories using syntax like `glow github.com/charmbracelet/glow` and supports word wrapping with configurable width limits, custom styling through JSON stylesheets or built-in themes, and output through preferred pagers.

Glow includes extensive configuration options through a YAML config file and supports automatic theme detection based on terminal background color. The tool targets developers and technical writers who need to read markdown documentation efficiently within their terminal workflow, offering cross-platform support for macOS, Linux, Windows, FreeBSD, and other Unix-like systems.

### Installation

```bash
# via Homebrew
brew install glow
```

```bash
# via Go
go install github.com/charmbracelet/glow/v2@latest
```

```bash
# via Arch Linux
pacman -S glow
```

![Glow TUI Demo](https://media.trmn.sh/cached/dd121c9792f883fcf2c88209246081d45ad4591f39e3d3cc3e01e658e3383183.gif)

## Alternatives

- [WTF](https://www.trmn.sh/tools/wtf.md): Terminal dashboard (wtfutil) that shows data from services like GitHub, Google Calendar, Trello and OpsGenie in configurable modules. (Go, 17.1k stars)
- [cheat](https://www.trmn.sh/tools/cheat.md): CLI tool for creating and viewing interactive command-line cheatsheets with tagging and search capabilities (Go, 13.5k stars)
- [Slides](https://www.trmn.sh/tools/slides.md): Terminal presentation tool that renders markdown files as slides, with in-slide code execution, pre-processing, live reload, and SSH serving. (Go, 11.7k stars)
- [gopass](https://www.trmn.sh/tools/gopass.md): Command-line password manager compatible with pass, supporting GPG encryption, Git versioning, and team collaboration (Go, 7.3k stars)
- [Ticker](https://www.trmn.sh/tools/ticker.md): Terminal stock, crypto, and derivatives price watcher with position tracking, cost basis lots, currency conversion, and grouped watchlists. (Go, 6.3k stars)

## Guides

- [glow vs frogmouth](https://www.trmn.sh/compare/glow-vs-frogmouth): Compare glow, frogmouth: workflows, strengths and tradeoffs.

---

Canonical: https://www.trmn.sh/tools/glow