Skip to content

CLI Flags ​

Usage ​

viewmd [flags] [port]

Arguments ​

ArgumentDescriptionDefault
portPort number to serve on8000

Flags ​

FlagShortDescriptionDefault
--show-all-aShow all files, not just markdownfalse
--auto-readmeAuto-render README.md in directoriesfalse
--watch-wWatch for file changes and auto-reload browserfalse
--versionPrint version and exit

Examples ​

bash
# Serve current directory on default port
viewmd

# Serve on port 3000
viewmd 3000

# Show all files
viewmd -a

# Show all files with auto-README on port 9000
viewmd -a --auto-readme 9000

# Watch for file changes and auto-reload the browser
viewmd --watch

# Combine watch with other flags
viewmd -a -w --auto-readme

Exit ​

Press Ctrl+C to stop the server. viewmd handles SIGINT and SIGTERM for graceful shutdown.

Released under the MIT License.