Skip to main content

Panache

CI Crates.io Open VSX VS Code PyPi npm DOI

Panache is a language server, formatter, and linter for Quarto and other Markdown flavors, built in Rust with a lossless CST parser and support for external formatters and linters on code blocks.

Installation

Panache is available from several sources:

  • crates.io: cargo install --locked panache
  • Homebrew: brew install panache
  • npm: npm install -g @panache-cli/panache (or npx @panache-cli/panache)
  • PyPI: uv tool install panache-cli/pipx install panache-cli
  • mise/Aqua: see the installation guide
  • NixOS: the panache package on Nixpkgs
  • Arch Linux: from the AUR: panache-bin (prebuilt), panache (built from source)
  • Prebuilt binaries: tarballs, .deb, and .rpm from the releases page
  • VS Code/Open VSX: the Panache extension, from the VS Code Marketplace or Open VSX (also works in Positron), which installs the CLI and starts the language server automatically

Install Script

The installer scripts pick the right release artifact for your platform and install to a user-local directory by default. They download the matching Panache CLI release asset. If you prefer, download and inspect the script before running it.

For macOS and Linux:

curl --proto '=https' --tlsv1.2 -sSf https://panache.bz/install | sh

For Windows PowerShell:

powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://panache.bz/install.ps1 | iex"

Set PANACHE_INSTALL_DIR to change the destination and PANACHE_TAG to pin a version.

See getting started for per-platform detail and the development version.

Usage

Panache provides a single CLI interface for formatting, linting, and running the LSP server.

Formatting

To format a file in place, simply run:

panache format document.qmd

You can also format from stdin by piping content into panache format:

cat <file> | panache format

panache format supports glob patterns and recursive directory formatting:

panache format **/*.{qmd,md}

You can use Panache as a linter via the --check flag to check if files are already formatted without making changes:

panache format --check document.qmd

External Code Formatters

Panache supports external formatters for code blocks. For example, you can configure it to run arity on R code blocks and ruff on Python code blocks:

[formatters]
r = "arity"
python = "ruff"
javascript = "prettier"
typescript = "prettier" # Reuse same formatter

You can setup custom formatters or modify built-in presets with additional arguments:

[formatters]
python = ["isort", "black"]
javascript = "myformatter"

[formatters.isort]
args = ["--profile=black"]

[formatters.myformatter]
cmd = "foobar"
args = ["--print-width=100"]
stdin = true

Linting

Panache also features a linter that can report formatting issues and optionally auto-fix them. To run the linter, use:

panache lint document.qmd

As with panache format, you can use glob patterns and recursive formatting:

panache lint **/*.{qmd,md}

External Linters

As with formatting, Panache supports external linters for code blocks. These are configured in the [linters] section of the configuration, but due to the complexity of linting, including dealing with auto-fixing, external linters cannot be customized and only support presets:

# Enable R linting
[linters]
r = "jarl" # R linter with JSON output

Language Server

Panache implements the language server protocol (LSP) to provide editor features like formatting, diagnostics, code actions, and more. See Language Server for feature details and Editor Setup to connect Panache to your editor.

The list of LSP features supported by Panache includes, among others:

  • Document formatting (full document, incremental and range)
  • Diagnostics with quick fixes
  • Code actions for refactoring
    • Convert between loose/compact lists
    • Convert between inline/reference footnotes
  • Document symbols/outline
  • Folding ranges
  • Go to definition for references and footnotes
  • Quarto and Bookdown project awareness

The development R package also provides RStudio addins for formatting documents and selected blocks.

Configuration

Panache looks for a configuration in:

  1. An explicit --config <path>
  2. .panache.toml, panache.toml, or .config/panache.toml in the current directory or a parent directory
  3. The user configuration directory:
    • Linux: $XDG_CONFIG_HOME/panache/config.toml or ~/.config/panache/config.toml
    • macOS: ~/Library/Application Support/panache/config.toml
    • Windows: %APPDATA%\panache\config.toml

Example

