Installation
How to install Fresh on your system
Fresh requires Python 3.12 or later. This guide covers various installation methods.
We recommend using uv for faster installation and better dependency management.
Requirements
- Python 3.12 or higher
- uv (recommended) or pip
Installation Methods
Using uv (Recommended)
uv is the fastest package manager for Python. If you have uv installed:
uv syncThis will install Fresh and all its dependencies in your current project.
Using pip
If you prefer pip:
pip install fresh-docsOr install in development mode:
pip install -e .Verify Installation
Check that Fresh is installed correctly:
fresh --versionYou should see output like:
fresh, version 2.8.4If you see the version number, Fresh is installed correctly!
Getting Help
# Show help
fresh --help
# Show help for a specific command
fresh get --help
fresh search --helpUpgrading
To upgrade to the latest version:
# Using pip
pip install --upgrade fresh-docs
# Or check for updates
fresh update --check