index.html

---
layout: default
---

  <div class="landing-wrapper">
    <div class="wrapper">
      <div class="title">
        <h1 class="pink-highlight">Yargs be a node.js library fer hearties tryin' ter parse optstrings.</h1>
      </div>
    </div>
  </div>

  <div class="wrapper">
    <div class="page-content align-items">

      <div class="page-box-full markdown-body">

        <div class="page-heading">What's Yargs?</div>
        <p class="description">
          Yargs helps you build interactive command line tools by parsing arguments and generating an elegant user interface.
        </p>

        <p class="description">
          Yargs gives you:
        </p>

        <ul class="description">
          <li> commands and (grouped) options (like module run -n --force),</li>
          <li> a dynamically generated help menu based on your arguments, </li>
          <li> bash-completion shortcuts for commands and options, </li>
          <li> and much more. </li>
        </ul>

        <p class="description">
          With these features, and many more, yargs allows you to focus on building your program without worrying about your args.
        </p>

      </div>

      <div class="page-box">

        <div class="page-heading">Install</div>
        <p class="description">
          Open your terminal, navigate to your project, and run using npm:
        </p>
        <div class="sh-code">
          $ npm install --save yargs
        </div>

      </div>
    </div>

    <div class="page-content align-items">
      <div class="page-box">

        <div class="page-heading"> Getting Started </div>

        <div class="instructions"> After creating example.js start with the following code to get you going: </div>

        <pre>
          <code class="hljs language-javascript">
#!/usr/bin/env node

require('yargs')
  .scriptName("pirate-parser")
  .usage('$0 &lt;cmd&gt; [args]')
  .command('hello [name]', 'welcome ter yargs!', (yargs) => {
    yargs.positional('name', {
      type: 'string',
      default: 'Cambi',
      describe: 'the name to say hello to'
    })
  }, function (argv) {
    console.log('hello', argv.name, 'welcome to yargs!')
  })
  .help()
  .argv

          </code>
        </pre>

        <div class="instructions"> And in your terminal run: </div>

        <pre>
          <code class="hljs language-bash">
  $ node example.js --help
          </code>
        </pre>

        <div class="instructions"> To get this output: </div>

        <pre>
          <code class="hljs language-bash">
  pirate-parser &lt;cmd&gt; [args]

  Commands:
    pirate-parser hello [name]  welcome ter yargs!

  Options:
    --help  Show help                                                    [boolean]
          </code>
        </pre>

        <div class="instructions"> Run hello command: </div>

        <pre>
          <code class="hljs language-bash">
  $ node example.js hello --name Parrot
  hello Parrot welcome to yargs!
          </code>
        </pre>

      </div>
    </div>

  </div>