Skip to content

CLI Reference ​

bash
cosmoscope <command> [options]

Commands ​

render <file> ​

Render a file to HTML (outputs to stdout).

bash
cosmoscope render README.md
cosmoscope render code.go --style monokai
cosmoscope render app.py --dark --line-numbers
OptionDescription
--style <name>Theme: github, monokai, dracula (default: github)
--darkEnable dark mode
--line-numbersShow line numbers

convert <input...> ​

Batch convert files to HTML.

bash
cosmoscope convert src/ -o docs/ --recursive
OptionDescription
--output, -o <dir>Output directory (default: current)
--style <name>Theme to use
--recursive, -rProcess directories recursively

install ​

Install the Quick Look plugin to ~/Applications and CLI to ~/bin.

uninstall ​

Remove the installed plugin and CLI.

config ​

Show current configuration.

config --init ​

Create configuration file with defaults.

set <key> <value> ​

Set a configuration value. Keys: theme, custom_theme_path, enable_mathjax, enable_mermaid, font_size, line_numbers, light_dark_mode.

list ​

List all supported file types.

check <extension> ​

Check if a file extension is supported.

version ​

Show version information.

plugins ​

Show how to list registered Quick Look plugins.