Skip to content

Installation

Forest is published on PyPI as forest-cli and requires Python 3.9+.

pip install forest-cli
pip install -e ./forest

Prerequisite: rclone

Forest delegates transfers to rclone, which must be on your $PATH:

rclone version

If that prints a version, you're set. If not, install it from rclone.org/install.

Verify

forest --help

Alpha software

Forest is currently Development Status :: 3 — Alpha and assumes a single active machine per workspace (v1). See the data model for how local state is protected with atomic writes and a per-checkout flock that also spans transfers.

Next: the quick start onboards a repo in five commands.