README.md

User Manual

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

If you haven't read the Getting Started section in the README yet, we highly recommend starting there first.

This manual is organized into three sections:

1. Walkthroughs explain how to accomplish common use cases, including common troubleshooting steps and follow-ups.

2. Features explain specific CLI features and how to use them.

3. References provide an exhaustive listing and explanation of all CLI functionality.

Every piece of documentation is accessible via hyperlink from this user manual. You should never need to manually explore docs/ to find the page you need.

Table of Contents

• User Manual
  • Table of Contents
  • Walkthroughs
  • Features
  • References

Walkthroughs

Walkthrough guides explain how to accomplish specific tasks. They also include troubleshooting steps answer common questions.

• Integrating a project
• Debugging a strategy
• Analysis target configuration
• Custom integration

Features

Feature guides explain how to use specific features. These are most useful if there is a specific feature that a walkthrough has pointed you to.

• Manual dependencies
• Vendored dependencies

References

Reference guides provide an exhaustive listing of all CLI functionality. If you can't find documentation on how something works elsewhere, it should be here.

• CLI commands
  • fossa analyze
  • fossa test
  • fossa report
  • fossa list-targets
• CLI configuration files
  • .fossa.yml
  • fossa-deps.{yml,json}
• CLI analysis strategies
• Experimental
  • Experimental options overview
  • CLI Commands
    • fossa experimental-link-user-defined-dependency-binary
• CLI Telemetry