PyShellForge

██████╗ ██╗   ██╗███████╗██╗  ██╗███████╗██╗     ██╗     ███████╗ ██████╗ ██████╗  ██████╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║  ██║██╔════╝██║     ██║     ██╔════╝██╔═══██╗██╔══██╗██╔════╝ ██╔════╝
██████╔╝ ╚████╔╝ ███████╗███████║█████╗  ██║     ██║     █████╗  ██║   ██║██████╔╝██║  ███╗█████╗
██╔═══╝   ╚██╔╝  ╚════██║██╔══██║██╔══╝  ██║     ██║     ██╔══╝  ██║   ██║██╔══██╗██║   ██║██╔══╝
██║        ██║   ███████║██║  ██║███████╗███████╗███████╗██║     ╚██████╔╝██║  ██║╚██████╔╝███████╗
╚═╝        ╚═╝   ╚══════╝╚═╝  ╚═╝╚══════╝╚══════╝╚══════╝╚═╝      ╚═════╝ ╚═╝  ╚═╝ ╚═════╝ ╚══════╝

Write shell scripts in Python. Render clean Bash.

A Python-native DSL for building, composing and rendering structured Bash scripts. The first Bash renderer supports comments, literal assignments, commands and checked text interpolation.

🏠 Homepage

Documentation

The docs/ directory is the source of truth for using and working on this repository:

• Documentation index: everything, organized by purpose
• Install: prerequisites, installation, the locked developer sandbox
• AST design: nodes, renderers and interpolation
• API reference: the script, nodes and Bash renderer
• Repository layout: what lives where and why
• Linting: the Rude plugin, its rule codes, and the rules that wait for the validator
• Project status: what exists today and what the roadmap adds
• Contributing: setup, the checks CI runs, the commit and merge policy
• Testing: test layout, what each layer proves, coverage
• Tooling: the automation CLI, its task graph, hooks and linters
• Documentation: policy, structure, validation and definition of done
• Releasing: the tag-triggered release and trusted publishing

Planned work is tracked in backlog/, and the release history is CHANGELOG.md.

Install

pip install pyshellforge

Usage

python -c 'from pyshellforge import ShellScript, Echo; print(ShellScript().add(Echo("Hello")).render())'

Run tests

pixi run automation test-all

Author

👤 PyShellForge contributors

• Website: archont561.github.io/Archont561
• GitHub: @Archont561

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check the issues page. You can also take a look at the contributing guide: it covers setup, the checks a change has to pass and the merge policy.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2026 PyShellForge contributors.
This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator from automation/readme/README.ejs.