unified-args

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[unified][] engine to create a command line interface from a unified
processor.

* What is this?
* When should I use this?
* Install
* Use
* API
* args(options)
* Options
* CLI
* Files
* --color
* --config
* --ext
* --file-path
* --frail
* --help
* --ignore
* --ignore-path
* --ignore-path-resolve-from cwd|dir
* --ignore-pattern
* --inspect
* [--output [path]](#--output-path)
* --quiet
* --rc-path
* --report
* --setting
* --silent
* --silently-ignore
* --stdout
* --tree
* --tree-in
* --tree-out
* --use
* --verbose
* --version
* --watch
* Diagnostics
* Debugging
* Types
* Compatibility
* Security
* Contribute
* License

What is this?

This package wraps [unified-engine][unified-engine] so that it can be used
to create a command line interface.
It’s what you use underneath when you use [remark-cli][remark-cli].

When should I use this?

You can use this to let users process multiple files from the command line,
letting them configure from the file system.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh npm install unified-args`

`Use`

The following example creates a CLI for [remark][], which will search for files in folders with a markdown extension, allows [configuration][config-file] from.remarkrc and package.jsonfiles, [ignoring files][ignore-file] from.remarkignore files, and more.

Say our module example.js looks as follows:

`js import {remark} from 'remark' import {args} from 'unified-args'

args({ description: 'Command line interface to inspect and change markdown files with remark', extensions: [ 'md', 'markdown', 'mdown', 'mkdn', 'mkd', 'mdwn', 'mkdown', 'ron' ], ignoreName: '.remarkignore', name: 'remark', packageField: 'remarkConfig', pluginPrefix: 'remark', processor: remark, rcName: '.remarkrc', version: '11.0.0' })`

…now running node example.js --help yields:

`txt Usage: remark [options] [path | glob ...]

Command line interface to inspect and change markdown files with remark

Options:

--[no-]color specify color in report (on by default) --[no-]config search for configuration files (on by default) -e --ext specify extensions …`

`API`

This package exports the identifier [args][api-args]. There is no default export.

`$3`

Start the CLI.

> 👉 Note: this takes over the entire process. > It parsesprocess.argv, exits when its done, etc.

###### Parameters

* options ([Options][api-options], required) — configuration

###### Returns

Nothing (undefined).

`$3`

Configuration (TypeScript type).

###### Fields

* description (string, required) — description of executable *extensions (Array, required) — default file extensions to include (engine:options.extensions) *ignoreName (string, required) — name of [ignore files][ignore-file] to load (engine:options.ignoreName) *name (string, required) — name of executable *packageField (string, required) — field where [configuration][config-file] can be found inpackage.jsons (engine:options.packageField) *pluginPrefix (string, required) — prefix to use when searching for plugins (engine:options.pluginPrefix) *processor ([Processor][unified-processor], required) — processor to use (engine:options.processor) *rcName (string, required) — name of [configuration files][config-file] to load (engine:options.rcName) *version (string, required) — version of executable

`CLI`

CLIs created with unified-args, such as the [example][] above, have an interface similar to the below:

`txt Usage: remark [options] [path | glob ...]

Command line interface to inspect and change markdown files with remark

Options:

--[no-]color specify color in report (on by default) --[no-]config search for configuration files (on by default) -e --ext specify extensions --file-path specify path to process as -f --frail exit with 1 on warnings -h --help output usage information --[no-]ignore search for ignore files (on by default) -i --ignore-path specify ignore file --ignore-path-resolve-from cwd|dir resolve patterns inignore-pathfrom its directory or cwd --ignore-pattern specify ignore patterns --inspect output formatted syntax tree -o --output [path] specify output location -q --quiet output only warnings and errors -r --rc-path specify configuration file --report specify reporter -s --setting specify settings -S --silent output only errors --silently-ignore do not fail when given ignored files --[no-]stdout specify writing to stdout (on by default) -t --tree specify input and output as syntax tree --tree-in specify input as syntax tree --tree-out output syntax tree -u --use use plugins --verbose report extra info for messages -v --version output version number -w --watch watch for changes and reprocess

Examples:

# Process input.md$ remark input.md -o output.md

# Pipe $ remark < input.md > output.md

# Rewrite all applicable files $ remark . -o`

`$3`

All non-options passed to the cli are seen as input and can be:

paths (readme.txt) and [globs][glob] (.txt) pointing to files to load * paths (test) and globs (fixtures/{in,out}/) pointing to folders, which are searched for files with known extensions which are not ignored by patterns in [ignore files][ignore-file]. The default behavior is to exclude files innode_modules/unless explicitly given

You can force things to be seen as input by using --:

`sh cli -- globs/* and/files`

* default: none * engine:options.files

`$3`

`sh cli --no-color input.txt`

Whether to output ANSI color codes in the report.

* default: whether the terminal [supports color][supports-color] * engine:options.color

> 👉 Note: This option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --no-config input.txt`

Whether to load [configuration files][config-file].

Searches for files with the [configured][api-options] rcName: $rcNameand$rcName.json (JSON), $rcName.yml and $rcName.yaml (YAML), $rcName.js(JavaScript),$rcName.cjs (CommonJS), and $rcName.mjs(ESM); and looks for the configuredpackageField in package.json files.

* default: on * engine:options.detectConfig

`$3`

`sh cli --ext html . cli --ext htm --ext html . cli --ext htm,html .`

Specify one or more extensions to include when searching for files.

* default: [configured][api-options] extensions* alias:-e* engine:options.extensions

`$3`

`sh cli --file-path input.txt < input.txt > doc/output.txt`

File path to process the given file on stdin(4) as, if any.

* default: none * engine:options.filePath

`$3`

`sh cli --frail input.txt`

Exit with a status code of 1if warnings or errors occur. The default behavior is to exit with1 on errors.

* default: off * alias:-f* engine:options.frail

`$3`

`sh cli --help`

Output short usage information.

* default: off * alias:-h

`$3`

`sh cli --no-ignore .`

Whether to load [ignore files][ignore-file].

Searches for files named [$ignoreName][api-options].

* default: on * engine:options.detectIgnore

`$3`

`sh cli --ignore-path .gitignore .`

File path to an [ignore file][ignore-file] to load, regardless of [--ignore][cli-ignore].

* default: none * alias:-i* engine:options.ignorePath

`$3`

`sh cli --ignore-path node_modules/my-config/my-ignore --ignore-path-resolve-from cwd .`

Resolve patterns in the ignore file from its directory (dir, default) or the current working directory (cwd).

* default: 'dir'* engine:options.ignorePathResolveFrom

`$3`

`sh cli --ignore-pattern "docs/*.md" .`

Additional patterns to use to ignore files.

* default: none * engine:options.ignorePatterns

`$3`

`sh cli --inspect < input.txt`

Output the transformed syntax tree, formatted with [unist-util-inspect][unist-util-inspect]. This does not run the [compilation phase][overview].

* default: off * engine:options.inspect

`$3`

`sh cli --output -- . cli --output doc . cli --output doc/output.text input.txt`

Whether to write successfully processed files, and where to. Can be set from [configuration files][config-file].

* if output is not given, files are not written to the file system * otherwise, ifpathis not given, files are overwritten when successful * otherwise, ifpathpoints to a folder, files are written there * otherwise, if one file is processed, the file is written topath

> 👉 Note: intermediate folders are not created.

* default: off * alias:-o* engine:options.output

`$3`

`sh cli --quiet input.txt`

Ignore files without any messages in the report. The default behavior is to show a success message.

* default: off * alias:-q* engine:options.quiet

> 👉 Note: this option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --rc-path config.json .`

File path to a [configuration file][config-file] to load, regardless of [--config][cli-config].

* default: none * alias:-r* engine:options.rcPath

`$3`

`sh cli --report ./reporter.js input.txt cli --report vfile-reporter-json input.txt cli --report json input.txt cli --report json=pretty:2 input.txt cli --report 'json=pretty:"\t"' input.txt

`Only last one is used:`


cli --report pretty --report json input.txt


[Reporter][] to load by its name or path, optionally with options, and use to
report metadata about every processed file.

To pass options, follow the name by an equals sign (=) and settings, which have the same in syntax as [--setting ][cli-setting].

The prefix vfile-reporter-can be omitted. Prefixed reporters are preferred over modules without prefix.

If multiple reporters are given, the last one is used.

* default: none, which uses [vfile-reporter][vfile-reporter] * engine:options.reporter and options.reporterOptions

> 👉 Note: the [quiet][cli-quiet], [silent][cli-silent], and > [color][cli-color] options may not work with the used reporter. > If they are given, they are preferred over the same properties in reporter > settings.

`$3`

`sh cli --setting alpha:true input.txt cli --setting bravo:true --setting '"charlie": "delta"' input.txt cli --setting echo-foxtrot:-2 input.txt cli --setting 'golf: false, hotel-india: ["juliet", 1]' input.txt`

Configuration for the parser and compiler of the processor. Can be set from [configuration files][config-file].

The given settings are [JSON5][], with one exception: surrounding braces must not be used. Instead, use JSON syntax without braces, such as"foo": 1, "bar": "baz".

* default: none * alias:-s* engine:options.settings

`$3`

`sh cli --silent input.txt`

Show only fatal errors in the report. Turns [--quiet][cli-quiet] on.

* default: off * alias:-S* engine:options.silent

> 👉 Note: this option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --silently-ignore */.md`

Skip given files which are ignored by ignore files, instead of warning about them.

* default: off * engine:options.silentlyIgnore

`$3`

`sh cli --no-stdout input.txt`

Whether to write a processed file to stdout(4).

* default: off if [--output][cli-output] or [--watch][cli-watch] are given, or if multiple files could be processed * engine:options.out

`$3`

`sh cli --tree < input.json > output.json`

Treat input as a syntax tree in JSON and output the transformed syntax tree. This runs neither the [parsing nor the compilation phase][overview].

* default: off * alias:-t* engine:options.tree

`$3`

`sh cli --tree-in < input.json > input.txt`

Treat input as a syntax tree in JSON. This does not run the [parsing phase][overview].

* default: same as --tree* engine:options.treeIn

`$3`

`sh cli --tree-out < input.txt > output.json`

Output the transformed syntax tree. This does not run the [compilation phase][overview].

* default: same as --tree* engine:options.treeOut

`$3`

`sh cli --use remark-man input.txt cli --use man input.txt cli --use 'toc=max-depth:3' input.txt cli --use ./plugin.js input.txt`

Plugin to load by its name or path, optionally with options, and use on every processed file. Can be set from [configuration files][config-file].

To pass options, follow the plugin by an equals sign (=) and settings, which have the same in syntax as [--setting ][cli-setting].

Plugins prefixed with the [configured][api-options] pluginPrefixare preferred over modules without prefix.

* default: none * alias:-u* engine:options.plugins

`$3`

`sh cli --verbose input.txt`

Print more info for messages.

* default: off * engine:options.verbose

> 👉 Note: this option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --version`

Output version number.

* default: off * alias:-v

`$3`

`sh cli -qwo .`

Yields:

`txt Watching... (press CTRL+C to exit) Note: Ignoring--outputuntil exit.`

Process as normal, then watch found files and reprocess when they change. The watch is stopped whenSIGINTis received (usually done by pressingCTRL-C).

If [--output][cli-output] is given without path, it is not honored, to prevent an infinite loop. On operating systems other than Windows, when the watch closes, a final process runs including--output.

* default: off * alias:-w

`Diagnostics`

CLIs created with unified-args exit with:

* 1on fatal errors *1 on warnings in [--frail][cli-frail] mode, 0on warnings otherwise *0 on success

`Debugging`

CLIs can be debugged by setting the [DEBUG][debug] environment variable to, such as DEBUG="" cli example.txt.

`Types`

This package is fully typed with [TypeScript][]. It export the additional type [Options][api-options].

`Compatibility`

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,unified-engine@^11, compatible with Node.js 16.

`Security`

unified-argsloads and evaluates configuration files, plugins, and presets from the file system (often fromnode_modules/). That means code that is on your file system runs. Make sure you trust the workspace where you rununified-argsand be careful with packages from npm and changes made by contributors.

`Contribute`

See [contributing.md][contributing] in [unifiedjs/.github][health] for ways to get started. See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/unifiedjs/unified-args/workflows/main/badge.svg

[build]: https://github.com/unifiedjs/unified-args/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/unifiedjs/unified-args.svg

[coverage]: https://codecov.io/github/unifiedjs/unified-args

[downloads-badge]: https://img.shields.io/npm/dm/unified-args.svg

[downloads]: https://www.npmjs.com/package/unified-args

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/unifiedjs/unified/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[typescript]: https://www.typescriptlang.org

[health]: https://github.com/unifiedjs/.github

[contributing]: https://github.com/unifiedjs/.github/blob/main/contributing.md

[support]: https://github.com/unifiedjs/.github/blob/main/support.md

[coc]: https://github.com/unifiedjs/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[unified]: https://github.com/unifiedjs/unified

[unified-processor]: https://github.com/unifiedjs/unified#processor

[overview]: https://github.com/unifiedjs/unified#overview

[remark]: https://github.com/remarkjs/remark

[remark-cli]: https://github.com/remarkjs/remark/tree/main/packages/remark-cli

[reporter]: https://github.com/vfile/vfile#reporters

[vfile-reporter]: https://github.com/vfile/vfile-reporter

[unist-util-inspect]: https://github.com/syntax-tree/unist-util-inspect

[debug]: https://github.com/debug-js/debug

[glob]: https://github.com/isaacs/node-glob#glob-primer

[supports-color]: https://github.com/chalk/supports-color

[json5]: https://github.com/json5/json5

[unified-engine]: https://github.com/unifiedjs/unified-engine

[config-file]: https://github.com/unifiedjs/unified-engine#config-files

[ignore-file]: https://github.com/unifiedjs/unified-engine#ignore-files

[example]: #use

[api-args]: #argsoptions

[api-options]: #options

[cli-color]: #--color

[cli-config]: #--config

[cli-frail]: #--frail

[cli-ignore]: #--ignore

[cli-output]: #--output-path

[cli-quiet]: #--quiet

[cli-report]: #--report-reporter

[cli-setting]: #--setting-settings

[cli-silent]: #--silent

[cli-watch]: #--watch

unified-args

[unified][] engine to create a command line interface from a unified
processor.

What is this?

This package wraps [unified-engine][unified-engine] so that it can be used
to create a command line interface.
It’s what you use underneath when you use [remark-cli][remark-cli].

When should I use this?

You can use this to let users process multiple files from the command line,
letting them configure from the file system.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh npm install unified-args`

`Use`

Say our module example.js looks as follows:

`js import {remark} from 'remark' import {args} from 'unified-args'

…now running node example.js --help yields:

`txt Usage: remark [options] [path | glob ...]

Command line interface to inspect and change markdown files with remark

Options:

--[no-]color specify color in report (on by default) --[no-]config search for configuration files (on by default) -e --ext specify extensions …`

`API`

This package exports the identifier [args][api-args]. There is no default export.

`$3`

Start the CLI.

> 👉 Note: this takes over the entire process. > It parsesprocess.argv, exits when its done, etc.

###### Parameters

* options ([Options][api-options], required) — configuration

###### Returns

Nothing (undefined).

`$3`

Configuration (TypeScript type).

###### Fields

`CLI`

CLIs created with unified-args, such as the [example][] above, have an interface similar to the below:

`txt Usage: remark [options] [path | glob ...]

Command line interface to inspect and change markdown files with remark

Options:

Examples:

# Process input.md$ remark input.md -o output.md

# Pipe $ remark < input.md > output.md

# Rewrite all applicable files $ remark . -o`

`$3`

All non-options passed to the cli are seen as input and can be:

You can force things to be seen as input by using --:

`sh cli -- globs/* and/files`

* default: none * engine:options.files

`$3`

`sh cli --no-color input.txt`

Whether to output ANSI color codes in the report.

* default: whether the terminal [supports color][supports-color] * engine:options.color

> 👉 Note: This option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --no-config input.txt`

Whether to load [configuration files][config-file].

* default: on * engine:options.detectConfig

`$3`

`sh cli --ext html . cli --ext htm --ext html . cli --ext htm,html .`

Specify one or more extensions to include when searching for files.

* default: [configured][api-options] extensions* alias:-e* engine:options.extensions

`$3`

`sh cli --file-path input.txt < input.txt > doc/output.txt`

File path to process the given file on stdin(4) as, if any.

* default: none * engine:options.filePath

`$3`

`sh cli --frail input.txt`

Exit with a status code of 1if warnings or errors occur. The default behavior is to exit with1 on errors.

* default: off * alias:-f* engine:options.frail

`$3`

`sh cli --help`

Output short usage information.

* default: off * alias:-h

`$3`

`sh cli --no-ignore .`

Whether to load [ignore files][ignore-file].

Searches for files named [$ignoreName][api-options].

* default: on * engine:options.detectIgnore

`$3`

`sh cli --ignore-path .gitignore .`

File path to an [ignore file][ignore-file] to load, regardless of [--ignore][cli-ignore].

* default: none * alias:-i* engine:options.ignorePath

`$3`

`sh cli --ignore-path node_modules/my-config/my-ignore --ignore-path-resolve-from cwd .`

Resolve patterns in the ignore file from its directory (dir, default) or the current working directory (cwd).

* default: 'dir'* engine:options.ignorePathResolveFrom

`$3`

`sh cli --ignore-pattern "docs/*.md" .`

Additional patterns to use to ignore files.

* default: none * engine:options.ignorePatterns

`$3`

`sh cli --inspect < input.txt`

Output the transformed syntax tree, formatted with [unist-util-inspect][unist-util-inspect]. This does not run the [compilation phase][overview].

* default: off * engine:options.inspect

`$3`

`sh cli --output -- . cli --output doc . cli --output doc/output.text input.txt`

Whether to write successfully processed files, and where to. Can be set from [configuration files][config-file].

> 👉 Note: intermediate folders are not created.

* default: off * alias:-o* engine:options.output

`$3`

`sh cli --quiet input.txt`

Ignore files without any messages in the report. The default behavior is to show a success message.

* default: off * alias:-q* engine:options.quiet

> 👉 Note: this option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --rc-path config.json .`

File path to a [configuration file][config-file] to load, regardless of [--config][cli-config].

* default: none * alias:-r* engine:options.rcPath

`$3`

`sh cli --report ./reporter.js input.txt cli --report vfile-reporter-json input.txt cli --report json input.txt cli --report json=pretty:2 input.txt cli --report 'json=pretty:"\t"' input.txt

`Only last one is used:`


cli --report pretty --report json input.txt


[Reporter][] to load by its name or path, optionally with options, and use to
report metadata about every processed file.

To pass options, follow the name by an equals sign (=) and settings, which have the same in syntax as [--setting ][cli-setting].

The prefix vfile-reporter-can be omitted. Prefixed reporters are preferred over modules without prefix.

If multiple reporters are given, the last one is used.

* default: none, which uses [vfile-reporter][vfile-reporter] * engine:options.reporter and options.reporterOptions

`$3`

Configuration for the parser and compiler of the processor. Can be set from [configuration files][config-file].

The given settings are [JSON5][], with one exception: surrounding braces must not be used. Instead, use JSON syntax without braces, such as"foo": 1, "bar": "baz".

* default: none * alias:-s* engine:options.settings

`$3`

`sh cli --silent input.txt`

Show only fatal errors in the report. Turns [--quiet][cli-quiet] on.

* default: off * alias:-S* engine:options.silent

> 👉 Note: this option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --silently-ignore */.md`

Skip given files which are ignored by ignore files, instead of warning about them.

* default: off * engine:options.silentlyIgnore

`$3`

`sh cli --no-stdout input.txt`

Whether to write a processed file to stdout(4).

* default: off if [--output][cli-output] or [--watch][cli-watch] are given, or if multiple files could be processed * engine:options.out

`$3`

`sh cli --tree < input.json > output.json`

Treat input as a syntax tree in JSON and output the transformed syntax tree. This runs neither the [parsing nor the compilation phase][overview].

* default: off * alias:-t* engine:options.tree

`$3`

`sh cli --tree-in < input.json > input.txt`

Treat input as a syntax tree in JSON. This does not run the [parsing phase][overview].

* default: same as --tree* engine:options.treeIn

`$3`

`sh cli --tree-out < input.txt > output.json`

Output the transformed syntax tree. This does not run the [compilation phase][overview].

* default: same as --tree* engine:options.treeOut

`$3`

`sh cli --use remark-man input.txt cli --use man input.txt cli --use 'toc=max-depth:3' input.txt cli --use ./plugin.js input.txt`

Plugin to load by its name or path, optionally with options, and use on every processed file. Can be set from [configuration files][config-file].

To pass options, follow the plugin by an equals sign (=) and settings, which have the same in syntax as [--setting ][cli-setting].

Plugins prefixed with the [configured][api-options] pluginPrefixare preferred over modules without prefix.

* default: none * alias:-u* engine:options.plugins

`$3`

`sh cli --verbose input.txt`

Print more info for messages.

* default: off * engine:options.verbose

> 👉 Note: this option may not work depending on the reporter given in > [--report][cli-report].

`$3`

`sh cli --version`

Output version number.

* default: off * alias:-v

`$3`

`sh cli -qwo .`

Yields:

`txt Watching... (press CTRL+C to exit) Note: Ignoring--outputuntil exit.`

Process as normal, then watch found files and reprocess when they change. The watch is stopped whenSIGINTis received (usually done by pressingCTRL-C).

* default: off * alias:-w

`Diagnostics`

CLIs created with unified-args exit with:

* 1on fatal errors *1 on warnings in [--frail][cli-frail] mode, 0on warnings otherwise *0 on success

`Debugging`

CLIs can be debugged by setting the [DEBUG][debug] environment variable to, such as DEBUG="" cli example.txt.

`Types`

This package is fully typed with [TypeScript][]. It export the additional type [Options][api-options].

`Compatibility`

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,unified-engine@^11, compatible with Node.js 16.

`Security`

`Contribute`

See [contributing.md][contributing] in [unifiedjs/.github][health] for ways to get started. See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[build-badge]: https://github.com/unifiedjs/unified-args/workflows/main/badge.svg

[build]: https://github.com/unifiedjs/unified-args/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/unifiedjs/unified-args.svg

[coverage]: https://codecov.io/github/unifiedjs/unified-args

[downloads-badge]: https://img.shields.io/npm/dm/unified-args.svg

[downloads]: https://www.npmjs.com/package/unified-args

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/unifiedjs/unified/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[typescript]: https://www.typescriptlang.org

[health]: https://github.com/unifiedjs/.github

[contributing]: https://github.com/unifiedjs/.github/blob/main/contributing.md

[support]: https://github.com/unifiedjs/.github/blob/main/support.md

[coc]: https://github.com/unifiedjs/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[unified]: https://github.com/unifiedjs/unified

[unified-processor]: https://github.com/unifiedjs/unified#processor

[overview]: https://github.com/unifiedjs/unified#overview

[remark]: https://github.com/remarkjs/remark

[remark-cli]: https://github.com/remarkjs/remark/tree/main/packages/remark-cli

[reporter]: https://github.com/vfile/vfile#reporters

[vfile-reporter]: https://github.com/vfile/vfile-reporter

[unist-util-inspect]: https://github.com/syntax-tree/unist-util-inspect

[debug]: https://github.com/debug-js/debug

[glob]: https://github.com/isaacs/node-glob#glob-primer

[supports-color]: https://github.com/chalk/supports-color

[json5]: https://github.com/json5/json5

[unified-engine]: https://github.com/unifiedjs/unified-engine

[config-file]: https://github.com/unifiedjs/unified-engine#config-files

[ignore-file]: https://github.com/unifiedjs/unified-engine#ignore-files

[example]: #use

[api-args]: #argsoptions

[api-options]: #options

[cli-color]: #--color

[cli-config]: #--config

[cli-frail]: #--frail

[cli-ignore]: #--ignore

[cli-output]: #--output-path

[cli-quiet]: #--quiet

[cli-report]: #--report-reporter

[cli-setting]: #--setting-settings

[cli-silent]: #--silent

[cli-watch]: #--watch

unified-args

unified-args

Contents

What is this?

When should I use this?

Install

Use

API

$3

$3

CLI

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Only last one is used:

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Diagnostics

Debugging

Types

Compatibility

Security

Contribute

License

unified-args

unified-args

Contents

What is this?

When should I use this?

Install

Use

API

$3

$3

CLI

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Only last one is used:

$3

$3

$3

$3

$3

$3

`Use`

`API`

`$3`

`$3`

`CLI`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Only last one is used:`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Diagnostics`

`Debugging`

`Types`

`Compatibility`

`Security`

`Contribute`

`Use`

`API`

`$3`

`$3`

`CLI`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Only last one is used:`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Diagnostics`

`Debugging`

`Types`

`Compatibility`

`Security`

`Contribute`