Foundry Book

forge install

NAME

forge-install - Install one or more dependencies.

DESCRIPTION

Install one or more dependencies.

Dependencies are installed as git submodules. If you do not want this behavior, pass --no-git.

If no arguments are provided, then existing dependencies are installed.

Dependencies can be a raw URL (https://foo.com/dep), an SSH URL (git@github.com:owner/repo), or the path to a GitHub repository (owner/repo). Additionally, a ref can be added to the dependency path to install a specific version of a dependency.

A ref can be:

A branch: owner/repo@master
A tag: owner/repo@v1.2.3
A commit: owner/repo@8e8128

The ref defaults to master.

You can also choose the name of the folder the dependency will be in. By default, the folder name is the name of the repository. If you want to change the name of the folder, prepend <folder>= to the dependency.

OPTIONS

Project Options

--root path
The project’s root path. By default, this is the root directory of the current git repository, or the current working directory.

VCS Options

--no-commit
Do not create a commit.

--no-git
Install without adding the dependency as a submodule.

Display Options

-q
--quiet
Do not print any messages.

Common Options

-h
--help
Prints help information.

EXAMPLES

Install a dependency:
```
forge install transmissions11/solmate
```
Install a specific version of a dependency:
```
forge install transmissions11/solmate@v7
```

Install multiple dependencies:

forge install transmissions11/solmate@v7 OpenZeppelin/openzeppelin-contracts

Install a dependency without creating a submodule:
```
forge install --no-git transmissions11/solmate
```

Install a dependency in a specific folder:

forge install soulmate=transmissions11/solmate