# Markdown flavor and line width
flavor = "quarto"

# Formatting style
[format]
wrap = "reflow"
line-width = 80
line-ending = "auto"

# External code formatters (opt-in)
[formatters]
python = ["isort", "black"] # Sequential formatting
latex = "badness"           # Built-in preset
javascript = "prettier"     # Reusable definitions
typescript = "prettier"

# Customize formatters
[formatters.prettier]
prepend-args = ["--print-width=100"]

# External code linters
[linters]
julia = "fatou" # Enable Julia linting
python = "ruff"

See the configuration reference for a complete list of configuration options and their defaults.

Integrations

GitHub Actions

For CI, use the dedicated GitHub Action:

- uses: jolars/panache-action@v1

See the Integrations documentation for configuration options.

Pre-commit Hooks

Panache integrates with pre-commit to automatically format and lint your files before committing.

Installation:

First, install pre-commit if you haven't already:

pip install pre-commit
# or
brew install pre-commit

Then add Panache to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/jolars/panache-pre-commit
    rev: v3.14.0
    hooks:
      - id: panache-lint
      - id: panache-format

Note: The hooks live in jolars/panache-pre-commit, a thin shim repo.

Install the hooks:

pre-commit install

The lint hook reports findings; add args: [--fix] to apply safe fixes before formatting. The format hook rewrites files in place. See the integration guide for file patterns, check-only mode, and updates.

See examples/pre-commit-config.yaml for more configuration options.

Motivation

I wanted a formatter that understands Quarto and Pandoc syntax. I have tried to use Prettier as well as mdformat, but both fail to handle some of the particular syntax used in Quarto documents, such as fenced divs and some of the table syntax.

For a side-by-side overview of how Panache compares to Prettier, Pandoc, rumdl, mdformat, mado, markdownlint, markdownlint-cli2, and marksman, see the comparison page. For benchmarks against the same set of tools, see the performance page.

Design Goals and Scope

  • Full LSP implementation with formatting, diagnostics, code actions, and more
  • Standalone CLI for both formatting and linting
  • Support for Quarto, Pandoc, R Markdown, MyST, and other Markdown flavors
  • Lossless CST-based parsing
  • Idempotent formatting
  • Semi-opinionated defaults with configurable style options for common formatting decisions
  • Support for running external formatters and linters on code blocks, with built-in presets for popular languages and tools

Acknowledgements

The development of Panache has simplified considerably thanks to the extensive documentation, well-structured code, and testing infrastructure provided by Pandoc. We also owe significant debt to the rust-analyzer project, on which Panache is heavily inspired.

Citation

If you use Panache in your research, please cite the release you used. Select that release in the Zenodo archive and export its citation. To cite Panache generally, use the concept DOI 10.5281/zenodo.18608442.

Machine-readable metadata is available in CITATION.cff.

Metadata

Release files for panache-cli 3.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for panache-cli 3.19.0
File Size Uploaded Provenance Actions
panache_cli-3.19.0.tar.gz 1.6 MB With provenance Details for panache_cli-3.19.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for panache-cli 3.19.0
File Actions
panache_cli-3.19.0-py3-none-win_arm64.whl Python 3 none Windows ARM64 Details for panache_cli-3.19.0-py3-none-win_arm64.whl
panache_cli-3.19.0-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for panache_cli-3.19.0-py3-none-win_amd64.whl
panache_cli-3.19.0-py3-none-musllinux_1_2_x86_64.whl Python 3 none Linux musl 1.2+ x86-64 Details for panache_cli-3.19.0-py3-none-musllinux_1_2_x86_64.whl
panache_cli-3.19.0-py3-none-musllinux_1_2_aarch64.whl Python 3 none Linux musl 1.2+ ARM64 Details for panache_cli-3.19.0-py3-none-musllinux_1_2_aarch64.whl
panache_cli-3.19.0-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for panache_cli-3.19.0-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
panache_cli-3.19.0-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for panache_cli-3.19.0-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
panache_cli-3.19.0-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for panache_cli-3.19.0-py3-none-macosx_11_0_arm64.whl
panache_cli-3.19.0-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for panache_cli-3.19.0-py3-none-macosx_10_12_x86_64.whl

