Feluda

Current Stable: v1.0.0

Feluda is a Rust-based command-line tool that analyzes the dependencies of a project, notes down their licenses, and flags any permissions that restrict personal or commercial usage.

Features

• Parse your project to identify dependencies and their licenses.
• Classify licenses into permissive, restrictive, or unknown categories.
• Flag dependencies with licenses that may restrict personal or commercial use.
• Output results in plain text or JSON format.

Support Languages

• Rust
• NodeJs
• Go
• Python

If your fav language or framework isn't supported, feel free to open an feature request issue! 👋

Installation

Prerequisites

• Rust installed on your system.

If you already had it, make sure it's up-to-date and update if needed.

Clone and Build

# Clone the repository
git clone https://github.com/anistark/feluda.git
cd feluda

# Build the project
cargo build --release

# Add Feluda to your PATH (optional)
export PATH="$PWD/target/release:$PATH"

Usage

Basic Usage

Run the tool in the project directory:

feluda

Specify a Path to your project directory

feluda --path /path/to/project/

Output Format

• Default: Plain text.
• JSON: Use the --json flag for JSON output.

feluda --json

Sample Output for a sample cargo.toml file containing serde and tokio dependencies:

[
  {
    "name": "serde",
    "version": "1.0.151",
    "license": "MIT",
    "is_restrictive": false
  },
  {
    "name": "tokio",
    "version": "1.0.2",
    "license": "MIT",
    "is_restrictive": false
  }
]

Verbose Mode

For detailed information about each dependency:

feluda --verbose

Strict Mode

In case you strictly need only the restrictive dependencies:

feluda --strict

Checkout contributing guidelines if you are looking to contribute to this project.

License

Feluda is licensed under the MIT License with Commons Clause.

Happy coding with Feluda! 🚀