FELUDA(1)

NAME
feluda - Detect license usage restrictions in your project!

SYNOPSIS
feluda [OPTIONS] [COMMAND]

DESCRIPTION
           FELUDA LICENSE CHECKER

Feluda is a CLI tool that analyzes the dependencies of a project, identifies their licenses, and flags any that may restrict personal or commercial usage.

  Commands:

generate
    Generate license-related files

sbom
    Generate Software Bill of Materials (SBOM)

cache
    Manage cache

help
    Print this message or the help of the given subcommand(s)

OPTIONS

-d, --debug

    Enable debug mode

-p, --path <PATH>

    Path to the local project directory

    [default: ./]

--repo <REPO>

    URL of the Git repository to analyze (HTTPS or SSH)

--token <TOKEN>

--ssh-key <SSH_KEY>

--ssh-passphrase <SSH_PASSPHRASE>

--github-token <GITHUB_TOKEN>

    GitHub personal access token for API authentication (increases rate limits)

    [env: GITHUB_TOKEN=]

-j, --json

    Output in JSON format This will override the default output format and will not show the TUI table. This is useful for CI/CD pipelines

-y, --yaml

    Output in YAML format This will override the default output format and will not show the TUI table. This is useful for CI/CD pipelines

--verbose

    Enable verbose output

-r, --restrictive

    Show only restrictive dependencies

-g, --gui

    Enable TUI table

-l, --language <LANGUAGE>

    Specify the language to scan

--ci-format <CI_FORMAT>

    Output format for CI systems (github, jenkins)

    Possible values: - github: GitHub Actions compatible format - jenkins: Jenkins compatible format (JUnit XML)

--output-file <OUTPUT_FILE>

    Path to write the CI report file

--fail-on-restrictive

    Fail with non-zero exit code when restrictive licenses are found

--incompatible

    Show only incompatible dependencies

--fail-on-incompatible

    Fail with non-zero exit code when incompatible licenses are found

--project-license <PROJECT_LICENSE>

    Specify the project license (overrides auto-detection)

--gist

--osi <OSI>

    Filter by OSI license approval status

    Possible values: - approved: Show only OSI approved licenses - not-approved: Show only non-OSI approved licenses - unknown: Show licenses with unknown OSI status

--strict

    Enable strict mode for license parser

--no-local

    Skip local license detection, force network lookup only

-h, --help

    Print help (see a summary with '-h')

-V, --version

    Print version