Repolode
charmbracelet

charmbracelet/glow

A terminal markdown reader and renderer that displays .md files and repos with styled formatting in the CLI.

Stars
27,741
Forks
890
Open issues
256
Last commit
15 days ago

What is it?

Glow is a terminal-based markdown reader. Run it without arguments to browse local markdown files in the current directory and subdirectories, or inside a Git repository, and read them in a pager with less-style keybindings.

It can also format a document directly from the command line. Glow accepts local files, stdin, GitHub or GitLab repository paths, and HTTP URLs, and renders them with a dark or light style chosen automatically from the terminal background. Custom JSON stylesheets are supported, and output can be word-wrapped or sent to a pager.

Glow reads settings from a YAML config file, so frequently used flags such as style, width, and mouse support can be saved once. It is written in Go and installs through common package managers on macOS, Linux, Windows, and BSD systems.

Key features

  • 01Browse and read local markdown files in a terminal interface.
  • 02Render markdown from files, stdin, GitHub/GitLab paths, or URLs.
  • 03Automatically pick dark or light styling based on terminal background.
  • 04Support custom JSON stylesheets.
  • 05Word-wrap output and display it in a pager such as less.
  • 06Save frequently used options in a YAML config file.

Use cases

  • Reading project documentation or READMEs without leaving the terminal.
  • Previewing markdown files over SSH on a remote server.
  • Piping generated markdown into a readable formatted view in shell scripts.

Quick start

  1. 1

    Install with Homebrew (macOS or Linux)

    brew install glow
  2. 2

    Read a markdown file in the terminal

    glow README.md
  3. 3

    Start the interactive browser for local markdown files

    glow

Topics

FAQ

What is glow?
A terminal markdown reader and renderer that displays .md files and repos with styled formatting in the CLI. Glow is a terminal-based markdown reader. Run it without arguments to browse local markdown files in the current directory and subdirectories, or inside a Git repository, and read them in a pager with less-style keybindings.
Is glow free to use? What license does it have?
glow is open source under the MIT license. Check the license terms before using it in commercial products.
Is glow still maintained?
Actively maintained. The last commit to glow was on Oct 5, 2026.
What can I use glow for?
Reading project documentation or READMEs without leaving the terminal. Previewing markdown files over SSH on a remote server. Piping generated markdown into a readable formatted view in shell scripts.
How do I install glow?
Install with Homebrew (macOS or Linux): brew install glow Read a markdown file in the terminal: glow README.md Start the interactive browser for local markdown files: glow
Where can I get glow?
The source code and installation instructions are on GitHub: https://github.com/charmbracelet/glow

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects