Skip to main content

A Markdown document viewer for the terminal

Project description



Frogmouth is a Markdown viewer / browser for your terminal, built with Textual.

Frogmouth can open *.md files locally or via a URL. There is a familiar browser-like navigation stack, history, bookmarks, and table of contents.

🎬 Demonstration

A quick video tour of Frogmouth.

(thanks Screen Studio)


Screenshot 2023-04-28 at 15 14 53 Screenshot 2023-04-28 at 15 17 56
Screenshot 2023-04-28 at 15 18 36 Screenshot 2023-04-28 at 15 16 39


Frogmouth runs on Linux, macOS, and Windows. Frogmouth requires Python 3.8 or above.


The easiest way to install Frogmouth is with pipx (particularly if you aren't a Python developer).

pipx install frogmouth

You can also install Frogmouth with pip:

pip install frogmouth

Whichever method you use, you should have a frogmouth command on your path.


Enter frogmouth at the prompt to run the app, optionally followed by a path to a Markdown file:


You can navigate with the mouse or the keyboard. Use tab and shift+tab to navigate between the various controls on screen.


You can load README files direct from GitHub repositories with the gh command. Use the following syntax:

frogmouth gh textualize/textual

This also works with the address bar in the app. See the help (F1) in the app for details.

Follow this project

If this app interests you, you may want to join the Textual Discord server.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frogmouth-0.9.2.tar.gz (28.0 kB view hashes)

Uploaded Source

Built Distribution

frogmouth-0.9.2-py3-none-any.whl (39.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page