Skip to content

Windows Git Bash: troubleshooting pelican-quickstart command #3574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tubajavedd wants to merge 2 commits into
base: main
Choose a base branch
from
+29 −5
Open

Windows Git Bash: troubleshooting pelican-quickstart command #3574

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77567dc
Add Windows Git Bash troubleshooting instructions for pelican-quickstart
Feb 21, 2026
964377d
changes in file -> docs/install.rst
Mar 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ automatically installed without any action on your part:
broadcast signaling system
* `unidecode <https://pypi.org/project/Unidecode/>`_, for ASCII
transliterations of Unicode text
utilities
* `MarkupSafe <https://pypi.org/project/MarkupSafe/>`_, for a markup-safe
string implementation
* `python-dateutil <https://pypi.org/project/python-dateutil/>`_, to read
Expand All @@ -85,6 +84,30 @@ the latest stable release, you can do so by adding ``--upgrade``::
If you installed Pelican via distutils or the bleeding-edge method, simply
perform the same step to install the most recent version.

Windows notes
-------------

Git Bash users may encounter::

bash: pelican-quickstart: command not found

This occurs because Git Bash does not automatically include Python’s Scripts
directory in ``PATH``.

**Recommended options:**

* Use **PowerShell** instead of Git Bash
* Use **WSL (Windows Subsystem for Linux)** for a Linux-like environment

**Alternative workarounds:**

* Ensure Python’s Scripts directory is in ``PATH``
* Run Pelican via::

python -m pelican

See issue #3574 for discussion.

Kickstart your site
-------------------

Expand All @@ -98,8 +121,9 @@ If run inside an activated virtual environment, ``pelican-quickstart`` will
look for an associated project path inside ``$VIRTUAL_ENV/.project``. If that
file exists and contains a valid directory path, the new Pelican project will
be saved at that location. Otherwise, the default is the current working
directory. To set the new project path on initial invocation, use:
``pelican-quickstart --path /your/desired/directory``
directory. To set the new project path on initial invocation, use::

pelican-quickstart --path /your/desired/directory

Once you finish answering all the questions, your project will consist of the
following hierarchy (except for *pages* — shown in parentheses below — which
Expand All @@ -115,8 +139,8 @@ content)::
├── pelicanconf.py # Main settings file
└── publishconf.py # Settings to use when ready to publish

The next step is to begin to adding content to the *content* folder that has
been created for you.
The next step is to begin adding content to the *content* folder that has been
created for you.

.. _Pip: https://pip.pypa.io/
.. _virtualenv: https://virtualenv.pypa.io/en/latest/