Installation¶

This page shows how to install Frappe Manager. Choose the installation method that matches your needs.

📌 Version-Specific Installation

Since mkdocs-macros-plugin isn't yet supported by Zensical, both install methods are shown below. Use:

Stable Release (PyPI) for production use
Development Version (Git) for testing new features

Stable Release (Recommended)¶

📦 For production use and general development

Install the latest stable release from PyPI. This is the recommended option for most users.

uv (Recommended)pipxpip

# Run a single command without installing (great for trying it out)
uvx --from frappe-manager fm --help

# Install permanently
uv tool install --python 3.13 frappe-manager

# Upgrade later
uv tool upgrade frappe-manager

# Install stable release
pipx install frappe-manager

# Upgrade later
pipx upgrade frappe-manager

# Not recommended for system installs — prefer uv or pipx
pip install frappe-manager

Development Version¶

🚧 For testing unreleased features and contributing

Install the latest development version directly from the GitHub develop branch.

Unstable code

The development version contains unreleased features and may be unstable. Only use this if you're:

Testing new features before release
Contributing to Frappe Manager development
Reporting bugs that may already be fixed

uvpipx

# Install development version
uv tool install git+https://github.com/rtcamp/frappe-manager@develop

# Try without installing
uvx --from git+https://github.com/rtcamp/frappe-manager@develop fm --help

# Upgrade to latest develop
uv tool install --reinstall git+https://github.com/rtcamp/frappe-manager@develop

# Install development version
pipx install git+https://github.com/rtcamp/frappe-manager@develop

# Upgrade to latest develop
pipx install --force git+https://github.com/rtcamp/frappe-manager@develop

Verify the install¶

fm --version

If the command is not found, make sure the tool's bin directory is on your PATH. For uv, run:

uv tool update-shell

What gets installed where¶

Frappe Manager uses ~/frappe/ as its workspace. After you create your first bench, you'll find:

Directory	What lives there
`~/frappe/sites/`	Your bench folders
`~/frappe/services/`	Shared database and proxy
`~/frappe/logs/`	CLI logs
`~/frappe/backups/`	Migration backups
`~/frappe/archived/`	Archived/failed benches moved by fm migrate

Next step

Head to Quick Start to create your first bench.