Total release size: 69.3 MB

Release files / panache_cli-3.19.0.tar.gz

Download URL panache_cli-3.19.0.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
122c9783de762ddcdd45f51ef57dd215c40dde424c692e43b426766d07869e58
BLAKE2b-256 checksum
How to use checksums
8b343a0d45580e7cd8dc99ddfefe08640b908b683cf7fcd2e89e2d11d587f6bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-win_arm64.whl

Download URL panache_cli-3.19.0-py3-none-win_arm64.whl
Size 8.3 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
5bfe6d50596366bfff50d1dd2e2b96130a9ec4c208b9dc3691e9958b4928976d
BLAKE2b-256 checksum
How to use checksums
43a0c9793c6469f4eb53f33290026a0c895c39b523d95e7f4c0034be67e76ceb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-win_amd64.whl

Download URL panache_cli-3.19.0-py3-none-win_amd64.whl
Size 9.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
b2c82474e48a07d254eb246e226c5429b5f3c400761705880f526beaddcd6a1b
BLAKE2b-256 checksum
How to use checksums
b33dc44d7cb55144383f764f0245226b24612f6aff29d5eaf88bcf8565cdfcd3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-musllinux_1_2_x86_64.whl

Download URL panache_cli-3.19.0-py3-none-musllinux_1_2_x86_64.whl
Size 8.9 MB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
0e86768d8299627aa87e589346080b449b5cf3f81e36e87ce9991cec3fb2e82b
BLAKE2b-256 checksum
How to use checksums
f814d8c0c85e2f1f8ca2773f56155d08e2401104dfcbcca80ce1074ae15bb142
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-musllinux_1_2_aarch64.whl

Download URL panache_cli-3.19.0-py3-none-musllinux_1_2_aarch64.whl
Size 8.1 MB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
9d37f96fa76995f779b6de448da37717819bee83ee488cad1c776f4c05bfc2bb
BLAKE2b-256 checksum
How to use checksums
e31c3d3a73583f75ca388eee9b278bdd1b66032a29fae3572084ea7b7e4fa563
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL panache_cli-3.19.0-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 8.7 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
512a2ef14832bc4412b56c141dd681d5ac4216fb9b10aaa7f0c4b209cfa3f412
BLAKE2b-256 checksum
How to use checksums
d5a6e5e797bdf454cfe2383871a374597cc6484e99180654f72a92c24a394651
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL panache_cli-3.19.0-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 8.2 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
9b2bc288f686422a1af14f24d2ea61f51d3919fb162daa60e54a6dcb29babd89
BLAKE2b-256 checksum
How to use checksums
aaac668d54cd39ac59f09a4c147a604aebc901e6899d8e434b78cc33c9cd04b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-macosx_11_0_arm64.whl

Download URL panache_cli-3.19.0-py3-none-macosx_11_0_arm64.whl
Size 8.0 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
d6b6bcf909fabf98a29709ebd7b32f4db045e1e26e9c7b3bde8365b3878b544b
BLAKE2b-256 checksum
How to use checksums
a46af4eafcebda2cf4439ea37246332666ff042b8140992cf7c537a9549d270a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / panache_cli-3.19.0-py3-none-macosx_10_12_x86_64.whl

Download URL panache_cli-3.19.0-py3-none-macosx_10_12_x86_64.whl
Size 8.5 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
ce25486aedcf6a8a16ab22bafaac01385ced062c129d7191c815816053a46bf4
BLAKE2b-256 checksum
How to use checksums
1920081bdab819f5b2e4e3cfa434d5fd4123d97d8e81f2dd2f6c2766f6462ec0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Security for panache-cli 3.19.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 9 files in this release have been uploaded with provenance metadata.

Select from 9 files

Attestation for panache_cli-3.19.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.19.0 This release

9 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page