Flicense

https://github.com/wyvernixtl/flicense-rs
Admin
Flicense is a CLI tool for printing license information of Rust cargo projects to the terminal with...
Tokens:3,378
Snippets:44
Trust Score:5.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install flicense from Source

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Installs the flicense tool directly from the source using Cargo.

```sh
cargo install flicense
```

--------------------------------

### Install flicense via Cargo Binstall

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Installs the flicense binary using cargo-binstall.

```sh
cargo binstall -y flicense
```

--------------------------------

### Install flicense via Homebrew

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Installs the flicense tool using Homebrew on Linux or MacOS.

```sh
brew install wyvernixtl/tap2/flicense
```

--------------------------------

### Install flicense via Scoop

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Installs the flicense tool using the Scoop package manager on Windows.

```sh
scoop bucket add stupid-bucket https://github.com/WyvernIXTL/stupid-bucket
scoop install stupid-bucket/flicense
```

--------------------------------

### Integrate License Fetcher in Rust Build Script

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Example `build.rs` for embedding license information of dependencies into a Rust application using `license-fetcher`. Ensure `Cargo.lock`, `Cargo.toml`, and `build.rs` are present for correct reruns.

```rust
// build.rs
use license_fetcher::build::config::{Config, ConfigBuilder};
use license_fetcher::build::package_list_with_licenses;
use license_fetcher::PackageList;

fn main() {
    // Create config from cargo's build environment variables
    let config: Config = ConfigBuilder::from_build_env()
        .build()
        .expect("Failed to build config");

    // Fetch license information for all dependencies
    let packages: PackageList = package_list_with_licenses(config)
        .expect("Failed to fetch licenses");

    // Write to OUT_DIR for embedding via macro
    packages.write_package_list_to_out_dir()
        .expect("Failed to write package list");

    // Only rerun if these files change
    println!("cargo::rerun-if-changed=build.rs");
    println!("cargo::rerun-if-changed=Cargo.lock");
    println!("cargo::rerun-if-changed=Cargo.toml");
}

// In your main.rs, read the embedded licenses:
// use license_fetcher::read_package_list_from_out_dir;
// let packages = read_package_list_from_out_dir!().unwrap();

```

--------------------------------

### Encode Licenses for Embedding

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Generates a compressed binary file containing all license information, suitable for embedding into your application at build time using the `license-fetcher` library. The example shows how to generate the file and a snippet of how to use it in a Rust application.

```bash
# Generate encoded license file
flicense --encode ./target/3rd-party-licenses.bincode.deflate

# In your Rust application, you can then use:
# use license_fetcher::read_package_list_from_out_dir;
# let packages = read_package_list_from_out_dir!().unwrap();
# println!("{}", packages);
```

--------------------------------

### CLI Usage Help

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Displays the available command-line arguments and options for flicense.

```text
CLI for printing license information of rust cargo projects to the terminal.

Usage: flicense.exe [OPTIONS] [MANIFEST_DIR_PATH]

Arguments:
  [MANIFEST_DIR_PATH]  Optional path to manifest dir (where Cargo.toml and Cargo.lock are). Defaults to current dir

Options:
  -y, --yaml                Output as yaml
  -j, --json                Output as json
  -s, --short               Outputs only a short overview
      --stats               Outputs stats regarding how many licenses have been found and for what crates
  -o, --omit-license-text   Omits outputting license text
  -e, --encode <FILE PATH>  Write the package list encoded via bincode and compressed via miniz_oxide to the given file
  -l, --license             Outputs license information regarding this software and it's dependencies
  -h, --help                Print help
  -V, --version             Print version
```

--------------------------------

### Display All Licenses

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Prints complete license information for all dependencies in the current Rust project. Specify a path to scan a different project.

```bash
# Display licenses for the current directory
flicense

# Display licenses for a specific project path
flicense /path/to/rust/project

# Example output:
# ================================================================================
#
# Package:     serde 1.0.219
# Description: A generic serialization/deserialization framework
# Authors:     - Erick Tryzelaar <erick.tryzelaar@gmail.com>
#              - David Tolnay <dtolnay@gmail.com>
# Repository:  https://github.com/serde-rs/serde
# SPDX Ident:  MIT OR Apache-2.0
#
# --------------------------------------------------------------------------------
# Permission is hereby granted, free of charge, to any person obtaining...
```

--------------------------------

### Display Short License Overview

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Provides a concise summary of licenses used by dependencies.

```sh
flicense ./license-fetcher/ -s
# MIT OR Zlib OR Apache-2.0: miniz_oxide
# MIT: bincode, bincode_derive, virtue
# 0BSD OR MIT OR Apache-2.0: adler2
# BSL-1.0: license-fetcher
```

--------------------------------

### Short License Overview

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Displays a condensed view of licenses, grouping packages by their SPDX identifiers. This provides a quick overview of the project's license landscape.

```bash
flicense --short

# Example output:
# MIT OR Zlib OR Apache-2.0: miniz_oxide
# MIT: bincode, bincode_derive, virtue, serde, serde_json
# Apache-2.0 OR MIT: clap, clap_builder, clap_derive
# BSL-1.0: flicense
# 0BSD OR MIT OR Apache-2.0: adler2
```

