Library and various tools for working with project licenses.
Install the latest pre-built binary from the Releases page.
Alternatively, place the following code in your Makefile:
LICENSEI_VERSION = 0.8.0
bin/licensei: bin/licensei-${LICENSEI_VERSION}
@ln -sf licensei-${LICENSEI_VERSION} bin/licensei
bin/licensei-${LICENSEI_VERSION}:
@mkdir -p bin
curl -sfL https://git.io/licensei | bash -s v${LICENSEI_VERSION}
@mv bin/licensei $@Usage:
licensei [command]
Available Commands:
cache Cache licenses of dependencies in the project
check Check licenses of dependencies in the project
header Check license header of files
help Help about any command
list List licenses of dependencies in the project
Flags:
--config string config file (default is $PWD/.licensei.yaml)
-h, --help help for licensei
Use "licensei [command] --help" for more information about a command.
See an example integration into CircleCI here.
Place the following content into .licensei.toml.
approved = [
"mit",
"apache-2.0",
"bsd-3-clause",
"bsd-2-clause",
"mpl-2.0",
]
ignored = [
"github.com/aliyun/aliyun-oss-go-sdk",
"github.com/ghodss/yaml",
"github.com/gogo/protobuf",
"github.com/golang/protobuf",
"github.com/stretchr/testify",
"github.com/davecgh/go-spew", # ISC license
"github.com/howeyc/gopass", # ISC license
"github.com/oracle/oci-go-sdk", # UPL-1.0
]
[header]
ignorePaths = ["vendor", "client", ".gen"]
ignoreFiles = ["mock_*.go", "*_gen.go"]
template = """// Copyright © :YEAR: OWNER
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License."""Licensei uses Github to lookup licenses for most of the packages. The used parts of GitHub API does not require authentication, but it's easy to get rate limited, so it is recommended to configure a personal access token in your environment:
export GITHUB_TOKEN=xyzThe project uses Go Modules, so the minimum Go version is 1.11.4.
When all coding and testing is done, please run the test suite:
$ make checkThe MIT License (MIT). Please see License File for more information.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent