matrixfurry.com
Easily turn Nushell modules into cross-shell CLI tools
library
nu
nushell
1<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
2<!-- Copyright (c) 2026 MatrixFurry <matrix@matrixfurry.com> -->
3
4# ModCLI #
5
6ModCLI allows you to easily turn Nushell modules into cross-shell CLI tools. This makes it much easier to write complex
7CLI tools with many subcommands using Nushell.
8
9## Usage ##
10
11Load this module, then call `modcli install <module-source> [install-prefix]` to install your module as a CLI tool.
12If you're developing a CLI tool, I recommend adding this to your installation script.
13
14See `modcli install --help` for more options.
15
16Use `modcli uninstall <name> [prefix]` to uninstall the tool.
17
18### Hidden Functions ###
19
20You can hide functions from being listed in the help menu by prefixing them with an underscore (`_`). They will still be
21executable when ran directly, and can be shown with the `--list-all` flag. This feature may be useful for debug or
22one-time migration functions.