--------------------------------

### License Statistics

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Presents a table showing which packages have their license text successfully retrieved, along with a summary percentage. This helps identify crates where license fetching might have failed.

```bash
flicense --stats

# Example output:
# name                          license found
# flicense                      ✓
# adler2                        ✓
# bincode                       ✓
# clap                          ✓
# serde                         ✓
# some-private-crate            ✗
#
# license found: 95%
```

--------------------------------

### Display flicense License Information

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Use this command to show the license details for flicense and its dependencies. This is useful for compliance purposes when distributing flicense.

```bash
flicense --license
```

--------------------------------

### Display License Statistics

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Outputs statistics on license discovery success for project dependencies.

```sh
flicense ./license-fetcher/ --stats
# name                          license found
# license-fetcher               ✓
# adler2                        ✓
# bincode                       ✓
# bincode_derive                ✓
# miniz_oxide                   ✓
# unty                          ✓
# virtue                        ✓
#
# license found: 100%
```

--------------------------------

### Run flicense Without Flags

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Executes flicense to display default license information for the current directory.

```sh
flicense ./
flicense # no argument implies the current directory
# ================================================================================
#
# Package:     license-fetcher 0.6.2
# Description: Fetch licenses of dependencies at build time and embed them into your program.
# Authors:     - Adam McKellar <dev@mckellar.eu>
# Repository:  https://github.com/WyvernIXTL/license-fetcher
# SPDX Ident:  BSL-1.0
#
# --------------------------------------------------------------------------------
# Copyright Adam McKellar 2024
#
# Boost Software License - Version 1.0 - August 17th, 2003
#
# ...
```

--------------------------------

### YAML Output Format

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Outputs license information in YAML format, useful for documentation or configuration files. Use --omit-license-text to exclude license text.

```bash
flicense --yaml

# Example output:
# - name: serde
#   version: '1.0.219'
#   authors:
#   - Erick Tryzelaar <erick.tryzelaar@gmail.com>
#   - David Tolnay <dtolnay@gmail.com>
#   description: A generic serialization/deserialization framework
#   homepage: null
#   repository: https://github.com/serde-rs/serde
#   license_identifier: MIT OR Apache-2.0
#   license_text: |
#     Permission is hereby granted...

# Output YAML without license text for compact metadata
flicense ./my-project --yaml --omit-license-text
```

--------------------------------

### JSON Output Format

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Outputs license information as a JSON array, suitable for programmatic processing. Use --omit-license-text to exclude the license content.

```bash
flicense --json

# Example output:
# [
#   {
#     "name": "serde",
#     "version": "1.0.219",
#     "authors": [
#       "Erick Tryzelaar <erick.tryzelaar@gmail.com>",
#       "David Tolnay <dtolnay@gmail.com>"
#     ],
#     "description": "A generic serialization/deserialization framework",
#     "homepage": null,
#     "repository": "https://github.com/serde-rs/serde",
#     "license_identifier": "MIT OR Apache-2.0",
#     "license_text": "Permission is hereby granted..."
#   }
# ]

# Combine with omit flag for metadata only
flicense --json --omit-license-text
```

--------------------------------

### Encode Licenses for Embedding

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Encodes license data into a binary file for use in build scripts.

```sh
flicense --encode ./target/3rd-party-licenses.bincode.deflate
```

--------------------------------

### Generate Shell Completions for flicense

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Generates shell completion scripts for various shells like bash, zsh, fish, and PowerShell. This enables tab-completion for flicense commands and options.

```bash
# List supported shells
flicense --list-supported-shells-for-shell-completion
```

```bash
# Generate bash completions
flicense --generate-shell-completion bash > ~/.local/share/bash-completion/completions/flicense
```

```bash
# Generate zsh completions
flicense --generate-shell-completion zsh > ~/.zfunc/_flicense
```

```bash
# Generate fish completions
flicense --generate-shell-completion fish > ~/.config/fish/completions/flicense.fish
```

```bash
# Generate PowerShell completions
flicense --generate-shell-completion powershell > flicense.ps1
```

--------------------------------

### Omit License Text

Source: https://context7.com/wyvernixtl/flicense-rs/llms.txt

Retrieves only metadata (name, version, authors, etc.) without the full license text, resulting in faster execution and smaller output. Applicable to human-readable, JSON, and YAML formats.

```bash
# Human-readable output without license text
flicense --omit-license-text

# JSON output without license text
flicense --json --omit-license-text

# YAML output without license text
flicense --yaml -o
```

--------------------------------

### Output YAML Without License Text

Source: https://github.com/wyvernixtl/flicense-rs/blob/main/README.md

Generates a YAML report omitting the full license text.

```sh
flicense  ./license-fetcher/ -o -y
# - name: license-fetcher
#   version: '0.6.2'
#   authors:
#   - Adam McKellar <dev@mckellar.eu>
#   description: Fetch licenses of dependencies at build time and embed them into your program.
#   homepage: null
#   repository: https://github.com/WyvernIXTL/license-fetcher
#   license_identifier: BSL-1.0
#   license_text: null
#
# ...
```
Tokens:
Raw