Pager

Mycli outputs query results in a pager (e.g. less or more). This allows you to easily view large result sets one page at a time.

Configuring the Pager

When starting up, mycli checks the pager config option in ~/.myclirc. If it's set, then mycli uses its value as the pager. If it's blank, then mycli will use the PAGER environment variable.

Once mycli is started, you can use the pager command to change which pager mycli uses. Or, nopager to disable the pager.

> pager less
PAGER set to less.
> nopager
Pager disabled.

Disable Paging

You can disable the pager by adding enable_pager = False to your ~/.myclirc file. See Configuration for more information.

Pager Behavior

On macOS and Linux, the pager will default to less for most users. less sometimes has less-than-desirable behavior such as clearing the screen, cutting off lines, etc.

You can configure less through environment variables in your shell, or by setting the full desired command using the pager option in ~/.myclirc.

Here are some common less options and configuration examples:

• -X leaves file contents on the screen when less exits.
• -F makes less quit if the entire output can be displayed on one screen.
• -R displays ANSI color escape sequences in "raw" form.
• -S disables line wrapping. Side-scroll to see long lines.

# This is a popular option in ~/.myclirc:
pager = 'less -XFR'

# Or, some mycli users like to disable line wrapping.
pager = 'less -SRXF'