Skip to main content

An interactive, command-line presentation tool

Project description

Master Build Status Coverage Status PyPI Statistics Latest Release Documentation Status

Twitter Follow


lookatme is an interactive, extensible, terminal-based markdown presentation tool.



  • Markdown rendering
  • Live (input file modification time watching) and manual reloading
  • Live terminals embedded directly in slides
  • Syntax highlighting using Pygments
  • Loading external files into code blocks
  • Support for contrib extensions
  • Smart slide splitting


General tour


Embedded terminal example

terminal example

Sourcing external files example

file loader example

Navigating the Presentation

Action Keys Notes
Next Slide l j right space
Prev Slide h k left delete backspace
Quit q Q
Terminal Focus Click on the terminal
Exit Terminal ctrl+a and then a slide action
Vertically scroll within slide up/down or page up/page down

CLI Options

Usage: lookatme [OPTIONS] [INPUT_FILES]...

  lookatme - An interactive, terminal-based markdown presentation tool.

  See for documentation

  -l, --log PATH
  -t, --theme [dark|light]
  -s, --style [default|emacs|friendly|colorful|autumn|murphy|manni|monokai|perldoc|pastie|borland|trac|native|fruity|bw|vim|vs|tango|rrt|xcode|igor|paraiso-light|paraiso-dark|lovelace|algol|algol_nu|arduino|rainbow_dash|abap|solarized-dark|solarized-light|sas|stata|stata-light|stata-dark|inkpot]
  --dump-styles                   Dump the resolved styles that will be used
                                  with the presentation to stdout

  --live, --live-reload           Watch the input filename for modifications
                                  and automatically reload

  -s, --safe                      Do not load any new extensions specified in
                                  the source markdown. Extensions specified
                                  via env var or -e are still loaded

  --no-ext-warn                   Load new extensions specified in the source
                                  markdown without warning

  -i, --ignore-ext-failure        Ignore load failures of extensions
  -e, --exts TEXT                 A comma-separated list of extension names to
                                  automatically load (LOOKATME_EXTS)

  --single, --one                 Render the source as a single slide
  --version                       Show the version and exit.
  --help                          Show this message and exit.

Known Extensions

Below is a list of known extensions for lookatme:

Extension Name Install Name Notes
qrcode lookatme.contrib.qrcode Renders QR codes from code blocks
image_ueberzug lookatme.contrib.image_ueberzug Renders images with ueberzug (Linux only)
render lookatme.contrib.render Renders supported code blocks (graphviz and mermaid-js) by calling an external program. requires an image-rendering extension


See the documentation for details.

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

lookatme-2.3.2.tar.gz (33.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page