ncls(1)

ncls1

List paths with rendering of multimedia

Usage

ncls [{-h | --help}] [{-V | --version}] [-d] [-l] [-L] [-R] [{-a | --align type}] [{-b | --blitter blitter}] [{-s | --scale scale}] [paths]

Overview

ncls uses a multimedia-enabled Notcurses to list paths, similarly to the ls(1) command, rendering images and videos to a terminal.

Options

-d: list directories themselves, not their contents.

-l: use a long listing format.

-L: dereference symbolic links

-R: list subdirectories recursively.

-V|--version: Print version information, and exit with success.

-h|--help: Print help information, and exit with success.

-a|--align type: Align images on left, center, or right.

-b|--blitter blitter: Blitter, one of ascii, half, quad, sex, braille, or pixel. The default is pixel. If the chosen blitter is unavailable, ncls will degrade (see notcurses_visual(3)).

-s|--scale scalemode: Scaling mode, one of none, hires, scale, scalehi, or stretch.

paths: Run on the specified paths. If none are supplied, run on the current directory.

If no scaling is specified, hires will be used with the pixel blitter, and scalehi will be used otherwise.

Notes

Optimal display requires a terminal advertising the rgb terminfo(5) capability, or that the environment variable COLORTERM is defined to 24bit (and that the terminal honors this variable), along with a fixed-width font with good coverage of the Unicode Block Drawing Characters.

Releases

2 releases since Debian 11 (Bullseye); the text changed 1 time.

  1. 11
  2. Arch

Authors

nick black ⟨[email protected]⟩\c.

From notcurses 3.0.17-3 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.