README
¶
FOSSA CLI
WARNING: This tool is being actively developed. There may be breaking changes.
fossa is a tool that interrogates your environment and build to discover the dependencies getting included in your software. It can be used alone or within build systems to dig out dependency data from complex monolithic builds.
This tool integrates directly with the FOSSA web service to provide open source reports, search intelligence, vulnerability/license scanning and triage workflows to help your organization to manage its open source use.
The CLI provides an alternative path to integrating your code repositories and builds in a way that doesn't require code access or FOSSA environment setup, or enrich dependency reports with dynamically confirmed dependency artifacts.
FOSSA CLI is currently in alpha and will have a changing API; join our contributor group to get development updates
Installation
fossa is compatible with Windows, Darwin (MacOS) and *nix-based operating systems.
Usage
fossa
Development
Adding language integrations
See Adding New Languages.
Running tests
Since fossa relies on having the correct build tools in your local environment, running fossa tests requires being able to successfully build all projects in test/fixtures/. To provide these tools and prevent you from clobbering your local machine, we have run tests in a Docker container defined at test/Dockerfile.
License
fossa is Open Source and licensed under the AGPLv3.
You are free to use fossa and its binaries under all common use conditions (i.e. integrating personal projects, securely scanning corporate code, adding steps to build plugins) without contributing or releasing any integrated / proprietary code... Enjoy!
You are free to contribute or develop applications on top of fossa, but any modifications / derivative works must be released back to the community under this license.
Please contact support@fossa.io for additional licensing guidance.
Copyright (C) 2018 FOSSA, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Directories