remark-cli

library12.0.1jsnpmunverified

Command-line interface for processing markdown with the remark ecosystem. Current stable version is 12.0.1, released as part of the remark monorepo. The CLI allows inspecting, linting, and transforming markdown files using over 150 plugins. It is the primary way to integrate remark into CI/CD pipelines or npm scripts. Key differentiators: full access to the unified ecosystem, supports configuration files (JSON, YAML, JS), and can output formatted syntax trees. Requires Node.js 16+. ESM-only package, does not support CommonJS require().

testing devops

npm install remark-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · REMARK-CLI

remark-cli

testingjavascriptv12.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

remark-cli (binary)

✓ npx remark . --use remark-validate-links

✗ remark . --use remark-validate-links (without npx if not globally installed)

Best used via npx or as a devDependency script. Global install not recommended.

Programmatic API (run)

✓ import { remark } from 'remark'

✗ import remark from 'remark-cli'

remark-cli is a CLI wrapper; use the 'remark' package for programmatic use.

Config file (remark.config.js or .remarkrc.js)

✓ export default { plugins: ['remark-preset-lint-consistent'] }

✗ module.exports = { plugins: ['remark-preset-lint-consistent'] }

Since remark-cli 12.0.0, config files are ESM-only. Use export default.

Configure a lint script for markdown files in package.json using remark-cli with a preset.

{ "scripts": { "lint:md": "remark . --frail --use remark-preset-lint-consistent --quiet" }, "devDependencies": { "remark-cli": "^12.0.1", "remark-preset-lint-consistent": "^6.0.0" } }

remark --version

Debug

Known issues

breakingESM-only since version 12.0.0: require() is not supported. Use import or run via npx.

fix

Update Node.js to 16+ and use import syntax in config files.

affects: >=12.0.0

breakingNode.js 12 support dropped in v11.0.0 (and Node 14 dropped in v12.0.0). Current minimum is Node 16.

fix

Upgrade Node.js to version 16 or higher.

affects: >=11.0.0

gotchaIf using --output, the file is overwritten without confirmation. Always back up or use version control.

fix

Ensure you have a backup or use version control before running with --output.

affects: >=0.0.0

deprecatedThe --report option with custom reporters may not work with ESM-only plugins in newer versions.

fix

Use only built-in reporters ('json', 'vfile-reporter-json') or verify plugin ESM compatibility.

affects: >=11.0.0

gotchaPlugin resolution changed in v11.0.0 to match modern Node.js behavior. Relative paths like ./plugins/custom.mjs now require .mjs extension.

fix

Specify full extension for local plugins (e.g., --use ./plugin.mjs).

affects: >=11.0.0

breakingYAML 1.2 compliance introduced in v11.0.0 may cause parsing differences in config files that relied on YAML 1.1 quirks.

fix

Review .remarkrc or .remarkignore files for YAML 1.2 compatibility (e.g., boolean values, octal numbers).

affects: >=11.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/remark-cli/index.js from /path/to/project/script.js not supported.

Using require() to import remark-cli, which is ESM-only since v12.

fix

Use import { remark } from 'remark' for programmatic use, or run CLI via npx or npm scripts.

Cannot find module 'remark-preset-lint-markdown-style-guide'

The preset package is not installed or not in node_modules.

fix

Run npm install --save-dev remark-preset-lint-markdown-style-guide

SyntaxError: Unexpected token 'export'

Using CommonJS module.exports in a .remarkrc.js config file; ESM syntax required.

fix

Change module.exports to export default. Ensure package.json has type: module or use .mjs extension.

Error: Cannot find module './local-plugin'

Relative path to local plugin missing file extension; Node.js ESM resolution requires full extension.

fix

Use --use ./local-plugin.mjs (or .js/.cjs with type: module) instead of just ./local-plugin.

Upgrade

Version history

12.0.1latest on npm

Audit

Dependencies

unified-argsrequiredUnderlying argument parsing and file processing engine

remark-parseoptionalDefault parser for markdown (from unified ecosystem unless overridden)

remark-stringifyoptionalDefault stringifier for markdown output (from unified ecosystem unless overridden)

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/remarkjs/remark.git#main ↗

packagehttps://www.npmjs.com/package/remark-cli ↗

homepagehttps://remark.js.org ↗