How to Use Glow: The Beginner's Guide (First Render, the TUI Lesson, the Stash Arc, Styles, and the GitHub-README Trick)

CodexFuse Team · 2026-11-07T05:26:19.642Z · 14 min read min read

How Do I Use Glow?

Learning how to use glow takes seven moves: install Glow 3.0.0, check the version, render a local file, pipe text through stdin, open the TUI browser, pick a style, and fetch a GitHub README straight from the terminal. Glow is a terminal-based Markdown reader from the Charm team that turns plain-text files into styled, readable documents without leaving the shell, and it runs on Linux, macOS, and Windows. Glow here means the charmbracelet terminal tool, not a sleep light or a skincare product, and this glow cli tutorial follows the official documentation, the project repository, and the release notes, with every fact checked as of November 2026.

CodexFuse offers no Glow tool, so this guide teaches the real project on your own machine, not a web version of it. No Facebook promotion applies to this guide. Gum builds terminal prompts while Glow reads Markdown files, and the Gum beginner guide covers that sibling lane while this guide covers the reader.

  1. Install Glow from your package manager and run glow --version to confirm 3.0.0.
  2. Render a local file with glow README.md.
  3. Pipe text with echo "# Hello" | glow -.
  4. Open the TUI with plain glow and browse local files.
  5. Paginate long output with glow -p README.md.
  6. Pick a style with glow -s dark.
  7. Fetch a README with glow github.com/charmbracelet/glow.

What Is Glow, Exactly?

Glow is a terminal-based Markdown reader designed from the ground up to bring out the beauty and power of the CLI. A glow markdown reader has one job: render markdown in terminal sessions as styled output, with headings, lists, links, and code blocks intact. Glow does that in two modes, a TUI browser and a CLI renderer, inside one binary.

The project started on 4 November 2019, so it is 2,560 days old, or 7.01 years, as of 7 November 2026. The repository carries 27,949 stars and 812 forks, which is 34.42 stars per fork, and 267 open issues, or 0.96 open issues per 100 stars. The current release is 3.0.0, published 11 August 2026, which is 88 days ago, and the last push landed 3 days ago.

FactValue
Repositorycharmbracelet/glow
LanguageGo
LicenseMIT
Created4 November 2019
Current release3.0.0, 11 August 2026
Stars27,949
Forks812
Open issues267
from datetime import date
today = date(2026, 11, 7)
glow_created = date(2019, 11, 4)
glow_release = date(2026, 8, 11)
glow_push = date(2026, 11, 4)
mdcat_created = date(2018, 1, 7)
mdcat_push = date(2026, 6, 19)
fork_created = date(2026, 6, 18)
fork_push = date(2026, 11, 3)
ubunlog = date(2022, 2, 18)
glamour_push = date(2026, 11, 1)
gum_push = date(2026, 11, 1)
print((today - glow_created).days)
print(round((today - glow_created).days / 365.25, 2))
print(round(27949 / 812, 2))
print(round(267 / 27949 * 100, 2))
print((today - glow_release).days)
print((today - glow_push).days)
print((today - mdcat_created).days)
print(round((today - mdcat_created).days / 365.25, 2))
print(round(27949 / 2409, 2))
print((today - mdcat_push).days)
print((today - fork_created).days)
print((today - fork_push).days)
print((today - ubunlog).days)
print(round((today - ubunlog).days / 365.25, 2))
print((today - glamour_push).days)
print((today - gum_push).days)
print(27949 - 24570)
print(round(37241 / 88, 1))

The computed block above shows the arithmetic behind the figures in this section, and every number in this guide comes from a source fetched on 7 November 2026. Glow carries 3,379 more stars than Gum, its Charm sibling, which holds 24,570 stars. The release checksums file alone was downloaded 37,241 times in the 88 days since v3.0.0, or 423.2 downloads a day.

Why Is There No Single Beginner Guide for Glow?

A live check of Google page 1 for how to use glow on 7 November 2026 returns a Casper sleep-light manual, a Lumi Glow makeup routine, and glow-drop skincare guides. The bare query is polluted by beauty and sleep products, so the CLI tool needs the glow cli or glow markdown qualifier to surface at all. No independent article and no tool page ranks for the bare query.

The qualified query is thinner still: the official README, an x-cmd package page, a pkg.go.dev mirror of the old v1.5.1 README, and a ubunlog article published 18 February 2022, which is 1,723 days ago, or 4.72 years. The closest thing to a general guide is a terminalroot article about 1,752 days old, and a pair of 646-day-old content-farm duplicates. That gap is why this guide exists: install, first render, TUI, stash, styles, and the GitHub README trick in one place, pinned to 3.0.0.

How Do I Install Glow?

Install Glow from your system package manager, not from a random script. The current Go install path is go install charm.land/glow/v3@latest, and go install github.com/charmbracelet/glow@latest is the old install path. Homebrew and winget both carry 3.0.0, verified live this run.

