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 the language server documentation for guides on how to connect Panache to your editor and configure LSP features.

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.18.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.18.0
File Size Uploaded Provenance Actions
panache_cli-3.18.0.tar.gz 1.6 MB With provenance Details for panache_cli-3.18.0.tar.gz

Built distributions (wheels)

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

Total release size: 68.1 MB

Release files / panache_cli-3.18.0.tar.gz

Download URL panache_cli-3.18.0.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
3104df53bccf74eb5abbc682e9ada8f598398435cfc110c7c77d1f8f5d56aaad
BLAKE2b-256 checksum
How to use checksums
e61829adfe6ff2bed78fdbc97fdb72ccfcdb548be76e0dd54f96703e04176aa1
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-win_arm64.whl
Size 8.1 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
f3323d075b29ca5d571f4d400ac6a955cf7fa6b15b923a9549d39de32382d95f
BLAKE2b-256 checksum
How to use checksums
20d305b5f643d5fad3111c5d418b99c0a2ba47104d7f677d50bc078c4cd916e9
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-win_amd64.whl
Size 8.8 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
d922bcd7d57c6c9441bc7f2761e6dcc62e400d6cd44ea12f32b5091c923aec43
BLAKE2b-256 checksum
How to use checksums
148c2ce850bd4fbcbb20cc554af8b4b73aa85d3a3e3b064d961a642607d6a45e
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-musllinux_1_2_x86_64.whl
Size 8.8 MB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
f911f9cf9e539f9f1239324b72121d4e5a5116506297363714509d947e3e5353
BLAKE2b-256 checksum
How to use checksums
373f9b0a4ac1b67ca0f6b1283f9528a65484bd49f7038ddce64c71b1af9f9a3f
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-musllinux_1_2_aarch64.whl
Size 8.0 MB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
f86652d7f2a6e8379248c14b76654c16bdd669606eaa8325ce7c4cf59197d9d7
BLAKE2b-256 checksum
How to use checksums
6fbc0e74ab6687fbd8815fbcb6ad0c22d309a9610b6b7d22f57a0d5f34b14c24
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 8.6 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
ba7e7a5125783ce929859c61f1ae6a83b5d902cd6b2c2f73bf28ef81be608a59
BLAKE2b-256 checksum
How to use checksums
14b2d56e6a32408ffa37d1cbe4041b59f10ab7de1bdb0f04e45f046bbff8f36f
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 8.1 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
c0209a9de790f68c5b17fed7fc66a682abda870e9ccca37b696c2b557cf75872
BLAKE2b-256 checksum
How to use checksums
6be99b9744390dcd2c36d7b42902c07b88cbdec1a1f8fc5a520f18f10ae822e8
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-macosx_11_0_arm64.whl
Size 7.9 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
9505ab2bbb6fcf8a4c268d6a259660461498ff2eec5e6e3c2c5a4e36148bfbd9
BLAKE2b-256 checksum
How to use checksums
aff06af10a2280e79f1afe5becbc36565fb98da98a5fed7cbdf341fe5deff4e1
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 11, 2026.

Transparency log

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

Download URL panache_cli-3.18.0-py3-none-macosx_10_12_x86_64.whl
Size 8.3 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
5d2fbc3a1ac0b541492d859530ae4778acc4a5b7d09114ab006e9ba710ea28d6
BLAKE2b-256 checksum
How to use checksums
ef24132514379545899fa9386afb714c0623eca40eab216e7e1f5be2632a4066
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 11, 2026.

Transparency log

Security for panache-cli 3.18.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.18.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 11, 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.18.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