This section provides an overview of the
forge command line tool. We demonstrate how to create a new project, compile, and test it.
To start a new project with Foundry, use
$ forge init hello_foundry
Let's check out what
forge generated for us:
$ cd hello_foundry $ tree . -d -L 1 . ├── lib ├── script ├── src └── test 4 directories
We can build the project with
$ forge build Compiling 10 files with 0.8.16 Solc 0.8.16 finished in 3.97s Compiler run successful
And run the tests with
$ forge test No files changed, compilation skipped Running 2 tests for test/Counter.t.sol:CounterTest [PASS] testIncrement() (gas: 28312) [PASS] testSetNumber(uint256) (runs: 256, μ: 27376, ~: 28387) Test result: ok. 2 passed; 0 failed; finished in 24.43ms
You can always print help for any subcommand (or their subcommands) by adding
--helpat the end.
You can watch these beginner tutorials if you are a visual learner.