SystemCommandVersion this run
Debian or UbuntuAdd the Charm apt repo, then sudo apt install glowRepo GPG key verified live
macOS or Linuxbrew install glow3.0.0, formula verified live
Windowswinget install charmbracelet.glow3.0.0, manifest verified live
Any systemgo install charm.land/glow/v3@latestCurrent module path, v3
Any systemOfficial binaries from the v3.0.0 release page.deb, .rpm, .apk, tar.gz, Windows .zip
brew install glow
winget install charmbracelet.glow
go install charm.land/glow/v3@latest
glow --version

After installing, run glow --version and confirm 3.0.0 before you follow any command in this guide. The remaining routes live in the README only and were not verified live this run: MacPorts, Arch pacman, Void xbps, Nix, FreeBSD pkg, Solus eopkg, Chocolatey, Scoop, Snapcraft, and Termux. Only the version check and the stdin render were executed against the v3.0.0 binary this run.

If you would rather try Glow without installing it on your host, the Docker beginner guide shows how to run a throwaway container first. The release page also ships .deb, .rpm, and .apk packages, plus tarballs for Linux, macOS, FreeBSD, NetBSD, and OpenBSD, and a Windows zip.

How Do I Render My First Markdown File?

The first render is one command: glow README.md. Glow reads the file, styles it with Glamour, and prints the result to your terminal, with headings, bold text, lists, and code blocks all formatted. The -w flag sets the wrap width, and -p sends the output to your pager instead of printing it straight through.

Text on stdin works the same way, so echo "# Hello" | glow - renders one heading without a file. A URL works too: glow https://host.tld/file.md fetches and renders remote Markdown, and the GitHub trick in a later section covers repositories. The glow pager is the high-performance reader the TUI uses for long documents, and -p sends CLI output to your pager on demand.

glow README.md
echo "# Hello" | glow -
glow -w 60 README.md
glow -p README.md

What Is the TUI Lesson?

The TUI lesson is the one idea that makes Glow click: plain glow with no arguments opens a browser, while glow with a file renders that file and exits. The browser finds Markdown files in the current directory and below, or searches the whole repository when you run it inside Git. Press ? inside the TUI to list the hotkeys, and treat anything else as a less-style convention rather than a documented Glow key.

Three flags tune the browser: -a shows system files and directories, -l adds line numbers, and -t forces the TUI even when you pass a file. A Git beginner guide helps if the repository search is new to you, since Glow searches the repo you are standing in. The TUI is also where the old stash used to live, which the next section covers.

What Happened to the Glow Stash?

The glow stash was a private collection of Markdown files synced through Charm Cloud, with end-to-end encryption that only you could decrypt. In Glow v1, you pressed s in the TUI or ran glow stash README.md, and plain glow browsed local and stashed documents together. In Glow v3.0.0 the stash is gone: the word does not appear in the current README, and glow --help lists no stash command.

That absence sits oddly beside the release notes, because the v3.0.0 release notes say there are no UX changes. The notes describe a Bubble Tea, Lip Gloss, and Bubbles v2 upgrade, with faster and more accurate rendering, and say nothing about removing the stash. Treat the stash as a legacy v1 and v2 feature: do not teach glow stash as a working v3 command, and check the current README before you rely on any guide that still shows it.

The stale copies make the confusion worse: the pkg.go.dev v1.5.1 mirror still shows the old stash sections, even though the current main README has none. If a tutorial teaches the stash, check which Glow version it was written for before you follow it. The stash lesson is simple: private sync was a v1 idea, and v3 is a local reader.

How Do I Change Glow Styles?

The glow styles system comes from Glamour, the Charm rendering engine, and the -s flag picks one: glow -s dark renders with the dark style, and glow -s mystyle.json loads a custom JSON stylesheet. With no flag, Glow detects your terminal background and picks dark or light for you. The built-in styles are ascii, dark, dracula, light, notty, pink, and tokyo-night.

StyleCommand
darkglow -s dark README.md
lightglow -s light README.md
asciiglow -s ascii README.md
nottyglow -s notty README.md
pinkglow -s pink README.md
draculaglow -s dracula README.md
tokyo-nightglow -s tokyo-night README.md
glow -s dark README.md
glow -s pink README.md
glow config

Glamour itself carries 3,748 stars and 347 forks, and its last push landed 6 days ago, so the style engine is actively maintained. Custom styles are JSON files, and the Glamour styles gallery shows each built-in look before you pick one. Your choices also persist in the config file at ~/.config/glow/glow.yml, where style, width, pager, and mouse settings live together.

What Is the GitHub-README Trick?

The glow github readme trick is one command: glow github.com/charmbracelet/glow. Glow fetches the repository default README and renders it in your terminal, with no clone and no browser, and the same syntax works for GitLab repositories. Any Markdown URL works the same way, so glow https://host.tld/file.md renders remote documentation straight from the shell.

The trick has one honest limit: the GitHub README fetch was not verified live in this run. The v3.0.0 binary produced no output for the fetch inside a 15-second timeout in this sandbox, so the syntax here is README-documented, not live-verified. If the fetch fails for you, check your network first, because the command itself is documented in the current README.

The same trick works over SSH on a remote machine, and a VPS hosting guide covers the server side when the files live somewhere else. The README trick is the fastest way to read a project you have never cloned, and it is the reason many terminal users install Glow in the first place.

