Skip to main content

Installing Forge

Before installing Forge, you'll need to sign up for an account to get started.

Sign Up for Forge​

  1. Sign up
  2. Create your account: You can sign up using your Google or GitHub account for quick authentication
  3. Create API Key: Once logged in, generate your Forge API key from your account dashboard
  4. Set up environment: Create a .env file in your home directory and add your API key: 
    # ~/.env or in your project directory
    FORGE_KEY=your_forge_api_key_here

Once you have your account and API key set up, you can proceed with the installation.

Installation​

Forge can be installed on Windows, macOS, and Linux operating systems. The recommended method is using npm, which works consistently across all platforms.

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

# Install Forge globally using npm
npx forgecode@latest

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

Alternative Installation Methods​

macOS: Homebrew

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.

Linux Installation

Choose either of these methods to install Forge on Linux:

Using curl​

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

Using wget​

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

Verifying Your Installation​

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.

Updating Forge​

To update Forge to the latest version using npm:

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

macOS: Homebrew​

brew upgrade code-forge

Linux​

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

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

Project Context​

Start Forge from your project's root directory to give it the full context of your project structure.

BYOK (Bring Your Own Key)​

After installing Forge, you can also configure other AI providers. Follow the Provider Configuration guide to set up alternative providers like OpenAI, Anthropic, or OpenRouter.