fossa-cli - Fast, portable and reliable dependency analysis fo

项目说明

<!-- markdown-link-check-disable-next-line -->
!FOSSA

FOSSA CLI

<!-- NOTE: If you change the format of the "FOSSA Downloads" badge, make sure to also update the CI action at ./github/workflows/badges.yml that updates the download count. -->
<!-- markdown-link-check-disable-next-line -->
![FOSSA Downloads]()
<!-- markdown-link-check-disable-next-line -->
![Build]()
<!-- markdown-link-check-disable-next-line -->
![Dependency scan]()
<!-- markdown-link-check-disable-next-line -->
![FOSSA Security Status]()
<!-- markdown-link-check-disable-next-line -->
![FOSSA Status]()

fossa-cli is a zero-configuration polyglot dependency analysis tool. You can point fossa CLI at any codebase or build, and it will automatically detect dependencies being used by your project.

fossa-cli currently supports automatic dependency analysis for many different build tools and languages. It also has limited support for dependency detection, container scanning, and system dependency detection. These features are still a work in progress. Our goal is to make the FOSSA CLI a uni tool for dependency analysis.

fossa-cli integrates with FOSSA for dependency analysis, license scanning, scanning, attribution report generation, and more.

Table of Contents

1. Installation
2. Getting Started
3. User Manual
4. Reporting Issues
5. Contributing

Installation

Using the install script

FOSSA CLI provides an install script that downloads the latest release from GitHub Releases for your computer's architecture. You can see the source code and flags at install-latest.sh for Mac and Linux or install-latest.ps1 for Windows.

NOTE: You may need to add the downloaded executable to your $PATH. The installer script will output the installed path of the executable. You can also use -b to pick the installation directory when using install-latest.sh (see the install-latest.sh source code for details).

#### macOS or 64-bit Linux

#### macOS with brew

<!-- -->
> The FOSSA CLI in the brew cask is updated to the latest every 3 hours.

#### Windows with Powershell

<!-- markdown-link-check-disable-next-line -->
Alternatively, install using Scoop:

Please refer to detailed walkthrough Installing FOSSA CLI, for installing FOSSA CLI 1.x and using GitHub Releases to install FOSSA CLI manually.

Getting Started

Integrating your project with FOSSA

#### TL;DR, Linux, Mac, \*nix-like

#### TL;DR, Windows

#### Installing FOSSA CLI

Follow the installation instructions above to install the FOSSA CLI. Once installed, you should have a new binary named fossa a on your $PATH.

#### Generating an API key

To get started with integrating your project into FOSSA, you'll need to generate an API key. You'll get this API key from the FOSSA web application (app.fossa.com).

Once you have your API key:

#### Running an analysis

Now we can run an analysis. To run an analysis, all you need to do is na to your project's directory and run fossa analyze.

NOTE: While fossa will try its best to report a results for any kind of project, you'll get the best results by running in a directory with a working project build. A working build lets us integrate directly with your build tool to identify dependencies, instead of trying to infer dependencies from your source code.

#### your results

Once an analysis has been uploaded, you can view your results in the FOSSA web application. You can see your analysis by using the link provided as output by fossa analyze, or by na to your project and re in the FOSSA web application.

#### What next?

Now that your analysis is complete, there are a couple things you might want to do after an initial integration:

Double-check your results. Some analysis methods may produce partial or unexpected results depending on what information was a when you ran the analysis. If something seems wrong, our debugging guide can help you diagnose and debug your integration.

Scan for issues and generate a compliance report. Once your analysis is ready, we'll automatically queue an issue scan and report the results in the web application. Once an issue scan is complete, you can also generate a report from the web application.

Set up FOSSA in your CI. You can also use your issue scan results as inputs to CI scripts. For GitHub repositories, you can use FOSSA's nati integration to report a status check on your PRs. For other CI integrations, you can also use fossa test to get programmatic issue status in CI.

User Manual

For most users, the FOSSA CLI will work out-of-the-box without any configuration. Just get an API key, run fossa analyze, and view your results in the FOSSA web application.

Users who need ad customization or features should see the User Manual. Some common topics of interest include:

Debugging your integration

Specifying dependencies

Adding manual dependencies

Supported languages

Reporting Issues

If you' a bug or need support, the best way to get support is via the FOSSA support portal.

Make sure to include reproduction steps and any relevant project files (e.g. pom.xmls, package.jsons, etc.). Including the output from fossa analyze --debug in the email as well as any relevant fossa files (fossa-deps.json, .fossa.yml) will help expedite a solution.

We'll try to respond to issues opened in this repository on a best-effort basis, but we mostly provide support via the FOSSA support portal.

Contributing

If you're interested in contributing, check out our contributor documentation. PRs are welcome!

项目信息

开发语言：Haskell

Star 数：1521

技术要点

该项目属于漏洞知识库方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕Fast, portable and reliable dependency analysis for any codebase. Supports license & vulnerability scanning for large monoliths. Language-agnostic; integrates with 20+ build systems.展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。