Repositories

cargo-lichking

(mirrored on github)

cargo-lichking travis-badge downloads-badge release-badge license-badge

Automated license checking for rust. cargo lichking is a Cargo subcommand that checks licensing information for dependencies.

Liches are not lawyers, the information output from this tool is provided as a hint to where you may need to look for licensing issues but in no way represents legal advice or guarantees correctness. The tool relies at a minimum on package metadata containing correct licensing information, this is not guaranteed so for real license checking it's necessary to verify all dependencies manually.

Installation

To install simply run cargo install cargo-lichking; unless you're using a homebrew installed copy of openssl, then "simply" run:

OPENSSL_ROOT_DIR=`brew --prefix openssl` \
OPENSSL_LIB_DIR=`brew --prefix openssl`/lib \
OPENSSL_INCLUDE_DIR=`brew --prefix openssl`/include \
cargo install cargo-lichking

Usage

To get a list of all your (transitive) dependencies licenses run cargo lichking list. To check license compatibility based off this License Slide by David A. Wheeler run cargo lichking check.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.

Developing

If building on OS X with a homebrew installed copy of OpenSSL you'll need to specify where this is to enable building libssh2-sys. Use something like:

OPENSSL_ROOT_DIR=`brew --prefix openssl` \
OPENSSL_LIB_DIR=`brew --prefix openssl`/lib \
OPENSSL_INCLUDE_DIR=`brew --prefix openssl`/include \
cargo build

When running via cargo run you'll need to provide an initial lichking argument to simulate running as a cargo subcommand, e.g. cargo run -- lichking check.