The Workbench-Agent is a CLI to interact with and automate FossID Workbench.
This is the Community Edition (CE) of the Workbench Agent maintained by the Customer Success Team. We use GitHub Issues for this repo; thank you in advance for reporting any issues! We will do our best to stay on top of any GitHub Issues opened.
The official Workbench Agent is maintained by Engineering and has contracted SLA.
This repo publishes container images to GitHub Container Registry (ghcr.io/fossid-ab/workbench-agent-ce) with several tags:
- latest - the latest stable release - use this tag when you want to run the newest stable release
- version tag - a tagged release (for example
0.8.0) - use this tag in CI for reproducibility - edge - the latest and greatest in between releases - use this tag carefully, as it may break between releases
docker run ghcr.io/fossid-ab/workbench-agent-ce:latest --helpThis shows the general Help message and lets you know the container is ready! Each command has its own help:
docker run ghcr.io/fossid-ab/workbench-agent-ce:latest scan --help
docker run ghcr.io/fossid-ab/workbench-agent-ce:latest evaluate-gates --help
docker run ghcr.io/fossid-ab/workbench-agent-ce:latest download-reports --helpThe Workbench Agent Wiki has more information on each command.
The Getting Started Guide walks through initial setup and running your first scan.
The scanning-related commands (scan, scan-git, blind-scan) support the same scan settings available in the Workbench UI. Visit Customizing Scan Operations for details.
Thank you for considering contributing to Workbench Agent CE! The best way to contribute is by reporting bugs or by sending improvement suggestions. Please create an Issue in this GitHub repository with bugs or improvement ideas.
Pull requests are also welcomed. Please note that the Workbench-Agent is licensed under MIT license. The submission of your contribution implies that you agree with MIT licensing terms.