Install Cookieplone

Install Cookieplone#

Cookieplone is a command line application written in Python. You can run it without installing it, install it as a tool, or install it in a virtual environment.

Requirements#

Cookieplone needs:

  • Python 3.10, 3.11, 3.12, 3.13, or 3.14.

  • uv, to run Cookieplone with uvx or to install it.

  • git, to download templates from a git repository, such as the default cookieplone-templates.

Before it asks its first question, each official template checks your computer for the tools it needs. When a required tool is missing, the template stops.

Template

uv

Node.js

git

Docker

project, aurora_cmfplone, monorepo_addon

Required

Required

Required

Optional, version 26 or later

volto_nick, aurora_nick, aurora_nick_embedded

—

Required

Required

—

backend_addon

Required

—

Required

—

frontend_addon, aurora_addon

—

Required

Required

—

documentation_starter

—

—

—

—

Each template's page in Official templates lists the Node.js versions it accepts. To work on a generated project, follow the prerequisites in its README.md.

Note

The Cookieplone test suite runs on Linux. For operating system requirements, including Windows, see Prerequisites for installation in the Plone documentation.

Run Cookieplone without installing it#

uvx downloads Cookieplone and runs it:

uvx cookieplone

Without a version, uvx runs the latest stable release. To try a prerelease, see Use a prerelease version of Cookieplone.

To run a specific release, add its version after @:

uvx cookieplone@2.0.0

To ask for the latest stable release explicitly, use @latest:

uvx cookieplone@latest

Install Cookieplone as a tool#

Install Cookieplone with uv tool install, to use the cookieplone command without uvx:

uv tool install cookieplone

If uv warns that its tool directory isn't on your PATH, run the command it suggests.

Upgrade the tool to the latest release:

uv tool upgrade cookieplone

Install Cookieplone in a virtual environment#

Create a virtual environment, activate it, and install Cookieplone into it:

uv venv
source .venv/bin/activate
uv pip install cookieplone

Check the version#

Print the version of the Cookieplone you run:

cookieplone --version

With uvx, run uvx cookieplone --version. The first line shows the Cookieplone version, where it's installed, and the Cookiecutter and Python versions it uses.

Next steps#

Contents