Skip to main content

Panache

Build and Test Crates.io Open VSX VS Code PyPI version npm version codecov

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

Installation

Homebrew

Panache is available from Homebrew on macOS and Linux:

brew install panache

From crates.io

If you have Rust installed, the easiest way is likely to install from crates.io:

cargo install panache

Pre-built Binaries

Alternatively, you can install pre-built binary packages from the releases page for Linux, macOS, and Windows. For Linux, packages are available for generic distributions (tarballs) as well as Debian/Ubuntu (.deb) and Fedora/RHEL/openSUSE (.rpm).

If you prefer a one-liner installer that picks the right release artifact for your platform, you can use the installer scripts below. These scripts are fetched directly from this repository and then download the latest matching Panache CLI release asset for your platform, installing to a user-local directory by default. If you prefer, download and inspect the script before running it.

For macOS and Linux:

curl --proto '=https' --tlsv1.2 -LsSf \
    https://raw.githubusercontent.com/jolars/panache/refs/heads/main/scripts/panache-installer.sh | sh

For Windows PowerShell:

powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/jolars/panache/refs/heads/main/scripts/panache-installer.ps1 | iex"

Arch Linux

There are also two recipies available for Arch Linux in the AUR: panache and panache-bin. The first builds from source for your system, the second uses precompiled binaries attatched to GH releases. Install either using yay or your favorite AUR helper:

yay -S panache
yay -S panache-bin

NixOS

Panache is available in NixOS via the panache package in nixpkgs. To add it to your system configuration, include it in the environment.systemPackages:

{ pkgs, ... }:

{
  environment.systemPackages = [
    pkgs.panache
  ];
}

From PyPI (via uv or pipx)

Install with uv or pipx:

# One-shot run, no install:
uvx --from panache-cli panache format path/to/file.qmd

# Persistent install:
uv tool install panache-cli
# or
pipx install panache-cli

From NPM (via npmx)

Install with npx or npmx:

# One-shot run, no install:
npx @panache-cli/panache format path/to/file.qmd

# Persistent install:
npm install -g @panache-cli/panache

VS Code Extension

If you are running VS Code or an editor that supports VS Code extensions (like Positron), you can install the Panache extension from the VS Code Marketplace or the Open VSX extension, which will automatically also install the panache CLI and start the language server when editing supported files.

Development Version

To install the latest development version, you can run

cargo install --git https://github.com/jolars/panache.git panache

This presumes you have a working and up-to-date Rust toolchain (stable, 2024 edition) installed. You also need to have cargo in your PATH if you want to use the panache command directly after installation.

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 air on R code blocks and ruff on Python code blocks:

[formatters]
r = "air"
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 = "foobar"

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

[formatters.myformatters]
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 and at the moment only support R via the jarl linter:

# 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
  • Quaro and Bookdown project awareness

Configuration

Panache looks for a configuration in:

  1. .panache.toml or panache.toml in current directory or parent directories
  2. $XDG_CONFIG_HOME/panache/config.toml (usually ~/.config/panache/config.toml)

Example

# Markdown flavor and line width
flavor = "quarto"
line-width = 80
line-ending = "auto"

# Formatting style
[format]
wrap = "reflow"

# External code formatters (opt-in)
[formatters]
python = ["isort", "black"] # Sequential formatting
r = "air"                   # Built-in preset
javascript = "prettier"     # Reusable definitions
typescript = "prettier"
yaml = "yamlfmt"            # Formats both code blocks AND frontmatter

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

# External code linters
[linters]
r = "jarl"      # Enable R linting
python = "ruff"

See examples/panache.toml for a complete configuration reference.

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: v2.43.1 # Use the latest version
    hooks:
      - id: panache-format # Format files
      - id: panache-lint # Lint and auto-fix issues

Note: The hooks live in jolars/panache-pre-commit, a thin shim repo. This avoids pre-commit autoupdate resolving to unrelated sub-package tags from this monorepo (e.g. panache-code-*). If you currently point at https://github.com/jolars/panache, update the repo: URL and run pre-commit autoupdate.

Install the hooks:

pre-commit install

Panache will now automatically run on your staged .qmd, .md, and .Rmd files before each commit.

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, and R Markdown syntax
  • 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 Panche is heavily inspired.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

