How to add descriptions to npm scripts for ntl?

Define descriptions in a 'ntl' section of your package.json with a 'descriptions' object mapping script names to their descriptions. ntl will display these in the interface, as shown in the README's customization examples.

ntl vs npm-run-all for running multiple scripts?

ntl focuses on interactive selection and serial execution with a UI, ideal for ad-hoc tasks, while npm-run-all is better for programmatically running scripts in order or parallel without interactivity. Choose ntl for visual management, npm-run-all for automation scripts.

Can ntl run scripts in parallel?

No, ntl runs selected scripts in serial order only. For parallel execution, you need to use other tools like npm-run-all or define a custom script in package.json that uses concurrent commands, as ntl doesn't support this feature.

How to exclude certain scripts from the ntl menu?

Use the --exclude option with script names or wildcards, e.g., 'ntl -e test*' to exclude all scripts starting with 'test'. This can also be embedded in package.json tasks for repeated use, as mentioned in the tips section.

Is ntl compatible with yarn or pnpm?

Yes, ntl can be configured to use yarn or pnpm as the runner by setting the NTL_RUNNER environment variable or defining it in the package.json's ntl configuration. This allows flexibility across different package managers.

How to quickly rerun the last script with ntl?

Use the 'nt' command shorthand, which caches the last executed script per project. Alternatively, use 'ntl -r' or set NTL_RERUN=true, with cache options customizable via environment variables for persistence.

ntl — Interactive Package.json Script Runner

What is ntl?

ntl (Node Task List) is an interactive command-line tool that lists and runs scripts defined in a project's package.json file. It provides a visual interface to browse, select, and execute npm scripts, eliminating the need to remember or type commands manually. The tool enhances developer productivity by simplifying script management and offering features like task descriptions, multi-script execution, and rerun capabilities.

Target Audience

Node.js developers and teams who frequently work with npm scripts in their projects and seek a more intuitive way to manage and execute build, test, and other automation tasks.

Value Proposition

Developers choose ntl for its interactive and user-friendly approach to script execution, which reduces errors and saves time compared to manual command entry. Its unique selling point is the seamless integration of features like fuzzy search, multi-task runs, and a convenient rerun shortcut, all within a lightweight CLI tool.

Node Task List: Interactive cli to list and run package.json scripts

Use Cases

Best For

Quickly exploring and running scripts in unfamiliar Node.js projects
Managing projects with numerous or complex npm scripts
Reducing typos and errors when executing package.json commands
Setting up a default task runner for team development workflows
Repeating the last executed script without retyping commands
Executing multiple build or test scripts in a specific sequence

Not Ideal For

CI/CD pipelines that require fully automated, non-interactive script execution without any user input
Developers who need to frequently pass dynamic arguments to npm scripts, as ntl doesn't support interactive argument input beyond selection
Projects with only a handful of simple scripts where the cognitive load of remembering commands is minimal
Environments where global npm installations are prohibited, as ntl typically requires global install for optimal convenience

Pros & Cons

Pros

Interactive Script Discovery

Presents a navigable list or autocomplete fuzzy search to easily find and select scripts, reducing the need to memorize commands, as shown in the multiple interface modes like --autocomplete.

Convenient Rerun Shortcut

Includes a shorthand command 'nt' to quickly repeat the last executed script, with configurable caching options via environment variables or CLI flags for efficiency.

Multi-Task Execution

Allows selecting and running multiple scripts in serial with the --multiple option, and you can preserve the order of selection using --ordered for complex workflows.

Customizable Descriptions

Supports adding descriptive metadata to scripts in a package.json's ntl section, displayed in the UI for better clarity and documentation, as detailed in the 'Using task descriptions' section.

Cons

No Interactive Argument Support

While it runs scripts, ntl doesn't provide a way to interactively input arguments for scripts that require them, limiting its use for parameterized tasks without pre-defined variations.

Global Installation Dependency

For optimal use, ntl needs to be installed globally, which might not be feasible in restricted environments or for teams without standardized tooling, though per-project install is possible.

Cache Configuration Complexity

Customizing the rerun cache involves setting multiple environment variables like NTL_RERUN_CACHE_DIR or using command-line options, which can be cumbersome for casual users compared to simpler tools.

What is ntl?

Target Audience

Node.js developers and teams who frequently work with npm scripts in their projects and seek a more intuitive way to manage and execute build, test, and other automation tasks.

Value Proposition

Use Cases

Best For

Quickly exploring and running scripts in unfamiliar Node.js projects
Managing projects with numerous or complex npm scripts
Reducing typos and errors when executing package.json commands
Setting up a default task runner for team development workflows
Repeating the last executed script without retyping commands
Executing multiple build or test scripts in a specific sequence

Not Ideal For

CI/CD pipelines that require fully automated, non-interactive script execution without any user input
Developers who need to frequently pass dynamic arguments to npm scripts, as ntl doesn't support interactive argument input beyond selection
Projects with only a handful of simple scripts where the cognitive load of remembering commands is minimal
Environments where global npm installations are prohibited, as ntl typically requires global install for optimal convenience

Pros & Cons

Pros

Interactive Script Discovery

Presents a navigable list or autocomplete fuzzy search to easily find and select scripts, reducing the need to memorize commands, as shown in the multiple interface modes like --autocomplete.

Convenient Rerun Shortcut

Includes a shorthand command 'nt' to quickly repeat the last executed script, with configurable caching options via environment variables or CLI flags for efficiency.

Multi-Task Execution

Allows selecting and running multiple scripts in serial with the --multiple option, and you can preserve the order of selection using --ordered for complex workflows.

Customizable Descriptions

Supports adding descriptive metadata to scripts in a package.json's ntl section, displayed in the UI for better clarity and documentation, as detailed in the 'Using task descriptions' section.

Cons

No Interactive Argument Support

While it runs scripts, ntl doesn't provide a way to interactively input arguments for scripts that require them, limiting its use for parameterized tasks without pre-defined variations.

Global Installation Dependency

For optimal use, ntl needs to be installed globally, which might not be feasible in restricted environments or for teams without standardized tooling, though per-project install is possible.

Cache Configuration Complexity

Customizing the rerun cache involves setting multiple environment variables like NTL_RERUN_CACHE_DIR or using command-line options, which can be cumbersome for casual users compared to simpler tools.

ntl

What is ntl?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

ntl

What is ntl?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?