277 lines
7.5 KiB
HTML
277 lines
7.5 KiB
HTML
<!doctype html>
|
|
<html lang='en' class='no-js '>
|
|
<head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta charset='utf-8'>
|
|
<meta content='width=device-width, initial-scale=1.0' name='viewport'>
|
|
<link href='./assets/favicon.png' rel='shortcut icon'>
|
|
<meta content='/yargs.html' name='app:pageurl'>
|
|
|
|
|
|
<title>Yargs cheatsheet</title>
|
|
<meta content='Yargs cheatsheet' property='og:title'>
|
|
<meta content='Yargs cheatsheet' property='twitter:title'>
|
|
<meta content='article' property='og:type'>
|
|
|
|
|
|
|
|
<meta content='https://assets.devhints.io/previews/yargs.jpg?t=20200705143936' property='og:image'>
|
|
<meta content='https://assets.devhints.io/previews/yargs.jpg?t=20200705143936' property='twitter:image'>
|
|
<meta content='900' property='og:image:width'>
|
|
<meta content='471' property='og:image:height'>
|
|
|
|
|
|
|
|
<meta content="The one-page guide to Yargs: usage, examples, links, snippets, and more." name="description">
|
|
<meta content="The one-page guide to Yargs: usage, examples, links, snippets, and more." property="og:description">
|
|
<meta content="The one-page guide to Yargs: usage, examples, links, snippets, and more." property="twitter:description">
|
|
|
|
|
|
<link rel="canonical" href="https://devhints.io/yargs">
|
|
<meta name="og:url" content="https://devhints.io/yargs">
|
|
|
|
|
|
|
|
|
|
|
|
<meta content='Devhints.io cheatsheets' property='og:site_name'>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta content='JavaScript libraries' property='article:section'>
|
|
|
|
|
|
|
|
|
|
|
|
<script async src='https://www.googletagmanager.com/gtag/js?id=UA-106902774-1'></script>
|
|
<script>
|
|
|
|
window.dataLayer=window.dataLayer||[];
|
|
function gtag(){dataLayer.push(arguments)};
|
|
gtag('js',new Date());
|
|
gtag('config','UA-106902774-1');
|
|
</script>
|
|
|
|
|
|
|
|
<meta property='page:depth' content='1'>
|
|
|
|
|
|
<script>(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement)</script>
|
|
<script>(function(H){H.className=H.className.replace(/\bNoJs\b/,'WithJs')})(document.documentElement)</script>
|
|
|
|
<script>(function(d,s){if(window.Promise&&[].includes&&Object.assign&&window.Map)return;var js,sc=d.getElementsByTagName(s)[0];js=d.createElement(s);js.src='https://cdn.polyfill.io/v2/polyfill.min.js';sc.parentNode.insertBefore(js, sc);}(document,'script'))</script>
|
|
|
|
<!--[if lt IE 9]><script src='https://cdnjs.cloudflare.com/ajax/libs/nwmatcher/1.2.5/nwmatcher.min.js'></script><script src='https://cdnjs.cloudflare.com/ajax/libs/json2/20140204/json2.js'></script><script src='https://cdn.rawgit.com/gisu/selectivizr/1.0.3/selectivizr.js'></script><script src='https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js'></script><script src='https://cdnjs.cloudflare.com/ajax/libs/respond.js/1.4.2/respond.js'></script><![endif]-->
|
|
|
|
<style>html{opacity:0}</style>
|
|
<link rel="stylesheet" href="./assets/2015/style.css?t=20200705143936">
|
|
<link href="./assets/style.css?t=20200705143936" rel="stylesheet" />
|
|
<link href="./assets/print.css?t=20200705143936" rel="stylesheet" media="print" />
|
|
</head>
|
|
<body>
|
|
<div class='all'>
|
|
|
|
<div class='site-header'>
|
|
<div class='container'>
|
|
This is <a href="."><em>Devhints.io cheatsheets</em></a> — a collection of cheatsheets I've written.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<script type='application/ld+json'>
|
|
{
|
|
"@context": "http://schema.org",
|
|
"@type": "NewsArticle",
|
|
"mainEntityOfPage": {
|
|
"@type": "WebPage",
|
|
"@id": "https://google.com/article"
|
|
},
|
|
"headline": "Yargs cheatsheet",
|
|
"image": [ "https://assets.devhints.io/previews/yargs.jpg?t=20200705143936" ],
|
|
"description": "The one-page guide to Yargs: usage, examples, links, snippets, and more."
|
|
}
|
|
</script>
|
|
<script type='application/ld+json'>
|
|
{
|
|
"@context": "http://schema.org",
|
|
"@type": "BreadcrumbList",
|
|
"itemListElement": [{
|
|
"@type": "ListItem",
|
|
"position": 1,
|
|
"item": {
|
|
"@id": "https://devhints.io/#javascript-libraries",
|
|
"name": "JavaScript libraries"
|
|
}
|
|
},{
|
|
"@type": "ListItem",
|
|
"position": 2,
|
|
"item": {
|
|
"@id": "https://devhints.io/yargs",
|
|
"name": "Yargs"
|
|
}
|
|
}]
|
|
}
|
|
</script>
|
|
|
|
|
|
<div class='post-list -single -cheatsheet'>
|
|
<div class='post-item'>
|
|
<div class='post-headline -cheatsheet'>
|
|
<p class='prelude'><span></span></p>
|
|
<h1><span>Yargs</span></h1>
|
|
|
|
<div class='pubbox'>
|
|
<div class='HeadlinePub' role='complementary'>
|
|
<script async src='https://pubsrv.devhints.io/carbon.js?serve=CE7IK5QM&placement=devhintsio' id="_carbonads_js"></script>
|
|
<span class='placeholder -one'></span>
|
|
<span class='placeholder -two'></span>
|
|
<span class='placeholder -three'></span>
|
|
<span class='placeholder -four'></span>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class='post-content -cheatsheet'>
|
|
<h3 id="basic-usage">Basic usage</h3>
|
|
|
|
<pre><code class="language-js">var argv = require('yargs').argv;
|
|
|
|
argv._ // [ ... ]
|
|
argv.$0 // "node bin/mybin"
|
|
argv.verbose // --verbose
|
|
</code></pre>
|
|
|
|
<h3 id="help-and-version">Help and version</h3>
|
|
|
|
<pre><code class="language-js">var argv = require('yargs')
|
|
|
|
// version
|
|
.alias('v', 'version')
|
|
.version(function() { return require('../package').version; })
|
|
.describe('v', 'show version information')
|
|
|
|
// help text
|
|
.alias('h', 'help')
|
|
.help('help')
|
|
.usage('Usage: $0 -x [num]')
|
|
.showHelpOnFail(false, "Specify --help for available options")
|
|
</code></pre>
|
|
|
|
<h3 id="options">Options</h3>
|
|
|
|
<pre><code class="language-js"> .option('f', {
|
|
alias : 'file',
|
|
describe: 'x marks the spot',
|
|
type: 'string', /* array | boolean | string */
|
|
nargs: 1,
|
|
demand: true,
|
|
demand: 'file is required',
|
|
default: '/etc/passwd'
|
|
// also: count:true, requiresArg:true
|
|
})
|
|
|
|
.options({
|
|
f: { ... }
|
|
})
|
|
</code></pre>
|
|
|
|
<h3 id="examples-and-more-help-stuff">Examples and more help stuff</h3>
|
|
|
|
<pre><code class="language-js"> // more help
|
|
.example('...')
|
|
.epilog('copyright 2015')
|
|
.command('start', 'start a server')
|
|
</code></pre>
|
|
|
|
<h3 id="stacking">Stacking</h3>
|
|
|
|
<pre><code class="language-js"> .count('verbose')
|
|
|
|
argv.verbose // -vvv => 3
|
|
</code></pre>
|
|
|
|
<h3 id="reject-non-explicits">Reject non explicits</h3>
|
|
|
|
<pre><code class="language-js"> .strict()
|
|
</code></pre>
|
|
|
|
<h3 id="methods">Methods</h3>
|
|
|
|
<pre><code>yargs.showHelp()
|
|
yargs.help() //=>string
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
|
|
<ul class="social-list ">
|
|
<li class="facebook link hint--bottom" data-hint="Share on Facebook"><a href="https://www.facebook.com/sharer/sharer.php?u=https://devhints.io/yargs.html" target="share"><span class="text"></span></a></li>
|
|
<li class="twitter link hint--bottom" data-hint="Share on Twitter"><a href="https://twitter.com/intent/tweet?text=The%20ultimate%20cheatsheet%20for%20Yargs.%20https://devhints.io/yargs.html" target="share"><span class="text"></span></a></li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="about-the-site">
|
|
<div class="container">
|
|
<p class='blurb'>
|
|
<strong><a href=".">Devhints.io cheatsheets</a></strong> is a collection of cheatsheets I've written over the years.
|
|
Suggestions and corrections? <a href='https://github.com/rstacruz/cheatsheets/issues/907'>Send them in</a>.
|
|
<i class='fleuron'></i>
|
|
I'm <a href="http://ricostacruz.com">Rico Sta. Cruz</a>.
|
|
Check out my <a href="http://ricostacruz.com/til">Today I learned blog</a> for more.
|
|
</p>
|
|
|
|
|
|
<p class='back'>
|
|
<a class='big-button -back -slim' href='.#toc'></a>
|
|
</p>
|
|
|
|
|
|
<p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.5/highlight.min.js"></script>
|
|
|
|
|
|
|
|
|
|
<script src="https://cdn.rawgit.com/rstacruz/unorphan/v1.0.1/index.js"></script>
|
|
<script>hljs.initHighlightingOnLoad()</script>
|
|
<script>unorphan('h1, h2, h3, p, li, .unorphan')</script>
|
|
|
|
</body>
|
|
</html>
|
|
|