licensed/README.md

# Licensed

Licensed caches the licenses of dependencies and checks their status.

Licensed is available as a Ruby gem for Ruby environments, and as a self-contained executable for non-Ruby environments.

Licensed is **not** a complete open source license compliance solution. Please understand the important [disclaimer](#disclaimer) below to make appropriate use of Licensed.

## Current Status

![Build status](https://github.com/github/licensed/workflows/test/badge.svg)

Licensed is in active development and currently used at GitHub.  See the [open issues](https://github.com/github/licensed/issues) for a list of potential work.

## Licensed v2

Licensed v2 includes many internal changes intended to make licensed more extensible and easier to update in the future.  While not too much has changed externally, v2 is incompatible with configuration files and cached records from previous versions.  Fortunately, migrating is easy using the `licensed migrate` command.

See [CHANGELOG.md](./CHANGELOG.md) for more details on whats changed.
See the [migration documentation](./docs/migrating_to_newer_versions.md) for more info on migrating to v2, or run `licensed help migrate`.

## Installation

### With a Gemfile

Add this line to your application's Gemfile:

```ruby
gem 'licensed', :group => 'development'
```

And then execute:

```bash
$ bundle
```

### As an executable

Download a package from GitHub and extract the executable.  Executable packages are available for each release starting with version 1.2.0.

```bash
$ curl -sSL https://github.com/github/licensed/releases/download/<version>/licensed-<version>-<os>-x64.tar.gz > licensed.tar.gz
$ tar -xzf licensed.tar.gz
$ rm -f licensed.tar.gz
$ ./licensed list
```

For system wide usage, install licensed to a location on `$PATH`, e.g. `/usr/local/bin`.

#### Dependencies

Licensed uses the the `libgit2` bindings for Ruby provided by `rugged`. `rugged` has its own dependencies - `cmake` and `pkg-config` - which you may need to install before you can install Licensed.

For example, on macOS with Homebrew: `brew install cmake pkg-config` and on Ubuntu: `apt-get install cmake pkg-config`.

## Usage

- `licensed list`: Output enumerated dependencies only.
- `licensed cache`: Cache licenses and metadata.
- `licensed status`: Check status of dependencies' cached licenses. For example:
- `licensed version`: Show current installed version of Licensed. Aliases: `-v|--version`

See the [commands documentation](./docs/commands.md) for additional documentation, or run `licensed -h` to see all of the current available commands.

### Configuration

All commands, except `version`, accept a `-c|--config` option to specify a path to a configuration file or directory.

If a directory is specified, `licensed` will look in that directory for a file named (in order of preference):
1. `.licensed.yml`
2. `.licensed.yaml`
3. `.licensed.json`

If the option is not specified, the value will be set to the current directory.

See the [configuration file documentation](./docs/configuration.md) for more details on the configuration format.

### Sources

Dependencies will be automatically detected for all of the following sources by default.
1. [Bower](./docs/sources/bower.md)
1. [Bundler](./docs/sources/bundler.md)
1. [Cabal](./docs/sources/cabal.md)
1. [Composer](./docs/sources/composer.md)
1. [Go](./docs/sources/go.md)
1. [Go Dep (dep)](./docs/sources/dep.md)
1. [Manifest lists (manifests)](./docs/sources/manifests.md)
1. [NPM](./docs/sources/npm.md)
1. [Pip](./docs/sources/pip.md)
1. [Pipenv](./docs/sources/pipenv.md)
1. [Git Submodules (git_submodule)](./docs/sources/git_submodule.md)

You can disable any of them in the configuration file:

```yml
sources:
  bundler: false
  npm: false
  bower: false
  cabal: false
```

## Development

To get started after checking out the repo, run
1. `script/bootstrap` to install dependencies
2. `script/setup` to setup test fixtures.
  - `script/setup -f` will force a clean test fixture environment
3. `script/cibuild` to run the tests.

You can also run `script/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

#### Adding sources

When adding new dependency sources, ensure that `script/bootstrap` scripting and tests are only run if the required tooling is available on the development machine.

* See `script/bootstrap` for examples of gating scripting based on whether tooling executables are found.
* Use `Licensed::Shell.tool_available?` when writing test files to gate running a test suite when tooling executables aren't available.
```ruby
if Licensed::Shell.tool_available?('bundle')
  describe Licensed::Source::Bundler do
    ...
  end
end
```

See the [documentation on adding new sources](./docs/adding_a_new_source.md) for more information.

#### Adding Commands

See the [documentation on commands](./docs/commands.md) for information about adding a new CLI command.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/github/licensed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.  See [CONTRIBUTING](CONTRIBUTING.md) for more details.

## Disclaimer

Licensed is **not** a complete open source license compliance solution. Like any bug, licensing issues are far cheaper to fix if found early. Licensed is intended to provide automation around documenting the licenses of dependencies and whether they  are configured to be allowed by a user of licensed, in other words, to surface the most obvious licensing issues early.

Licensed is not a substitute for human review of each dependency for licensing or any other issues. It is not the goal of Licensed or GitHub, Inc. to provide legal advice about licensing or any other issues. If you have any questions regarding licensing compliance for your code or any other legal issues relating to it, it’s up to you to do further research or consult with a professional.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).