Before You Begin
Frogbot relies on the presence of package manager executables and proper configuration to accurately scan and secure your repositories.
SCA Requirements
| Package Manager Executables | Ensure the appropriate package manager is installed and operational in your environment. |
| Network Access | Frogbot may need internet access to download dependencies based on your package manager settings. |
| Environment Configuration | Ensure that necessary environment variables, proxies, or custom configurations are properly set. |
Technology-Specific Prerequisites
Each package manager and build tool may have unique prerequisites.
npm (Node.js)
| Requirements | Ensure Node.js and npm are installed and available in your PATH. |
| Lock File | package-lock.json is required for accurate dependency scanning. |
| Environment Setup | Run npm install to verify dependencies resolve correctly. |
Yarn
| Requirements | Install Yarn and verify it’s available in your PATH. |
| Lock File | The yarn.lock file must be present. |
| Environment Setup | Run yarn install to confirm that the setup works without errors. |
Maven (Java)
| Requirements | Ensure Maven (or the mvnw wrapper) is accessible. |
| Lock File | The pom.xml file should be correctly configured. |
| Environment Setup | Execute mvn install to validate dependency resolution. |
Python (pip)
| Requirements | Python and pip must be installed and available in the environment. |
| Lock File | The requirements.txt file should be present for dependency definitions. |
| Environment Setup | Run pip install -r requirements.txt to ensure dependencies are configured correctly. |
Go
| Requirements | Ensure Go is installed and available in your PATH. |
| Lock File | The go.sum file must be present for accurate dependency scanning. |
| Environment Setup | Run go mod tidy to ensure all dependencies are correctly listed and resolved in go.sum. |
.NET (NuGet)
| Requirements | Install the .NET SDK and ensure NuGet is available in your PATH. |
| Visual Studio Projects | Ensure .sln files are present in your repository. |
| Other Dependency Files | Files such as packages.config or *.csproj should be present and correctly configured. |
| Lock File | Various files assist in tracking dependencies; specific files ensure completeness. |
| Environment Setup | Run dotnet restore to confirm that all NuGet dependencies are resolved correctly. |