How to install PS-Menu on Windows PowerShell?

Use the Install-Module PS-Menu command from the PowerShellGallery, as shown in the README. Ensure you have PowerShellGet installed and run PowerShell as an administrator if needed for module installation.

Can PS-Menu handle multi-level or nested menus?

No, PS-Menu is designed for simple, flat menus only. The README doesn't mention nested menus, so for hierarchical options, you'd need to implement workarounds or use a more feature-rich library.

PS-Menu vs Out-GridView: which is better for PowerShell menus?

PS-Menu is lighter and console-based with keyboard navigation, ideal for scripts needing quick interaction. Out-GridView provides a graphical grid but requires GUI and may be overkill for simple menus; choose based on interface preference and complexity.

How to customize the appearance of PS-Menu items?

PS-Menu offers minimal customization; the README doesn't include options for styling or formatting. You're limited to the default console output, so for enhanced visuals, consider modifying the source code or using alternative modules.

Is PS-Menu compatible with PowerShell Core on Linux?

Yes, since it's a PowerShell module, it should work with PowerShell Core on Linux if installed via PowerShellGallery. However, test for any platform-specific issues, as the README doesn't explicitly confirm cross-platform support.

How to capture user input with PS-Menu in a script loop?

Use the menu function in a loop, checking the return value (which can be null on Esc key press). For example, wrap it in a while loop to handle repeated selections, but note that advanced state management isn't built-in.

Open-Awesome

PS-Menu

MITPowerShell

A PowerShell module for creating interactive console menus with keyboard navigation and selection returns.

GitHub

279 stars38 forks0 contributors

What is PS-Menu?

PS-Menu is a PowerShell module designed to generate interactive console menus for command-line applications. It allows developers to present users with selectable options and capture their choices, returning either the selected value or its index. This solves the problem of creating user-friendly, interactive interfaces in PowerShell scripts without relying on complex GUI frameworks.

Target Audience

PowerShell developers and scripters who need to build interactive command-line tools, automate workflows with user input, or enhance scripts with menu-driven interfaces.

Value Proposition

Developers choose PS-Menu for its simplicity, lightweight design, and familiar navigation patterns like arrow keys and Vim-style bindings. It provides a straightforward alternative to more complex menu libraries, making it easy to integrate into existing PowerShell projects.

Overview

Simple powershell menu to render interactive console menu

Use Cases

Best For

Adding interactive menus to PowerShell automation scripts
Building command-line tools with user-selectable options
Creating Yeoman-like interfaces in PowerShell environments
Enhancing PowerShell modules with keyboard-navigable menus
Developing scripts that require user input from a list of choices
Implementing Vim-style navigation in console applications

Not Ideal For

Projects requiring graphical user interfaces or web-based menus
Applications needing advanced menu features like nested menus, multi-select, or custom styling
Cross-platform scripts where PowerShell might not be installed or preferred
Large-scale tools with complex state management or integration with other CLI frameworks

Pros & Cons

Pros

Easy Installation

Available on PowerShellGallery, allowing installation with a single command like Install-Module PS-Menu, as shown in the README.

Intuitive Navigation

Supports up/down arrow keys and Vim-style j/k bindings, making it user-friendly for both general and Vim-familiar developers, per the features list.

Flexible Return Options

Can return either the selected value or its index using the -ReturnIndex switch, providing versatility for different scripting needs, as detailed in the README.

Lightweight Design

Focuses on simplicity without unnecessary complexity, aligning with its philosophy of minimal yet powerful menu creation, which reduces overhead in scripts.

Cons

Limited Feature Set

Missing advanced capabilities like nested menus, multi-select, or rich formatting, which restricts it to basic use cases and may require workarounds for complex interfaces.

Platform Dependency

Requires PowerShell, so it's not suitable for environments without PowerShell installed, such as some Linux systems without PowerShell Core, limiting cross-platform utility.

Minimal Documentation

The README provides only basic examples and lacks detailed API documentation, making it harder for developers to troubleshoot or explore advanced usage.

Open Source Alternative To

PS-Menu is an open-source alternative to the following products:

Yeoman

Frequently Asked Questions

Related Projects

Terminal-Icons

A PowerShell module to show file and folder icons in the terminal

Stars2,885

Forks133

Last commit1 year ago

BurntToast

Module for creating and displaying Toast Notifications on Microsoft Windows 10.

Stars1,703

Forks126

Last commit6 months ago

GraphicalTools

Modules that mix PowerShell and GUIs/CUIs!

Stars946

Forks72

Last commit5 days ago

Graphical

Open-Source, Platform independent module that consumes data points as input and plots them on a 2D graph 📈📊💹 [Scatter / Bar / Line] on the PowerShell Console/Terminal

Stars360

Forks33

Last commit2 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub