browser.md

Running yargs in the browser

Newer versions of yargs have a ./browser.mjs entrypoint, which can be used through a CDN like unpkg.com to load yargs directly in the browser:

<script type="module">
  import Yargs from 'https://unpkg.com/[email protected]/browser.mjs';
  const yargs = Yargs()
    .scriptName('>')
    .command('clear', 'clear the output window', () => {}, () => {
      // ...
    })
    .command('alert <message...>', 'display an alert', () => {}, (argv) => {
      alert(argv.message.join(' '))
    })
    .wrap(null)
    .strict()
    .demandCommand(1)
    .version('v1.0.0');
</script>

A full example can be found in example/yargs.html, or on jsfiddle.

Bundling

Even though yargs can run directly in the browser, you will still likely want to use a tool like rollup.js to create a bundle for the browser.