Glow vs mdcat: Which Markdown Reader Fits?

Glow vs mdcat is the comparison most readers ask about, and the two tools answer different questions. Glow is a Markdown reader with a TUI browser, a pager, seven styles, and GitHub README fetching, while mdcat is a single-purpose cat for Markdown with no TUI and no styles engine. Glow carries 27,949 stars against mdcat 2,409, or 11.6 times as many, and mdcat is the older project at 3,226 days, or 8.83 years.

FactGlowmdcat
LanguageGoRust
Stars27,9492,409
Forks812107
Open issues2670
Created4 November 20197 January 2018
Last push3 days ago141 days ago
TUI browserYesNo
Styles7 built-inNone
GitHub README fetchYesNot documented

The maintenance picture matters more than the feature list: mdcat upstream is no longer maintained. The swsnr/mdcat README points readers to the maintained fork BIRSAx2/mdcat, which carries 166 stars and 18 forks, was created 142 days ago, and had its last push 4 days ago. Pick Glow for browsing and styling, pick mdcat when you want a fast Rust filter that behaves like cat, and pick the BIRSAx2 fork if you pick mdcat at all.

What Are the Seven Mistakes Beginners Make?

MistakeWhat happensFix
Searching the bare word glowBeauty and sleep products fill page 1Qualify the query with cli or markdown
Installing from the old Go pathAn outdated module pathUse charm.land/glow/v3@latest
Teaching glow stash as a v3 commandThe command does not exist in v3.0.0Treat the stash as a legacy v1 and v2 feature
Trusting the v1.5.1 pkg.go.dev mirrorStale README with stash sectionsRead the current main README
Expecting less keys to be documentedThe README documents only ?Press ? in the TUI to see the real list
Fetching a README with no networkThe command prints nothingCheck the network, then retry
Skipping the version checkOld guides assume v1 behaviorRun glow --version and confirm 3.0.0

The same terminal-first habit runs through local AI tools, and the Ollama beginner guide covers running models on your own machine. Every mistake above comes from a version or a search result, not from Glow itself, and the version check in the install section catches most of them.

Sources

The repository facts in this guide come from the GitHub API record for charmbracelet/glow, fetched 7 November 2026, and from the v3.0.0 release page and its release notes. The install routes were checked the same day: the Homebrew formula API returned version 3.0.0, the winget manifest for charmbracelet.glow returned version 3.0.0, and the Charm apt and yum GPG key URLs both returned 200. The v3.0.0 Linux binary was downloaded and executed this run, and glow --version printed glow version 3.0.0 (add5e7a).

The usage syntax comes from the current main README on GitHub, fetched 7 November 2026, and from the v3.0.0 --help output of the downloaded binary. The stash history comes from the v1.5.1 README, fetched by tag the same day, and from the pkg.go.dev v1.5.1 mirror, which still carries the old stash sections. The style names come from the Glamour styles source file and its gallery page, and the Glamour repository record supplies its stars, forks, and last push.

The mdcat facts come from the GitHub API record for the repository that lunaryorn/mdcat redirects to, swsnr/mdcat, and from its README, which states that upstream is no longer maintained and points to the BIRSAx2/mdcat fork. The Gum facts come from the GitHub API record for charmbracelet/gum. The search field comes from live Google page 1 checks for how to use glow and glow cli tutorial on 7 November 2026, plus the ubunlog article from 18 February 2022.

Frequently Asked Questions

Is Glow free?

Glow is free and open source under the MIT license, and the repository is public on GitHub. You install it with your package manager or the Go toolchain, and the MIT license means the code is free to use and modify. The only cost is your own time to learn the TUI keys.

Does Glow work on Windows?

Glow works on Windows, macOS, and Linux, and the v3.0.0 release ships a Windows zip alongside the Linux and macOS builds. The winget manifest carries version 3.0.0, so winget install charmbracelet.glow is the simplest Windows route. The README also lists Chocolatey and Scoop, but those routes were not verified live this run.

What happened to the Glow stash?

The stash was a private Charm Cloud collection in Glow v1 and v2, with end-to-end encryption that only you could decrypt. The stash is absent from Glow v3.0.0, and the current README and --help list no stash command. Treat any tutorial that teaches glow stash as a v1 guide, and check the version before you follow it.

Can Glow read a README from GitHub?

Glow can fetch a repository README with glow github.com/owner/repo, and the same syntax works for GitLab repositories. The command needs network access, and any Markdown URL works the same way. If the fetch prints nothing, check your network before you blame the syntax.

How is Glow different from Gum?

Gum builds terminal prompts and Glow reads markdown, so the two Charm tools do different jobs. Gum writes glamorous shell scripts with prompts and choices, while Glow renders Markdown files in the terminal. The Gum beginner guide covers the prompt lane, and this guide covers the reader lane.

Featured on Twelve Tools Hunt for Tools Featured on LaunchBuff Launch Llama Tools Launch your MCP Top Web Development Companies in the US - OnToplist.com Designer Listings Listed on SeeWhatNewAI Featured on SubmitMySaas Featured on AI Agents Directory Product Wing SaaS Wheel