toml-sort

What it is and what it does

toml-sort is a command-line utility and Python library for sorting and formatting TOML configuration files. It sorts tables and arrays of tables, optionally sorts keys within tables, and preserves comments and whitespace structure where possible. The tool can be used as a standalone CLI tool, integrated into build workflows for linting, or called as a Python library from other code.

The package handles four types of comments (header, footer, inline, and block) with fine-grained control over which to preserve or strip. It supports configuration via pyproject.toml with per-key overrides using glob-style wildcards, making it suitable for projects that want consistent TOML formatting across multiple files or as part of a CI/CD pipeline.

Use it for:

• Normalize and sort TOML files in a project as part of pre-commit hooks or CI linting.
• Automatically organize pyproject.toml or other config files to a consistent structure.
• Batch-format multiple TOML files with consistent rules via CLI or programmatic API.
• Check whether TOML files conform to a sorted format without modifying them.
• Configure per-section sort rules for complex TOML structures using overrides.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Command-line utility and Python library to sort and format TOML files while preserving comments and standardizing whitespace.

Yes. The package is actively maintained, has no known vulnerabilities, installs with minimal friction, and solves a real problem for projects using TOML configuration files. It is useful both as a CLI tool for ad-hoc formatting and as part of automated workflows. The permissive MIT license poses no barrier.

Install

toml-sort on PyPI

pip install toml-sort

uv add toml-sort

poetry add toml-sort

Installing toml-sort

Before you install

Low friction install with a single runtime dependency (tomlkit). Active maintenance with recent releases and no known vulnerabilities.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions.

Quickstart

pip install toml-sort

# Command line
toml-sort input.toml -o output.toml

# Or in-place
toml-sort --in-place input.toml

# Check without modifying
toml-sort --check input.toml

Requires Python 3.9 or later.

Verify before relying

• Whether the library API (as opposed to CLI) is documented and stable for programmatic use.
• Performance characteristics on large TOML files or deeply nested structures.

Package facts

Evidence: toml_sort-0.24.4-py3-none-any.whl

Keywords: toml, sort, cli, unix, utility

Tags

More Utilities packages