https://github.com/amtoine/nu-pager-help

A replacement for the builtin help command of Nushell, with paging for large help pages.
https://github.com/amtoine/nu-pager-help

nushell

Last synced: 3 months ago
JSON representation

A replacement for the builtin help command of Nushell, with paging for large help pages.

• Host: GitHub
• URL: https://github.com/amtoine/nu-pager-help
• Owner: amtoine
• License: gpl-3.0
• Created: 2024-08-02T09:23:38.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-02-08T08:58:52.000Z (4 months ago)
• Last Synced: 2025-02-08T09:38:02.409Z (4 months ago)
• Topics: nushell
• Language: Nushell
• Homepage:
• Size: 18.6 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nu-pager-help

A replacement for the builtin help command of Nushell, with paging for large help pages.

## What it does

`nu-pager-help` is a Nushell package that ships a single module: [`nu-pager-help`](nu-pager-help/mod.nu).

This module then exports one alias and one command

- `core help`: an alias to the builtin `help` command, so that you never loose it forever :wink:

- `help`: a thin wrapper around the builtin `help` command which

  - adds completion for the command name

  - uses a pager if the help page is too large for the current terminal height

## Installation

The recommended way is to use [Nupm](https://github.com/nushell/nupm).