Render markdown on the CLI with style
Find a file
drew f6846e85bc
fix: windows bug
Signed-off-by: drew <me@andrinoff.com>
2026-09-22 14:57:57 +04:00
.github feat: svg support 2026-09-22 13:41:54 +04:00
ui feat: svg support 2026-09-22 13:41:54 +04:00
utils fix: windows bug 2026-09-22 14:57:57 +04:00
.editorconfig chore: add .editorconfig 2025-04-03 15:23:59 -03:00
.gitignore chore: add missing line end to .gitignore 2025-02-07 08:16:33 -08:00
.golangci.yml ci: sync golangci-lint config (#808) 2025-08-11 08:23:51 -04:00
.goreleaser.yml ci: fix goreleaser config 2025-03-07 15:10:54 -03:00
config_cmd.go many improvements 2026-09-21 16:00:50 +04:00
console_windows.go fix: windows bug 2026-09-22 14:57:57 +04:00
Dockerfile feat(ci): use config files from meta repo (#389) 2022-10-26 16:05:52 -03:00
example.png Update example image with unicode characters 2020-01-13 12:21:08 -05:00
github.go fix(lint): fix all linting issues 2025-04-03 15:23:59 -03:00
gitlab.go fix(lint): fix all linting issues 2025-04-03 15:23:59 -03:00
glow_test.go many improvements 2026-09-21 16:00:50 +04:00
go.mod fix: ci 2026-09-22 14:45:15 +04:00
go.sum fix: ci 2026-09-22 14:45:15 +04:00
LICENSE docs(license): update copyright date 2024-08-23 15:00:20 -04:00
log.go fix(lint): fix all linting issues 2025-04-03 15:23:59 -03:00
main.go many improvements 2026-09-21 16:00:50 +04:00
man_cmd.go fix(lint): fix all linting issues 2025-04-03 15:23:59 -03:00
README.md many improvements 2026-09-21 16:00:50 +04:00
style.go chore: bump bubbletea to v2 (#1002) 2026-08-10 18:21:27 +04:00
Taskfile.yaml chore: add a taskfile 2025-04-03 15:23:59 -03:00
url.go fix: tui mode handling of remote urls (#744) 2025-04-09 10:18:13 -03:00
url_test.go test: skip flukish test 2024-07-11 12:20:59 -03:00

Glow

Render markdown on the CLI, with pizzazz!

Glow Logo Latest Release GoDoc Build Status Go ReportCard

Glow UI Demo

What is it?

Glow is a terminal based markdown reader designed from the ground up to bring out the beauty—and power—of the CLI.

Use it to discover markdown files, read documentation directly on the command line. Glow will find local markdown files in subdirectories or a local Git repository.

Installation

Package Manager

# macOS or Linux
brew install glow
# macOS (with MacPorts)
sudo port install glow
# Arch Linux (btw)
pacman -S glow
# Void Linux
xbps-install -S glow
# Nix shell
nix-shell -p glow --command glow
# FreeBSD
pkg install glow
# Solus
eopkg install glow
# Windows (with Chocolatey, Scoop, or Winget)
choco install glow
scoop install glow
winget install charmbracelet.glow
# Android (with termux)
pkg install glow
# Ubuntu (Snapcraft)
sudo snap install glow
# Debian/Ubuntu
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install glow
# Fedora/RHEL
echo '[charm]
name=Charm
baseurl=https://repo.charm.sh/yum/
enabled=1
gpgcheck=1
gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
sudo yum install glow

Or download a binary from the releases page. MacOS, Linux, Windows, FreeBSD and OpenBSD binaries are available, as well as Debian, RPM, and Alpine packages. ARM builds are also available for macOS, Linux, FreeBSD and OpenBSD.

Go

Or just install it with go:

go install charm.land/glow/v3@latest

Build (requires Go 1.21+)

git clone https://github.com/charmbracelet/glow.git
cd glow
go build

The TUI

Simply run glow without arguments to start the textual user interface and browse local. Glow will find local markdown files in the current directory and below or, if you’re in a Git repository, Glow will search the repo.

Markdown files can be read with Glow's high-performance pager. Most of the keystrokes you know from less are the same, but you can press ? to list the hotkeys.

The CLI

In addition to a TUI, Glow has a CLI for working with Markdown. To format a document use a markdown source as the primary argument:

# Read from file
glow README.md

# Read from stdin
echo "[Glow](https://github.com/charmbracelet/glow)" | glow -

# Fetch README from GitHub / GitLab
glow github.com/charmbracelet/glow

# Fetch markdown from HTTP
glow https://host.tld/file.md

Word Wrapping

The -w flag lets you set a maximum width at which the output will be wrapped:

glow -w 60

Paging

CLI output can be displayed in your preferred pager with the -p flag. This defaults to the ANSI-aware less -r if $PAGER is not explicitly set.

Images

If your terminal supports the kitty graphics protocol (e.g. kitty, Ghostty, WezTerm) or sixel, images in the document are rendered right in the terminal:

glow README.md

Support is detected automatically, both in the CLI and in the TUI pager, where images scroll with the text. Images can be turned off with the --images=false flag, or forced with the GLOW_IMAGE_PROTOCOL environment variable (auto, kitty, sixel, or none).

Large images are automatically downscaled to what the terminal can actually display before being transmitted, so even huge photos render quickly. Their size can also be limited with --image-max-rows (default 20 terminal rows, 0 for no limit), or the imageMaxRows config key.

Images referenced by an http(s) URL are not loaded by default: fetching them would reveal your IP address to the image's host, much like a tracking pixel would. Instead, the URL is rendered as a link followed by a note saying the image wasn't loaded. Set loadRemoteImages: true in your config (or GLOW_LOAD_REMOTE_IMAGES=true) to fetch and render them. In the TUI the document's text appears right away, and a spinner in the status bar spins while the remote images are being fetched.

Styles

You can choose a style with the -s flag. When no flag is provided glow tries to detect your terminal's current background color and automatically picks either the dark or the light style for you.

glow -s [dark|light]

Alternatively you can also supply a custom JSON stylesheet:

glow -s mystyle.json

For additional usage details see:

glow --help

Check out the Glamour Style Section to find more styles. Or make your own!

The Config File

If you find yourself supplying the same flags to glow all the time, it's probably a good idea to create a config file. Run glow config, which will open it in your favorite $EDITOR. Alternatively you can manually put a file named glow.yml in the default config path of you platform. If you're not sure where that is, please refer to glow --help.

Here's an example config:

# style name or JSON path (default "auto")
style: "light"
# mouse wheel support (TUI-mode only)
mouse: true
# use pager to display markdown
pager: true
# at which column should we word wrap?
width: 80
# show all files, including hidden and ignored.
all: false
# show line numbers (TUI-mode only)
showLineNumbers: false
# preserve newlines in the output
preserveNewLines: false
# render images when the terminal supports it (kitty or sixel graphics)
images: true
# maximum number of terminal rows an image may occupy (0 for no limit)
imageMaxRows: 20
# load images referenced by http(s) URLs, disabled to avoid leaking your IP
loadRemoteImages: false

Contributing

See contributing.

Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!

License

MIT


Part of Charm.

The Charm logo

Charm热爱开源 • Charm loves open source