Requirements
Bengal requires Python 3.14 or later. For best performance, use Python 3.14t (free-threaded build).
Install
uv pip install bengal
Or for a one-time run:
uvx bengal --version
pip install bengal
pipx install bengal
This installs Bengal in an isolated environment while making thebengalcommand available globally.
1 2 3 | |
This installs Bengal in development mode.
Verify Installation
bengal --version
You should see output like:Bengal SSG, version X.X.X
Python Version Setup
pyenv lets you install and switch between multiple Python versions:
1 2 3 4 5 6 7 8 9 10 11 | |
Download Python 3.14 from python.org/downloads.
After installation, verify:python3 --version
Free-Threaded Python (Optional)
For best performance, use the free-threaded build (Python 3.14t):
1 2 3 4 5 6 | |
Why? The free-threaded build enables true parallel processing for 1.8-2x faster builds.
Troubleshooting
Command not found
Ensure Python's bin directory is in your PATH.
If using a virtual environment, activate it:
source .venv/bin/activate
Try reinstalling:
pip uninstall bengal && pip install bengal
Python version errors
Verify your Python version:
1 2 3 | |
Install Python 3.14+ using pyenv or the official installer.
Permission errors
Use the--userflag:
pip install --user bengal
Or use a virtual environment:
python -m venv venv && source venv/bin/activate
Next Steps
- Writer Quickstart — Start creating content
- Themer Quickstart — Customize your site's look
- Tutorials — Guided learning journeys