beautysh
A Bash beautifier for the masses.
Decision gist · record as of 2026-08-14
Yes. Beautysh is actively maintained, has no known vulnerabilities, installs with minimal friction, and solves a real problem—Bash formatting is genuinely difficult due to the language's ambiguous syntax. Use it if you need to standardize shell script formatting across a team or codebase. The ~99% error-free rate on large system scripts suggests it handles real-world cases well, though edge cases may exist.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later.
- Low friction: pure Python wheel with only three lightweight runtime dependencies (colorama, editorconfig, tomli).
- Active maintenance with recent commits and no known vulnerabilities.
License · maintenance · safety
MIT (permissive) — MIT license is permissive; you can use, modify, and distribute beautysh freely in commercial and private projects with minimal restrictions.
last release 2026-03-12 (155 days) · last repo commit 2026-08-10 · 535 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 152,421 downloads/mo, #10,901 on PyPI
Alternatives
Verify before relying
pip install beautysh
beautysh file1.sh file2.sh
# Or as a module:
from beautysh import BashFormatter
formatter = BashFormatter(indent_size=4)
result, error = formatter.beautify_string("echo hello")- Whether the ~99% error-free rate mentioned in the description applies to current version 6.4.3 or is historical.
- Performance characteristics when processing very large Bash scripts or batch operations.
What it is and what it does
Beautysh is a command-line tool and Python library that reformats Bash shell scripts to a consistent style. It parses Bash syntax—including ambiguous constructs like keywords used as variable names—and applies indentation, function formatting, and variable style transformations. The tool runs as a standalone CLI that beautifies files in place or checks them without modification, and can also be imported as a Python module for programmatic use.
The package handles real-world Bash complexity: here-docs are preserved unchanged to respect original formatting intent, special comments like `@formatter:off` allow selective disabling of formatting, and configuration can come from command-line flags, pyproject.toml, or .editorconfig files. It depends on colorama for colored output, editorconfig for configuration file support, and tomli for TOML parsing.
Use it for
- Enforce consistent indentation and style across a large codebase of shell scripts in CI/CD pipelines.
- Reformat inherited or legacy Bash scripts to match a team's coding standards before maintenance work.
- Integrate into pre-commit hooks or editor plugins to auto-beautify shell scripts on save.
- Batch-process shell scripts in a repository or system directory to standardize formatting.
- Programmatically format Bash code within a Python application or build tool.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Beautysh is actively maintained, has no known vulnerabilities, installs with minimal friction, and solves a real problem—Bash formatting is genuinely difficult due to the language's ambiguous syntax. Use it if you need to standardize shell script formatting across a team or codebase. The ~99% error-free rate on large system scripts suggests it handles real-world cases well, though edge cases may exist.
Install
beautysh on PyPI
Before you install
Low friction: pure Python wheel with only three lightweight runtime dependencies (colorama, editorconfig, tomli). Active maintenance with recent commits and no known vulnerabilities.
Requires Python 3.9 or later.
License in practice
MIT license is permissive; you can use, modify, and distribute beautysh freely in commercial and private projects with minimal restrictions.
Quickstart
pip install beautysh
beautysh file1.sh file2.sh
# Or as a module:
from beautysh import BashFormatter
formatter = BashFormatter(indent_size=4)
result, error = formatter.beautify_string("echo hello")Verify before relying
- Whether the ~99% error-free rate mentioned in the description applies to current version 6.4.3 or is historical.
- Performance characteristics when processing very large Bash scripts or batch operations.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagescoloramaeditorconfigtomli |
| Maintenance | Actively maintained 155 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 152,421 / month, #10,901 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: Python :: 3 :: OnlyTopic :: Software Development :: Libraries :: Python ModulesTopic :: Software Development :: Quality AssuranceTopic :: Text Processing :: FiltersTopic :: Utilities |
Evidence: beautysh-6.4.3-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “bash script formatter”
- beautyshBeautysh automatically formats and beautifies Bash shell scripts with…
- bashatebashate is a style checker for bash scripts that applies pep8-like…
- shfmt-pyProvides a Python-installable wrapper that bundles the shfmt shell…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also config-formatter · yamlfix · cssbeautifier · jsbeautifier · reformat-gherkin · EditorConfig · djlint · sql-formatter · yapf · add-trailing-comma