{"id":13393073,"url":"https://github.com/charmbracelet/glow","last_synced_at":"2025-05-12T20:45:49.824Z","repository":{"id":37484634,"uuid":"219616873","full_name":"charmbracelet/glow","owner":"charmbracelet","description":"Render markdown on the CLI, with pizzazz! 💅🏻","archived":false,"fork":false,"pushed_at":"2025-05-05T10:22:47.000Z","size":2959,"stargazers_count":17733,"open_issues_count":99,"forks_count":395,"subscribers_count":74,"default_branch":"master","last_synced_at":"2025-05-05T16:05:58.082Z","etag":null,"topics":["cli","excitement","hacktoberfest","markdown"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/charmbracelet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-11-04T23:34:55.000Z","updated_at":"2025-05-05T15:52:56.000Z","dependencies_parsed_at":"2024-01-03T04:14:16.385Z","dependency_job_id":"59a07f1f-4359-4fa5-b851-9e3a5e0879f8","html_url":"https://github.com/charmbracelet/glow","commit_stats":{"total_commits":763,"total_committers":40,"mean_commits":19.075,"dds":0.4508519003931848,"last_synced_commit":"f1b565125fff2ebe99b3c92fb89bd4bc3ab4ced0"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fglow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fglow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fglow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fglow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charmbracelet","download_url":"https://codeload.github.com/charmbracelet/glow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253818698,"owners_count":21969205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","excitement","hacktoberfest","markdown"],"created_at":"2024-07-30T17:00:42.320Z","updated_at":"2025-05-12T20:45:48.988Z","avatar_url":"https://github.com/charmbracelet.png","language":"Go","readme":"# Glow\n\nRender markdown on the CLI, with _pizzazz_!\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://stuff.charm.sh/glow/glow-banner-github.gif\" alt=\"Glow Logo\"\u003e\n    \u003ca href=\"https://github.com/charmbracelet/glow/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/release/charmbracelet/glow.svg\" alt=\"Latest Release\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pkg.go.dev/github.com/charmbracelet/glow?tab=doc\"\u003e\u003cimg src=\"https://godoc.org/github.com/golang/gddo?status.svg\" alt=\"GoDoc\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/charmbracelet/glow/actions\"\u003e\u003cimg src=\"https://github.com/charmbracelet/glow/workflows/build/badge.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://goreportcard.com/report/github.com/charmbracelet/glow\"\u003e\u003cimg src=\"https://goreportcard.com/badge/charmbracelet/glow\" alt=\"Go ReportCard\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/user-attachments/assets/c2246366-f84b-4847-b431-32a61ca07b74\" width=\"800\" alt=\"Glow UI Demo\"\u003e\n\u003c/p\u003e\n\n## What is it?\n\nGlow is a terminal based markdown reader designed from the ground up to bring\nout the beauty—and power—of the CLI.\n\nUse it to discover markdown files, read documentation directly on the command\nline. Glow will find local markdown files in subdirectories or a local\nGit repository.\n\n## Installation\n\n### Package Manager\n\n```bash\n# macOS or Linux\nbrew install glow\n```\n\n```bash\n# macOS (with MacPorts)\nsudo port install glow\n```\n\n```bash\n# Arch Linux (btw)\npacman -S glow\n```\n\n```bash\n# Void Linux\nxbps-install -S glow\n```\n\n```bash\n# Nix shell\nnix-shell -p glow --command glow\n```\n\n```bash\n# FreeBSD\npkg install glow\n```\n\n```bash\n# Solus\neopkg install glow\n```\n\n```bash\n# Windows (with Chocolatey, Scoop, or Winget)\nchoco install glow\nscoop install glow\nwinget install charmbracelet.glow\n```\n\n```bash\n# Android (with termux)\npkg install glow\n```\n\n```bash\n# Ubuntu (Snapcraft)\nsudo snap install glow\n```\n\n```bash\n# Debian/Ubuntu\nsudo mkdir -p /etc/apt/keyrings\ncurl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg\necho \"deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *\" | sudo tee /etc/apt/sources.list.d/charm.list\nsudo apt update \u0026\u0026 sudo apt install glow\n```\n\n```bash\n# Fedora/RHEL\necho '[charm]\nname=Charm\nbaseurl=https://repo.charm.sh/yum/\nenabled=1\ngpgcheck=1\ngpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo\nsudo yum install glow\n```\n\nOr download a binary from the [releases][releases] page. MacOS, Linux, Windows,\nFreeBSD and OpenBSD binaries are available, as well as Debian, RPM, and Alpine\npackages. ARM builds are also available for macOS, Linux, FreeBSD and OpenBSD.\n\n### Go\n\nOr just install it with `go`:\n\n```bash\ngo install github.com/charmbracelet/glow@latest\n```\n\n### Build (requires Go 1.21+)\n\n```bash\ngit clone https://github.com/charmbracelet/glow.git\ncd glow\ngo build\n```\n\n[releases]: https://github.com/charmbracelet/glow/releases\n\n## The TUI\n\nSimply run `glow` without arguments to start the textual user interface and\nbrowse local. Glow will find local markdown files in the\ncurrent directory and below or, if you’re in a Git repository, Glow will search\nthe repo.\n\nMarkdown files can be read with Glow's high-performance pager. Most of the\nkeystrokes you know from `less` are the same, but you can press `?` to list\nthe hotkeys.\n\n## The CLI\n\nIn addition to a TUI, Glow has a CLI for working with Markdown. To format a\ndocument use a markdown source as the primary argument:\n\n```bash\n# Read from file\nglow README.md\n\n# Read from stdin\necho \"[Glow](https://github.com/charmbracelet/glow)\" | glow -\n\n# Fetch README from GitHub / GitLab\nglow github.com/charmbracelet/glow\n\n# Fetch markdown from HTTP\nglow https://host.tld/file.md\n```\n\n### Word Wrapping\n\nThe `-w` flag lets you set a maximum width at which the output will be wrapped:\n\n```bash\nglow -w 60\n```\n\n### Paging\n\nCLI output can be displayed in your preferred pager with the `-p` flag. This defaults\nto the ANSI-aware `less -r` if `$PAGER` is not explicitly set.\n\n### Styles\n\nYou can choose a style with the `-s` flag. When no flag is provided `glow` tries\nto detect your terminal's current background color and automatically picks\neither the `dark` or the `light` style for you.\n\n```bash\nglow -s [dark|light]\n```\n\nAlternatively you can also supply a custom JSON stylesheet:\n\n```bash\nglow -s mystyle.json\n```\n\nFor additional usage details see:\n\n```bash\nglow --help\n```\n\nCheck out the [Glamour Style Section](https://github.com/charmbracelet/glamour/blob/master/styles/gallery/README.md)\nto find more styles. Or [make your own](https://github.com/charmbracelet/glamour/tree/master/styles)!\n\n## The Config File\n\nIf you find yourself supplying the same flags to `glow` all the time, it's\nprobably a good idea to create a config file. Run `glow config`, which will open\nit in your favorite $EDITOR. Alternatively you can manually put a file named\n`glow.yml` in the default config path of you platform. If you're not sure where\nthat is, please refer to `glow --help`.\n\nHere's an example config:\n\n```yaml\n# style name or JSON path (default \"auto\")\nstyle: \"light\"\n# mouse wheel support (TUI-mode only)\nmouse: true\n# use pager to display markdown\npager: true\n# at which column should we word wrap?\nwidth: 80\n# show all files, including hidden and ignored.\nall: false\n```\n\n## Feedback\n\nWe’d love to hear your thoughts on this project. Feel free to drop us a note!\n\n- [Twitter](https://twitter.com/charmcli)\n- [The Fediverse](https://mastodon.social/@charmcli)\n- [Discord](https://charm.sh/chat)\n\n## License\n\n[MIT](https://github.com/charmbracelet/glow/raw/master/LICENSE)\n\n---\n\nPart of [Charm](https://charm.sh).\n\n\u003ca href=\"https://charm.sh/\"\u003e\u003cimg alt=\"The Charm logo\" src=\"https://stuff.charm.sh/charm-badge.jpg\" width=\"400\"\u003e\u003c/a\u003e\n\nCharm热爱开源 • Charm loves open source\n","funding_links":[],"categories":["Go","Utilities","Documents and Writing.","开源类库","Command Line","Tools for Self-Hosting","Misc","By Industry","Open source library","\u003ca name=\"data\"\u003e\u003c/a\u003edata","Other","Viewer","Documentation as code","语言资源库","\u003ca name=\"Go\"\u003e\u003c/a\u003eGo","前端开发框架及项目","cli","markdown","Tools","Uncategorized","Applications","By Language","命令行工具","\u003ca name=\"markdown\"\u003e\u003c/a\u003eMarkdown","🛠️ Productivity","Lovely Commands","Table of Contents","Developer Utilities","CLI/TUI Apps","More Topics","Command line - Linux","CLI and TUI Tools","其他工具","Other Tools","Cat Replacement"],"sub_categories":["Markdown","命令行","CLI Tools","Development","Dependency Management","Tools \u0026 Utilities","Command Line","Search","Build systems","go","其他_文本生成、文本对话","Go","Uncategorized","Development Tools","☸️ Kubernetes","Other","Formats","Learning resources","Codex Resources","命令行工具","Open USP Tsukubai"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharmbracelet%2Fglow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharmbracelet%2Fglow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharmbracelet%2Fglow/lists"}