Surfactant

Welcome to Surfactant’s documentation!

Surfactant provides a modular framework to gather file information and analyze dependencies for generating an SBOM.

Some links to pages that may be useful are:

PyPI GitHub/Source Code Discussions

Contents

• Surfactant
• Getting Started
  • System Prerequisites
  • Installation
  • Understanding the SBOM Output
• Basic Usage
  • Identify Sample File
  • Running Surfactant
  • Merging SBOMs
• Configuration Files
  • Build configuration file
  • Example configuration files
• Plugins
  • Creating a Plugin
• Contribution Guide
• Changelog

Support

Full user guides for Surfactant are available online and in the docs directory in the GitHub repository.

For questions or support, please create a new discussion on GitHub Discussions, or open an issue for bug reports and feature requests.

License

Surfactant is released under the MIT license. See the LICENSE and NOTICE files for details. All new contributions must be made under this license.

Indices and tables

• Index

• Module Index

• Search Page