CLI Overview

Complete reference for the Markdown-OS command-line interface

Markdown-OS provides a simple CLI to launch a local web-based markdown editor. The CLI is built with Typer and supports both single-file and workspace directory modes.

Installation

Install via pip:

pip install markdown-os

Or using uv (recommended):

uv tool install markdown-os

Command Structure

The CLI follows this pattern:

markdown-os [COMMAND] [ARGUMENTS] [OPTIONS]

Available Commands

Command	Description
open	Start a local web editor for a markdown file or directory
example	Generate a showcase markdown file demonstrating features
(no command)	Defaults to opening the current working directory

When invoked without a subcommand, Markdown-OS automatically runs open on the current working directory.

Default Behavior

Running markdown-os with no arguments opens the current directory:

markdown-os
# Equivalent to: markdown-os open .

Source reference: cli.py:26-38

Global Options

All commands support standard CLI flags:

• --help - Show command help and usage information
• --version - Display installed package version

Entry Point

The CLI is registered in pyproject.toml as:

[project.scripts]
markdown-os = "markdown_os.cli:run"

This creates the markdown-os executable that invokes the run() function from markdown_os.cli.

Quick Start Examples

Single File

markdown-os open ./notes.md

markdown-os open ./my-notes

markdown-os

markdown-os example --open

Next Steps

open command

Launch the editor for files or directories

example command

Generate showcase markdown files