forge install
Install one or multiple dependencies.
$ forge install --help
Usage: forge install [OPTIONS] [DEPENDENCIES]...
forge install [OPTIONS] <github username>/<github project>@<tag>...
forge install [OPTIONS] <alias>=<github username>/<github project>@<tag>...
forge install [OPTIONS] <https:// git url>...
Arguments:
[DEPENDENCIES]...
The dependencies to install.
A dependency can be a raw URL, or the path to a GitHub repository.
Additionally, a ref can be provided by adding @ to the dependency
path.
A ref can be: - A branch: master - A tag: v1.2.3 - A commit: 8e8128
For exact match, a ref can be provided with `@tag=`, `@branch=` or
`@rev=` prefix.
Target installation directory can be added via `<alias>=` suffix. The
dependency will installed to `lib/<alias>`.
Options:
--root <PATH>
The project's root path.
By default root of the Git repository, if in one, or the current
working directory.
--shallow
Perform shallow clones instead of deep ones.
Improves performance and reduces disk usage, but prevents switching
branches or tags.
--no-git
Install without adding the dependency as a submodule
--no-commit
Do not create a commit
-h, --help
Print help (see a summary with '-h')
-j, --threads <THREADS>
Number of threads to use. Specifying 0 defaults to the number of
logical cores
[aliases: jobs]
Display options:
--color <COLOR>
The color of the log messages
Possible values:
- auto: Intelligently guess whether to use color output (default)
- always: Force color output
- never: Force disable color output
--json
Format log messages as JSON
-q, --quiet
Do not print log messages
-v, --verbosity...
Verbosity level of the log messages.
Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv).
Depending on the context the verbosity levels have different meanings.
For example, the verbosity levels of the EVM are:
- 2 (-vv): Print logs for all tests.
- 3 (-vvv): Print execution traces for failing tests.
- 4 (-vvvv): Print execution traces for all tests, and setup traces
for failing tests.
- 5 (-vvvvv): Print execution and setup traces for all tests,
including storage changes.