/rexample

🏃‍♂️ Simple CLI to execute & run scripts

Primary LanguageJavaScriptMIT LicenseMIT



🏃‍♂️
rexample




Simple CLI to execute & run scripts



🚀 Install

You have a few options to install the CLI:

# Locally
npm install --save-dev rexample

# Globally
npm install -g rexample

# npx
npx rexample

🦄 Usage

To get started using the CLI simply create a new example script you want to run.

The only requirement is that the script exports a default function to execute. The reason for this is due to avoid module import automatic code execution.

For example, here is a basic script that will log "Hello world!" to the console:

// examples/basic.ts
function main() {
  console.log("Hello world!");
}

export default main;

Then simply run the CLI, either by passing in the name of the file or by selecting it from the list:

# Run the CLI & select a script to run
rexample

And you will get the the output of your selected script:

Hello world!