panache_cli-3.0.2.tar.gz (1.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

panache_cli-3.0.2-py3-none-win_arm64.whl (6.8 MB view details)

Uploaded Python 3Windows ARM64

panache_cli-3.0.2-py3-none-win_amd64.whl (7.3 MB view details)

Uploaded Python 3Windows x86-64

panache_cli-3.0.2-py3-none-musllinux_1_2_x86_64.whl (7.7 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

panache_cli-3.0.2-py3-none-musllinux_1_2_aarch64.whl (6.9 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

panache_cli-3.0.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (7.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

panache_cli-3.0.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (7.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

panache_cli-3.0.2-py3-none-macosx_11_0_arm64.whl (6.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

panache_cli-3.0.2-py3-none-macosx_10_12_x86_64.whl (7.2 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file panache_cli-3.0.2.tar.gz.

File metadata

  • Download URL: panache_cli-3.0.2.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for panache_cli-3.0.2.tar.gz
Algorithm Hash digest
SHA256 3247baac72fac7607b1b6f33462e68dc41d05982239afb0f3a970bdfee57f585
MD5 4be980c4817aaf15f967261230866427
BLAKE2b-256 966b982cea44c8fe3b3a5e803e3a66eb3ad12fb7310b4690a8115949b4fa9b22

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2.tar.gz:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-win_arm64.whl.

File metadata

  • Download URL: panache_cli-3.0.2-py3-none-win_arm64.whl
  • Upload date:
  • Size: 6.8 MB
  • Tags: Python 3, Windows ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for panache_cli-3.0.2-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 edfb3ec823b0eaf6014c2f6af906e38e20f64d614f0b3e6d0e34fb016971fb97
MD5 4066902662c1ff53ec9e25c2cfe3b331
BLAKE2b-256 aed7e4fc3a1fb94b1403809bebccb88b64e89759d30a3cecb21da0131a8fec49

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-win_arm64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-win_amd64.whl.

File metadata

  • Download URL: panache_cli-3.0.2-py3-none-win_amd64.whl
  • Upload date:
  • Size: 7.3 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for panache_cli-3.0.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 bd6cd84049f58ad75d6024388f306bee55e70a25afde84a98ad519cbde840ade
MD5 efc6dca6077539a494c5bb4190d5184e
BLAKE2b-256 c8961a77333b504c46746280f83cd50527ab0c5214877ddcaaf02ebc150876ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-win_amd64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for panache_cli-3.0.2-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 a9e0341881638c1b5fd742d0ebd14334e5e906caf5bfce551beada4b41d26a8c
MD5 014f264fbdc8b651e83eb421b0f01587
BLAKE2b-256 e44ced5bf620d0969e7bda72186ad295142584c562d71987847353eabd8540bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-musllinux_1_2_x86_64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for panache_cli-3.0.2-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 719bb44cebffa25cc8d0c551ede1a36d76cdf2794d82f4fd6d16d7c52888721d
MD5 c5ce01c7ddc227dbc8957a8b41b5f0cd
BLAKE2b-256 2ff0f68d22e714366e351d634c024f004bd2e13a63f558e820bee70e31e61af5

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-musllinux_1_2_aarch64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for panache_cli-3.0.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 23179543f275d20aa1f21325a2f20f2810f68982dfc0fa371cb141437062151a
MD5 bc7c0657c6a02336efc85e41037cbb1e
BLAKE2b-256 4047442feb4e2e116ab685f736fd1a832e6be0f1800a15176c42d92de21d07e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for panache_cli-3.0.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 c4af95c5d0846c5ff46b2c947994982171110a54ac92fe7b6e46579c23503501
MD5 72b5ecb81a9cb7f96de5db6224a944bb
BLAKE2b-256 e09e1966e437dc837be138a6a61d050f401582edef0edfa3b7649eb1f0c3d1ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for panache_cli-3.0.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0b90be5db0eea4a1ec78c00322c58d1aebfebfc75ae22d85d9b8faec50a48232
MD5 b74e03dcfd0cdee661b6f9e3c5f7a5aa
BLAKE2b-256 335ba67413f902ce7bf2fb02c25169716083b05de2a6ce2db0890e54ddf95afc

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-macosx_11_0_arm64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file panache_cli-3.0.2-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for panache_cli-3.0.2-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ea96f25459b5bcf28f5ca3cc7a6a956275f0cb8da6b20829fc22491d71c1c416
MD5 a51d226f345a5c01a6f5c35b04eec5aa
BLAKE2b-256 62ee053982301d170724bfb7e68dee2b0e276c0f42211705bd3c1ccb2da7ecf3

See more details on using hashes here.

Provenance

The following attestation bundles were made for panache_cli-3.0.2-py3-none-macosx_10_12_x86_64.whl:

Publisher: publish-pypi.yml on jolars/panache

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page