Examples for: Command-line argument parsing with Node.js core

01-run-script-example.sh

node script.mjs --name "Budgie" --verbose

02-minimist-example.mjs

import minimist from "minimist";

const args = minimist(process.argv.slice(2), {
  string: ["name"],
  boolean: ["verbose"],
  alias: {
    name: "n",
    verbose: "v",
  },
});

console.log(args);
// > { _: [], verbose: true, v: true, name: 'Budgie', n: 'Budgie' }

03-parseargs-example.mjs

import { parseArgs } from "node:util";

const args = parseArgs({
  options: {
    name: {
      type: "string",
      short: "n",
    },
    verbose: {
      type: "boolean",
      short: "v",
    },
  },
});

console.log(args);
// > {
// >   values: { name: 'Budgie', verbose: true },
// >   positionals: []
// > }

04-parseargs-defaults-example.mjs

import { parseArgs } from "@pkgjs/parseargs";

const args = parseArgs({
  options: {
	message: {
	  type: "string",
	  default: "Oh hai there!",
	},
  }
});

console.log(args);
// > {
// >   values: [Object: null prototype] { message: 'Oh hai there!' },
// >   positionals: []
// > }