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.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/elena-cabrera/markdown-os/llms.txt
Use this file to discover all available pages before exploring further.
Installation
Install via pip:Command Structure
The CLI follows this pattern: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
Runningmarkdown-os with no arguments opens the current directory:
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 inpyproject.toml as:
markdown-os executable that invokes the run() function from markdown_os.cli.
Quick Start Examples
Next Steps
open command
Launch the editor for files or directories
example command
Generate showcase markdown files