This document outlines how to bundle your libraries that use yargs into standalone distributions.

Newer releases of yargs can run directly in modern browsers, take a look at Running yargs in the browser.

If you are targeting Node.js with your bundle, we recommend using @vercel/ncc.

Given a CommonJS file, index.js:

const yargs = require('yargs/yargs')
const chalk = require('chalk')
require('yargs/yargs')(process.argv.slice(2))
  .option('awesome-opt', {
    describe: `my awesome ${chalk.green('option')}`
  })
  .parse()

You can simply run: ncc build index.js.

The following is tested with webpack 5.x

In a new project (see: npm-init):

1. npm install yargs assert path-browserify.
2. Create the following index.js:

   const yargs = require('yargs/yargs')
   require('yargs/yargs')(process.argv.slice(2))
     .option('awesome-opt', {
       describe: `my awesome option`
     })
     .parse()

3. Create the following webpack.config.js:

   const path = require('path');
   
   module.exports = {
     mode: 'development',
     devtool: 'source-map',
     entry: './index.js',
     output: {
       filename: 'bundle.js',
       path: path.resolve(__dirname, 'dist'),
     },
     resolve: {
       fallback: {
         assert: require.resolve("assert"),
         fs: false,
         path: require.resolve("path-browserify")
       },
     },
   };

4. Run: npx webpack@5 --config webpack.config.js.
5. You can now execute dist/bundle.js.

The following is tested with [email protected] In a new project (see: npm-init):

1. npm install esbuild yargs
2. Create the following index.js

const yargs = require('yargs')
const argv = yargs(process.argv).parse()

if (argv.ships > 3 && argv.distance < 53.5) {
  console.log('Plunder more riffiwobbles!')
} else {
  console.log('Retreat from the xupptumblers!')
}

3. Runt npx esbuild index.js --bundle --outfile=bundle.js --platform=node --target=node12
4. You can now execute node bundle.js.