CLI Reference

Install

No global install required — run directly with npx:

$ npx mding-cli

Or install globally:

$ npm install -g mding-cli $ mding-cli

Usage

$ mding-cli [path] [options]
ArgumentDescriptionDefault
pathDirectory to watch. (current dir)

Options

FlagDescription
--version, -vShow version number
--help, -hShow help

Authentication

On first run, mding-cli opens your browser to authenticate with markdown.ing. Your session token is saved locally at ~/.config/mding-cli/config.json.

To re-authenticate or switch accounts:

$ mding-cli login

How it works

  1. The CLI scans your directory for .md files
  2. It connects to markdown.ing over WebSocket (Phoenix channels)
  3. Your files appear in the web editor's sidebar
  4. Changes sync bidirectionally in real-time
  5. When you disconnect (Ctrl+C), your files are untouched

SSH usage

mding-cli works on any machine with Node.js, including remote servers you access via SSH. No port forwarding, no X11, no special configuration:

remote server
$ ssh prod-server admin@prod $ npx mding-cli ~/docs ✓ Connected to markdown.ing # open browser on your local machine — editing remote files