markdown-cli

1.6.0 verified Sat Apr 25 auth: no javascript maintenance

markdown-cli is a command-line tool that renders Markdown files to the terminal with syntax highlighting, tables, emoji, and ANSI colors. Version 1.6.0, last updated in 2016, with no recent releases. It wraps marked for parsing and uses cardinal for JS code highlighting, cli-table for tables, and node-emoji for emoji. No TypeScript support or active maintenance. Suitable for quick Markdown previews in the terminal but not recommended for new projects.

Common errors

error bash: markdown-cli: command not found ↓

cause Package not installed globally or not in PATH

fix

Run 'npm install -g markdown-cli' and ensure npm global bin is in PATH.

error Error: Cannot find module 'cardinal' ↓

cause Missing dependencies when running without full install

fix

Run 'npm install markdown-cli' in the project directory (or globally with --global).

error TypeError: IndentString is not a function ↓

cause Version mismatch with indent-string dependency (API changed in newer versions)

fix

Use an older version of indent-string (^2.0.0) or pin markdown-cli@1.6.0.

Warnings

deprecated Package has not been updated since 2016, with dependencies using deprecated APIs. ↓

fix Consider alternatives like mdcat or terminal-markdown

gotcha Requires global installation to use as CLI; local install may not add to PATH. ↓

fix Use npx markdown-cli for one-off use or install globally with -g

gotcha Dependency marked uses older API; output may differ from other Markdown renderers. ↓

fix Check rendered output for compatibility.

Install

npm install markdown-cli

yarn add markdown-cli

pnpm add markdown-cli

Imports

default
```
npm i -g markdown-cli
```
CLI tool used via command line, not imported programmatically.

Quickstart

Shows basic usage: rendering a Markdown file and piping content via stdin.

echo '# Hello World' > test.md
markdown-cli test.md
# Or pipe stdin
echo '## Subheading' | markdown-cli