Skip to Content
Forest CLIInstalling Forest CLI

Installing the Forest CLI

The Forest CLI is your entry point into the Forest PM ecosystem. It’s a lightweight tool that lets creators and teams manage packages and projects directly from the terminal.

Quick install

Run the command for your operating system in a terminal:

irm https://releases.forest.dev/install.ps1 | iex

The installer detects your platform, downloads the latest forest binary, verifies its SHA-256 checksum against the published release manifest, and adds it to your PATH. No admin rights are required; everything installs per-user:

OSInstall location
Windows%LOCALAPPDATA%\forest-cli\bin
macOS / Linux~/.local/bin

Prefer to inspect before running? Both scripts are plain text; open the URLs in your browser first.

Verify the installation

Open a new terminal (so the PATH change takes effect) and run:

forest --version

If installed correctly, you’ll see the Forest CLI version number.

From then on the CLI keeps itself current: forest upgrade updates it in place, and a one-line notice appears when a newer release is available.

Options

Download the script first to pass options:

# Pin a specific version .\install.ps1 -Version v0.1.0 # Uninstall .\install.ps1 -Uninstall

Environment overrides: FOREST_INSTALL_DIR (install location), FOREST_INSTALL_BASE (download mirror).

Supported platforms

PlatformArchitecture
Windowsx64 (ARM64 runs the x64 build under emulation)
macOSApple Silicon & Intel
Linuxx64

Install with Rokit

Forest is also available through Rokit , the Roblox toolchain manager. This lets each project pin its own CLI version:

rokit add Forest-Software-LLC/forest-cli forest

The trailing forest names the command. Without it, Rokit installs the tool as forest-cli. To pin per project, declare it in rokit.toml:

[tools] forest = "Forest-Software-LLC/forest-cli@1.13.0"

Under Rokit, versioning belongs to Rokit: forest upgrade refuses to run and updates come from rokit update forest. Rokit downloads release archives from GitHub rather than through the signed release manifest.

Last updated on