Registry / devops / katana-markdown-linter

katana-markdown-linter

library0.19.4jsnpmunverified

Katana Markdown Linter is a fast Markdown linter and formatter distributed as a thin npm launcher that downloads prebuilt binaries from GitHub Releases. Version 0.19.4 supports macOS arm64/x64, Linux x64, and Windows x64. It provides CLI commands for linting, formatting, and localized help, plus MCP server entrypoints (kml-mcp for stdio, kml-mcp-remote for Streamable HTTP) for AI editor integration. Unlike markdownlint-cli, it offers built-in MCP support and binary distribution for fast execution. The `kml` binary is cached by version and platform, with SHA-256 checksum verification on download. Release cadence is irregular; check GitHub for latest.

devops

npm install katana-markdown-linter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · KATANA-MARKDOWN-LI

katana-markdown-linter

devopsjavascriptv0.19.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

kml

✓ import { execSync } from 'child_process'; execSync('kml check README.md', { stdio: 'inherit' })

✗ const kml = require('katana-markdown-linter')

The package does not export any JavaScript API – it is a binary wrapper. Use child_process or run via CLI.

kml-mcp

✓ import { execSync } from 'child_process'; execSync('kml-mcp --workspace-root /path', { stdio: 'inherit' })

MCP server entrypoint for local stdio clients; package provides no JS exports.

kml-mcp-remote

✓ import { execSync } from 'child_process'; execSync('kml-mcp-remote', { stdio: 'inherit', env: { ...process.env, KML_MCP_REMOTE_TOKEN: 'your-token' } })

Remote MCP server for Streamable HTTP; requires KML_MCP_REMOTE_TOKEN environment variable.

Shows how to invoke the kml CLI and MCP server from Node.js via child_process, as the package provides no JavaScript exports.

// Quickstart: lint a Markdown file import { execSync } from 'node:child_process'; try { // Lint README.md execSync('kml check README.md', { stdio: 'inherit' }); } catch (error) { console.error('Linting failed:', error.message); } // Run MCP server (stdio) execSync('kml-mcp --workspace-root /path/to/workspace', { stdio: 'inherit' });

Debug

Known issues

gotchaPackage does not export any JavaScript API – only binary launchers.

fix

Use child_process.spawnSync or execSync to run the `kml`, `kml-mcp`, or `kml-mcp-remote` commands.

affects: >=0.0.0

gotchaUnsupported platforms (e.g., Linux arm64, 32-bit) will throw an explicit platform error at runtime.

fix

Use only supported platforms: macOS arm64/x64, Linux x64, Windows x64.

affects: >=0.0.0

gotchaFirst run downloads binary from GitHub Releases; may fail behind proxies or with network restrictions.

fix

Set HTTP_PROXY/HTTPS_PROXY environment variables if behind a corporate proxy.

affects: >=0.0.0

gotchaMCP launchers do not write wrapper logs to stdout – debugging MCP issues is harder.

fix

Check stderr for logs or run with DEBUG=* environment variable if available.

affects: >=0.0.0

gotchaVersion aliases (kml version, kml --version, kml -v) may show different output or match git tags – inconsistent between releases.

fix

Use `kml --version` for the most standard output.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Unsupported platform: linux-arm64

The architecture/OS combination is not supported by the binary distribution.

fix

Switch to a supported platform (Linux x64, macOS x64/arm64, Windows x64) or use the source-based installation method.

Error: Failed to download binary from https://github.com/HiroyukiFuruno/katana-markdown-linter/releases/download/v0.19.4/kml-v0.19.4-linux-x64

Network issue or binary not available for the current version.

fix

Check internet connectivity, proxy settings, or use a different version. Verify the GitHub release exists.

Error: SHA-256 checksum mismatch

Downloaded binary corrupted or tampered; checksum file mismatch.

fix

Retry installation (npx with --yes flag) or manually download from GitHub releases and verify checksum.

Upgrade

Version history

0.19.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

5 hits · last 30 days

node

Resources

githubhttps://github.com/HiroyukiFuruno/katana-markdown-linter ↗

packagekatana-markdown-linter ↗

homepagehttps://github.com/HiroyukiFuruno/katana-markdown-linter#readme ↗