ScriptPal 🤘

A simple npm script palette for lazy people who want a quick way to look through and pick npm scripts!

• keyboard navigation
• autocompletion
• fuzzy finding
• bookmarks

Install ⬇️

Install globally

npm install -g scriptpal

Usage 🏁

scriptpal

Usage with npx

npx scriptpal

API 🤖

• --nowelcome, -n Omit welcome message
• --last, -l Run previous command
• --version, -v Version number
• --clipboard, -c Copy command to clipboard
• --help Help me 🙏
• list, ls List local npm scripts from package.json
• bookmark add <name> <command...> Add a bookmark
• bookmark edit <name> <command...> Edit a bookmark
• bookmark remove <name>, bookmark rm <name> Remove a bookmark
• bookmark list, bookmark ls List bookmarks
• bookmark run <name> [name=value ...] Run a bookmark and resolve wildcards (supports scalar, enum, and array wildcard modifiers)
• bookmark --last, bookmark -l Run previous bookmark command
• bookmark Open a fuzzy-findable bookmark picker and run selection

Running Arbitrary Scripts

It's possible to also run arbitrary scripts from your package.json by passing them as sub-commands, similar to yarn.

For example: scriptpal test will run npm run test.

list / ls

list List all scripts found in local package.json.

bookmark

Store reusable command bookmarks globally.

Wildcards use ${...} syntax and are resolved when running bookmarks. If a required wildcard is not provided, ScriptPal prompts for it.

Wildcard Syntax

Scalar wildcard

${name}

Example:

scriptpal bookmark add testpkg "yarn test packages/${package}"
scriptpal bookmark run testpkg package=button
# yarn test packages/button

Enum-constrained scalar wildcard

${name:enum(button|modal|card)}

Only one of the listed values is accepted.

Array wildcard

${name:array}
${name:array:or}
${name:array:brace}
${name:array:space}
${name:array:csv}

Array render modes:

• :or => (a|b)
• :brace => {a,b}
• :space => a b
• :csv => a,b

${name:array} defaults to :csv.

Enum-constrained array wildcard

${name:array:or:enum(button|modal|card)}

Every array entry must be in the enum list.

Accepted array input formats

All of these are accepted as wildcard values for array wildcards:

• name=button
• name=button,modal
• name=button|modal
• name=[button,modal]
• name=(button|modal)

End-to-end examples

Single package:

scriptpal bookmark add typecheck "yarn typecheck packages/${pkg:array:or}"
scriptpal bookmark run typecheck pkg=button
# yarn typecheck packages/(button)

Multiple packages:

scriptpal bookmark run typecheck pkg=button,modal
# yarn typecheck packages/(button|modal)

Enum-constrained:

scriptpal bookmark add typecheck-safe "yarn typecheck packages/${pkg:array:or:enum(button|modal|card)}"
scriptpal bookmark run typecheck-safe pkg=button,modal
# yarn typecheck packages/(button|modal)

Invalid enum value:

scriptpal bookmark run typecheck-safe pkg=button,toast
# Error: Invalid value for wildcard "pkg": toast. Allowed: button, modal, card.

Examples

• $ scriptpal => Shows a prompt containing a list of npm scripts from the closest package.json.
• $ scriptpal --last => Runs the previous command
• $ scriptpal list / $ scriptpal ls => Prints all npm scripts from the closest package.json.
• $ scriptpal start => Runs npm run start. Can be used with other scripts as well.
• $ scriptpal bookmark add testpkg "yarn test src/packages/${package}" => Saves a bookmark.
• $ scriptpal bookmark run testpkg package=ui-button => Runs yarn test src/packages/ui-button.
• $ scriptpal bookmark add typecheck "yarn typecheck packages/${pkg:array:or}" => Saves an array wildcard bookmark.
• $ scriptpal bookmark run typecheck pkg=button,modal => Runs yarn typecheck packages/(button|modal).
• $ scriptpal bookmark --last => Runs the last executed bookmark command.
• $ scriptpal bookmark ls => Lists bookmarks.
• $ scriptpal bookmark => Opens fuzzy picker for saved bookmarks and runs selected one.

You might also like...

• CommitPal: A delightful CLI tool for building complex commit messages
• Enquirer: Stylish, intuitive and user-friendly prompts