| title | Installation |
|---|
Before you can set up a build project, you need to install Fallout's dedicated .NET global tool:
# terminal-command
dotnet tool install Fallout.GlobalTool --global:::tip
For repos that already have a .config/dotnet-tools.json manifest with Fallout.GlobalTool pinned (this is what fallout :setup creates), you can skip the global install and run dotnet tool restore instead — the local manifest version then takes precedence.
:::
From now on, you can use the global tool to:
- Set up new builds
- Run existing builds
- Leverage shell completion
- Add tool & library packages
- Navigate around root directories
- Convert CAKE build scripts
- Manage secrets in parameter files
:::note
If you're running on Linux-based systems, it's worth checking if the fallout global tool is available. This can be verified with where fallout. If the global tool is not found, you have to manually add $HOME/.dotnet/tools to your terminal configuration:
# terminal-command
echo 'export PATH=$HOME/.dotnet/tools:$PATH' >> ~/.zshrc:::info While theoretically, you could use Fallout by only adding its main NuGet package, we highly recommend using the dedicated global tool to set up new builds. This ensures that your repository will run consistently in different environments and that your build implementation is always properly formatted. :::