Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
getopts
Advanced tools
Readme
Parse CLI arguments.
minimist
and clones.Break up command-line arguments into key-value pairs for easy look-up and retrieval. Built upon utility conventions that have been used for decades, Getopts sane defaults help you write CLI tools that look and feel like the real deal.
$ example --type=module -o main.js *.{js,json}
import getopts from "getopts"
const options = getopts(process.argv.slice(2), {
alias: {
output: ["o", "f"],
type: "t",
},
})
The result is an object populated with all the parsed arguments.
{
_: ["index.js", "package.json"],
output: "main.js",
type: "module",
o: "main.js",
f: "main.js",
t: "module",
}
npm install getopts
A short option consists of a -
followed by a single alphabetic character. Multiple options can be grouped together without spaces. Short options are boolean by default unless followed by an operand (non-option) or if adjacent to any non-alphabetic characters:
getopts(["-ab", "-c"]) //=> { _: [], a:true, b:true, c:true }
getopts(["-a", "alpha"]) //=> { _: [], a:"alpha" }
getopts(["-abc1"]) //=> { _: [], a:true, b:true, c:1 }
Use opts.string
to parse an option as a string regardless.
getopts(["-kF12"], {
string: ["k"],
}) //=> { _: [], k:"F12" }
The first operand following an option will be used as its value. Use opts.boolean
to specify that an option should be parsed as a boolean regardless, causing the following argument to be treated as an operand instead.
getopts(["-a", "alpha"], {
boolean: ["a"],
}) //=> { _: ["alpha"], a:true }
Any character listed in the ASCII table can be used as a short option if it's the first character after the dash.
getopts(["-9", "-#10", "-%0.01"]) //=> { _:[], 9:true, #:10, %:0.01 }
A long option consists of a --
followed by a name and a value separated by an =
. Long options without a value are boolean by default.
getopts(["--turbo", "--warp=10"]) //=> { _: [], turbo:true, warp:10 }
getopts(["--warp=e=mc^2"]) //=> { _: [], warp:"e=mc^2" }
getopts(["--@", "alpha"]) //=> { _: [], @:"alpha" }
Negated options start with --no-
and are always false
.
getopts(["--no-turbo"]) //=> { _: [], turbo:false }
Every non-option argument is an operand. Operands are saved to the result._
operands array.
getopts(["alpha", "-w9", "bravo"]) //=> { _: ["alpha", "bravo"], w:9 }
getopts(["--code=alpha", "bravo"]) //=> { _: ["bravo"], code:"alpha" }
Everything after a standalone --
is an operand.
getopts(["--alpha", "--", "--bravo", "--turbo"]) //=> { _:["--bravo", "--turbo"], alpha:true }
A single -
is also treated as an operand.
getopts(["--turbo", "-"]) //=> { _:["-"], turbo:true }
Options specified as boolean or string will be added to the result object as false
or ""
(even if missing from the arguments array).
getopts([], {
string: ["a"],
boolean: ["b"],
}) //=> { _:[], a:"", b:false }
Repeated options are stored as arrays with every value in order of appearance.
getopts(["-x?alpha=bravo", "-x3.14", "-x"] //=> { _:[], a:["?alpha=bravo", 3.14, true] }
A value may contain newlines or other control characters.
getopts(["--text=top\n\tbottom"]) //=> { _:[], text:"top\n\tbottom" }
="false"
is converted to boolean by default.
getopts(["--turbo=false"]) //=> { _:[], turbo:false }
getopts(argv, opts)
Parse command-line arguments. Returns an object mapping argument names to their values.
argv[]
An array of arguments, usually process.argv
.
opts.alias
An object of option aliases. An alias can be a string or an array of strings. Aliases let you declare substitute names for an option, e.g., the short (abbreviated) and long (canonical) variations.
getopts(["-t"], {
alias: {
turbo: ["t", "T"],
},
}) //=> { _:[], t:true, T:true, turbo:true }
opts.boolean
An array of options to parse as boolean. In the example below, t
is parsed as a boolean, causing the following argument to be treated as an operand.
getopts(["-t", "alpha"], {
boolean: ["t"],
}) //=> { _:["alpha"], t:true }
opts.string
An array of flags to parse as strings. In the example below, t
is parsed as a string, causing all adjacent characters to be treated as a single value and not as individual options.
getopts(["-atabc"], {
string: ["t"],
}) //=> { _:[], a:true, t:"abc" }
opts.default
An object of default values for options not present in the arguments array.
getopts(["--warp=10"], {
default: {
warp: 15,
turbo: true,
},
}) //=> { _:[], warp:10, turbo:true }
opts.unknown()
We call this function for each unknown option. Return false
to discard the option. Unknown options are those that appear in the arguments array, but are not in opts.string
, opts.boolean
, opts.default
, or opts.alias
.
getopts(["-abc"], {
unknown: (option) => "a" === option,
}) //=> { _:[], a:true }
opts.stopEarly
A boolean property. If true
, the operands array _
will be populated with all the arguments after the first operand.
getopts(["-w9", "alpha", "--turbo", "bravo"], {
stopEarly: true,
}) //=> { _:["alpha", "--turbo", "bravo"], w:9 }
This property is useful when implementing sub-commands in a CLI.
import getopts from "getopts"
import { install, update, uninstall } from "./commands.js"
const options = getopts(process.argv.slice(2), {
stopEarly: true,
})
const [command, subargv] = options._
if (command === "install") {
install(subargv)
} else if (command === "update") {
update(subargv)
} else if (command === "uninstall") {
uninstall(subargv)
}
npm --prefix bench start
FAQs
Parse CLI arguments.
The npm package getopts receives a total of 1,315,660 weekly downloads. As such, getopts popularity was classified as popular.
We found that getopts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.