Repository: charmbracelet/glow

Stars: 24443

README.md Copy Chapter

Glow

Render markdown on the CLI, with _pizzazz_!

<p align="center">
<img src="https://stuff.charm.sh/glow/glow-banner-github.gif" alt="Glow Logo">
<a href="https://github.com/charmbracelet/glow/releases"><img src="https://img.shields.io/github/release/charmbracelet/glow.svg" alt="Latest Release"></a>
<a href="https://pkg.go.dev/github.com/charmbracelet/glow?tab=doc"><img src="https://godoc.org/github.com/golang/gddo?status.svg" alt="GoDoc"></a>
<a href="https://github.com/charmbracelet/glow/actions"><img src="https://github.com/charmbracelet/glow/workflows/build/badge.svg" alt="Build Status"></a>
<a href="https://goreportcard.com/report/github.com/charmbracelet/glow"><img src="https://goreportcard.com/badge/charmbracelet/glow" alt="Go ReportCard"></a>
</p>

<p align="center">
<img src="https://github.com/user-attachments/assets/c2246366-f84b-4847-b431-32a61ca07b74" width="800" alt="Glow UI Demo">
</p>

What is it? Copy Chapter

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 Copy Chapter

Package Manager Copy Section

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][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 Copy Section

Or just install it with go:

go install github.com/charmbracelet/glow/v2@latest

Build (requires Go 1.21+) Copy Section

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

[releases]: https://github.com/charmbracelet/glow/releases

The TUI Copy Chapter

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 Copy Chapter

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" | glow -
Fetch README from GitHub / GitLab

glow github.com/charmbracelet/glow
Fetch markdown from HTTP

glow https://host.tld/file.md

Word Wrapping Copy Section

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

glow -w 60

Paging Copy Section

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.

Styles Copy Section

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 Copy Chapter

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

Contributing Copy Chapter

See [contributing][contribute].

[contribute]: https://github.com/charmbracelet/glow/contribute

Feedback Copy Chapter

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

- Twitter
- The Fediverse
- Discord

License Copy Chapter

MIT

---

Part of Charm.

<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Charm热爱开源 • Charm loves open source