Glow

Glow

CLI で 華やかに Markdown をレンダリング！

これは何ですか？

Glow は、CLI の美しさとパワーを最大限に引き出すために一から設計された、 ターミナルベースの Markdown リーダーです。

Markdown ファイルを見つけたり、コマンドライン上で直接ドキュメントを読んだりするのに使えます。Glow はサブディレクトリ内のローカル Markdown ファイルや、ローカルの Git リポジトリを検索します。

インストール

パッケージマネージャー

# 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

または、リリースページからバイナリをダウンロードしてください。macOS、Linux、Windows、 FreeBSD、OpenBSD 用のバイナリのほか、Debian、RPM、Alpine パッケージを利用できます。macOS、Linux、FreeBSD、OpenBSD 用の ARM ビルドも用意されています。

Go

または、go でインストールするだけです。

go install charm.land/glow/v3@latest

ビルド（Go 1.21 以降が必要）

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

TUI

引数を指定せずに glow を実行すると、テキストユーザーインターフェースが起動し、ローカルのファイルを閲覧できます。Glow は現在のディレクトリとその下にあるローカル Markdown ファイルを検索します。また、Git リポジトリ内にいる場合は、リポジトリを検索します。

Markdown ファイルは、Glow の高性能ページャーで読むことができます。less のおなじみのキーストロークのほとんどは同じですが、? を押すとホットキーの一覧を表示できます。

CLI

TUI に加えて、Glow には Markdown を扱う CLI もあります。ドキュメントをフォーマットするには、Markdown のソースを主引数として指定します。

# 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

ワードラップ

-w フラグで、出力を折り返す最大幅を指定できます。

glow -w 60

ページ表示

CLI の出力は、-p フラグを使ってお好みのページャーで表示できます。$PAGER が明示的に設定されていない場合は、ANSI 対応の less -r がデフォルトで使用されます。

スタイル

-s フラグでスタイルを選択できます。フラグを指定しない場合、glow は現在のターミナルの背景色を検出し、dark または light のスタイルを自動的に選択します。

glow -s [dark|light]

カスタムの JSON スタイルシートを指定することもできます。

glow -s mystyle.json

使用方法の詳細については、以下を参照してください。

glow --help

その他のスタイルについては、Glamour のスタイルセクションをご覧ください。または、独自のスタイルを作成してください！

設定ファイル

いつも glow に同じフラグを指定している場合は、設定ファイルを作成するとよいでしょう。glow config を実行すると、お好みの $EDITOR で設定ファイルが開きます。また、プラットフォームのデフォルトの設定パスに glow.yml という名前のファイルを手動で配置することもできます。場所がわからない場合は、glow --help を参照してください。

設定ファイルの例：

# 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

コントリビューション

コントリビューションガイドをご覧ください。

フィードバック

このプロジェクトについて、ぜひご意見をお聞かせください。お気軽にメッセージをお寄せください！

• Twitter
• Fediverse
• Discord

ライセンス

MIT

---

Charm の一部です。

Charmはオープンソースを愛しています • Charmはオープンソースを愛しています