Installing Forge

Forge can be installed on Windows, macOS, and Linux operating systems. Follow the instructions for your preferred method below.

NPM Installation (Recommended)

The recommended way to install Forge is using npm, which works consistently across all platforms (Windows, macOS, and Linux):

# Install Forge globally using npm
npm install -g @antinomyhq/forge

# Or run directly without installation using npx
npx @antinomyhq/forge

This method provides a consistent installation experience across all operating systems.

While npm is the recommended approach, you can also install Forge using these platform-specific methods:

Using Homebrew (macOS package manager):

# Add Code-Forge's package repository to Homebrew
brew tap antinomyhq/code-forge

# Install Code-Forge
brew install code-forge

If you don't have Homebrew installed, you can install it by following the instructions at brew.sh.

Choose either of these methods to install Forge on Linux:

curl -L https://raw.githubusercontent.com/antinomyhq/forge/main/install.sh | bash

wget -qO- https://raw.githubusercontent.com/antinomyhq/forge/main/install.sh | bash

After installation, verify that Forge is installed correctly by checking the version:

forge --version

You should see output displaying the version of Forge that you've installed.

To update Forge to the latest version:

# Update globally installed package
npm update -g @antinomyhq/forge

brew upgrade code-forge

Run the same installation command again to get the latest version:

curl -L https://raw.githubusercontent.com/antinomyhq/forge/main/install.sh | bash

After installing Forge, follow the Quick Setup guide to configure your environment and get started using Forge.