panache(1)

📦
version 3.16.0 · 2 versions
, in nixpkgs unstable

🫶 NAME 🫶

panache — okay so this is Panache: a language server, formatter, and linter for Quarto and other Markdown flavors. It's from the General Commands Manual, and it's literally ur new bestie for docs. 💅

✨ SYNOPSIS ✨

panache [--config] [--stdin-filename] [--flavor] [--color] [--no-color]
[-q|--quiet] [-v|--verbose] [--isolated] [--no-cache] [--cache-dir]
[-j|--jobs] [-h|--help] [-V|--version] <subcommands>

💖 DESCRIPTION 💖

Panache is a language server, formatter, and linter for Quarto and other Markdown flavors, including Pandoc, R Markdown, and MyST. It's written in Rust and understands syntax that generic Markdown tools often miss — we're talking fenced divs, tables, and math. No cap, it's giving main character energy for your markdown files. ✨🔥

🎀 OPTIONS 🎀

  • -h, --help — Print help (see a summary with -h). Like a lil vibe check for the command itself. 🫶
  • -V, --version — Print version. Slay, now u know what u got. 💖

🌸 GLOBAL OPTIONS 🌸

  • --config <CONFIG> — Path to a custom configuration file. If you don't specify one, Panache will search for .panache.toml, panache.toml, or .config/panache.toml in the current directory and its parents, then the file named by PANACHE_CONFIG, then config.toml under the platform's user configuration directory. It's giving "we'll find it, don't worry." 🧚
  • --stdin-filename <PATH> — Synthetic filename to associate with stdin input. This is useful for editor integrations that pipe content via stdin but still need Panache to infer flavor/extensions from file extension (for example: --stdin-filename doc.qmd). Literally so handy for editor girlies. 🦋
  • --flavor <FLAVOR> — Override the markdown flavor for this invocation. Takes the highest precedence: it overrides any value in panache.toml, matching patterns in the [flavors] table, and the flavor inferred from the file extension. Extension overrides from [extensions] in panache.toml still merge on top of the flavor's defaults. Useful when the file extension is unknown (e.g. a .txt file containing markdown) or when you want to force a one-off interpretation. Main character override energy, periodt. 👑
    • Possible values:
      • pandoc: Pandoc's Markdown (the extended dialect described in man pandoc)
      • quarto: Quarto's Markdown (Pandoc-based, with Quarto-specific extensions and shortcodes)
      • rmarkdown: R Markdown (Pandoc-based, with knitr/Rmd code chunks)
      • gfm: GitHub Flavored Markdown
      • commonmark: CommonMark (the strict, standardized base dialect)
      • multimarkdown: MultiMarkdown (Fletcher Penney's extended Markdown dialect)
      • mdsvex: mdsvex (Svelte-flavored Markdown: CommonMark + Svelte template syntax)
      • myst: MyST (CommonMark + Sphinx/MyST directives, roles, and targets)
  • --color <WHEN> — Control when colored output is used. Default is auto. 🌈
    • Possible values:
      • auto
      • always
      • never
  • --no-color — Disable colored output (equivalent to --color never). For when u want the plain vibe. 🙈
  • -q, --quiet — Suppress informational status messages on stdout (e.g. "Formatted X", "N file left unchanged", "All files are correctly formatted", "No issues found") as well as per-violation lint diagnostics. Under format --check it also drops the per-file diff, leaving the list of files that would be reformatted and a summary. Errors are still written to stderr, and primary command output (such as formatted content when reading from stdin, JSON/Markdown reports, or the parsed CST) continues to print so that pipelines keep working. The process exit code still reflects whether issues were found in --check mode. Quiet mode ate and left no crumbs, but errors still speak up. 💀
  • -v, --verbose — Print additional informational output where supported. Currently used by panache clean to include a summary of cache size and file count alongside the "Removed cache directory" message. Conflicts with --quiet. Not me wanting all the tea. 😭
  • --isolated — Ignore all discovered configuration files. Solo era, no configs invited. 🎀
  • --no-cache — Disable all lint/format cache reads and writes for this run. Can also be enabled with PANACHE_NO_CACHE. Fresh start energy. ✨
  • --cache-dir <CACHE_DIR> — Path to the cache directory for this invocation. Overrides config cache-dir. Can also be set with PANACHE_CACHE_DIR. Tell it where to put its stuff. 💅
  • -j, --jobs <N> — Number of worker threads to use when formatting or linting multiple files. Default is 0. 0 (the default) selects an automatic level based on available CPU cores. 1 forces serial processing. Single-file invocations always run on one thread; the inner external-formatter pool (see external-max-parallel) is only used when this value is 1 or when only one file is being processed. Can also be set with PANACHE_JOBS. Multitasking queen behavior. 👑

🦋 SUBCOMMANDS 🦋

  • panache-format(1) — Format a Quarto or other Markdown document. Glow-up ur files. 💖
  • panache-parse(1) — Parse and display the CST tree for debugging. For when u need to see the whole situation. 🔍
  • panache-lsp(1) — Start the Language Server Protocol server. Editor bestie mode activated. 🫶
  • panache-lint(1) — Lint a Quarto or other Markdown document. Constructive criticism, but make it markdown. 🎀
  • panache-clean(1) — Delete cache data. Clear the clutter, fresh vibes only. 🧹✨
  • panache-debug(1) — Debug utilities for parser/formatter diagnostics. Detective era. 🕵️
  • panache-help(1) — Print this message or the help of the given subcommand(s). The helper helper. 😭

⭐ EXTRA ⭐

For help with a specific command, see: panache help <command>.

Homepage and downloads (including .deb and .rpm packages): <https://panache.bz> — literally go look, it's iconic. 🔥

👑 VERSION 👑

v3.16.0 — yes bestie, we're on 3.16.0 and it's giving upgraded. 💜

💜 AUTHORS 💜

Johan Larsson <johan@jolars.co> — thank u for this masterpiece, king. 👑🫶

🌈 SEE ALSO 🌈

panache-format(1), panache-parse(1), panache-lsp(1), panache-lint(1), panache-clean(1), panache-debug(1) — the whole squad. Go read them too, iykyk. 💅✨

And that's the page, bestie! This was panache 3.16.0 from the General Commands Manual — panache(1), slay, bye! 🎀🦋💖
📦 where this page comes from