LicensePlist is a command-line tool that automatically generates a Plist of all your dependencies, including files added manually(specified by YAML config file) or using Carthage or CocoaPods. All these licenses then show up in the Settings app.
| App Setting Root | License List | License Detail |
|---|---|---|
 |
 |
 |
Warning
SPM(Swift Package Manager) are not supported.
pod 'LicensePlist'
# Installation path: `${PODS_ROOT}/LicensePlist/license-plist`
brew install licenseplistmint run mono0926/LicensePlistIn Project Settings, on the tab "Package Dependencies", click "+" and add https://github.com/mono0926/LicensePlist.
Click "Add Package" without selecting any package products.
Download the executable binary from Releases
Download from Releases, then copy to /usr/local/bin/license-plist etc.
Or you can also download the latest binary and install it with a one-liner.
curl -fsSL https://raw.githubusercontent.com/mono0926/LicensePlist/master/install.sh | shClone the master branch of the repository, then run make install.
git clone https://github.com/mono0926/LicensePlist.git
make install- When you are in the directory that contains your
CartfileorPods, simply executelicense-plist. com.mono0926.LicensePlist.Outputdirectory will be generated.- Move the files in the output directory into your app's
Settings.bundle.
Settings.bundle
├── Root.plist
├── com.mono0926.LicensePlist
│ ├── APIKit.plist
│ ├── Alamofire.plist
│ └── EditDistance.plist
├── com.mono0926.LicensePlist.plist
├── en.lproj
│ └── Root.strings
└── ja.lproj
└── Root.strings
You can see options by license-plist --help.
- Default:
Cartfile
- Default:
Mintfile
- Default:
Pods
- Default:
Package.swift LicensePlisttries to findYourProjectName.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolvedandYourProjectName.xcworkspace/xcshareddata/swiftpm/Package.resolved, then uses new one.
- Support for multiple
Package.swift - Example:
license-plist --package-paths /path/to/package1/Package.swift /path/to/package2/Package.swift
- Default: None.
- The directory with cloned Swift package sources. If specified
LicensePlistuses cloned files instead of GitHub API. For more information, see parameter-clonedSourcePackagesDirPathof xcodebuild. - Example:
license-plist --package-sources-path ./SourcePackages
- Default:
"*.xcodeproj" - By specifiying the path to the
.xcodeprojLicensePlistwill attempt to load thePackage.resolvedfrom that Xcode project. If you specifysomedir/*.xcodeprojthenLicensePlistwill load from the firstxcodeprojit finds insomedir.
- Default:
"*.xcworkspace" - By specifying the path to the
.xcworkspaceLicensePlistwill load thePackage.resolvedfrom that Xcode workspace. If you specifysomedir/*.xcworkspacethenLicensePlistwill load from the firstxcworkspaceit finds insomedir. --xcworkspace-pathsupersedes any provided--xcodeproj-path.
- Default:
com.mono0926.LicensePlist.Output - Recommended:
--output-path YOUR_PRODUCT_DIR/Settings.bundle
- Default: None.
- LicensePlist uses GitHub API, so sometimes API limit errors occur. You can avoid those errors by specifying a GitHub token.
- You can generate a token here
reposcope is needed.
- You can also pass the GitHub token via the
LICENSE_PLIST_GITHUB_TOKENenvironment variable.
- Default:
license_plist.yml - You can specify GitHub libraries(introduced by hand) and excluded libraries
- Example is here
- See Configuration for more information
- Default:
com.mono0926.LicensePlist - You can specify output file names instead of default one.
- Default: None.
- If this path is specified, a html acknowledgements file will be generated.
- Default: None.
- If this path is specified, a markdown acknowledgements file will be generated.
- Default: None.
- If this path is specified, a csv acknowledgements file will be generated.
- Default:
LICENSE, LICENSE.*. - License file name variants for cloned Swift packages.
- Case insensitive.
- Supports any non-empty path extensions if
FILENAME.*is specified. - Used only in combination with
--package-sources-path.
- Default: false
LicensePlistsaves latest result summary, so if there are no changes, the program interrupts.- In this case, execution time is less than 100ms for the most case, so you can run
LicensePlistatRun Script Phaseevery time 🎉
- In this case, execution time is less than 100ms for the most case, so you can run
- You can run all the way anyway, by using
--forceflag.
- Default: false
- When the library name is
SomeLibrary, by adding--add-version-numbersflag, the name will be changed toSomeLibrary (X.Y.Z).X.Y.Zis parsed from CocoaPods and Cartfile information, and GitHub libraries specified at Config YAML also support this flag.
- Default: false
- Adds the source of the library to the output if there is one. The source for GitHub and CocoaPods libraries is generated. Manual libraries use the optional source field.
- Default: false
- Only when the files are created or updated, the terminal or the finder opens. By adding
--suppress-opening-directoryflag, this behavior is suppressed. - Automatically enabled if
--sandbox-modeis specified.
- Default: false
- All licenses are listed on a single page, not separated pages.
- Default: false
- If there is even one package for which a license cannot be found, LicensePlist returns exit code 1.
- By adding the
--silence-modeflag, the logger's output will not print. - The logger's output will be more detailed than the average log level by adding the
--verboseflag. - LicencePlist uses the latter option if you simultaneously set the
--silence-modeoption and the--verboseoption. - Default: average log level
- The logger's output is printed in monochrome by adding the
--no-colorflag. If any escape characters in CI/CD log bother you, the--no-coloroption will help. - By adding the
--colorflag, LicensePlist will always print the logger's output in color. - LicencePlist uses the latter option if you simultaneously set the
--no-coloroption and the--coloroption. - If neither option is specified, LicensePlist will look for the
NO_COLORenvironment variable. If you set theNO_COLORenvironment variable to"1", LicensePlist runs without colors. - Default: auto - LicensePlist decides its color mode depending on the terminal type.
- Default: false
- Enables or disables the "sandbox" mode.
- In the sandbox mode, LicensePlist avoids network requests. That means Swift package licenses can not be fetched with GitHub API. To parse Swift package licenses
--package-sources-pathmust be specified.
Add a Run Script Phase to Build Phases:
if [ $CONFIGURATION = "Debug" ]; then
/usr/local/bin/license-plist --output-path $PRODUCT_NAME/Settings.bundle --github-token YOUR_GITHUB_TOKEN
fi
Alternatively, if you've installed LicensePlist via CocoaPods the script should look like this:
if [ $CONFIGURATION = "Debug" ]; then
${PODS_ROOT}/LicensePlist/license-plist --output-path $PRODUCT_NAME/Settings.bundle --github-token YOUR_GITHUB_TOKEN
fiLicensePlist build tool plugins requires Swift package installation.
Select your target, on the tab "Build Phases", in the section "Run Build Tool Plug-ins", click "+" and add LicensePlistBuildTool.
In the case of using the build tool plugin, define all the settings in license_plist.yml at the root of your project.
license_plist.yml example:
options:
xcworkspacePath: "*.xcworkspace"
prefix: Acknowledgements
singlePage: trueImportant: to process Swift Package licenses, the config must include one of the following parameters:
xcworkspacePath,xcodeprojPath,packagePaths.
Note: outputPath and packageSourcesPath config parameters are ignored by the build tool plugin.
See the configuration section for more information.
If you need to put license files to Settings.bundle or any other specific place add the following script to build phases:
echo "Will copy acknowledgements"
ACKNOWLEDGEMENTS_DIR=${BUILT_PRODUCTS_DIR}/${CONTENTS_FOLDER_PATH}/com.mono0926.LicensePlist.Output
DESTINATION_PATH=${BUILT_PRODUCTS_DIR}/${CONTENTS_FOLDER_PATH}/Settings.bundle/
cp -r "${ACKNOWLEDGEMENTS_DIR}"/* "${DESTINATION_PATH}"
rm -rf "${ACKNOWLEDGEMENTS_DIR}"Or in project contextual menu click "AddAcknowledgementsCopyScriptCommand" and select application target to create the build phase automatically.
Build the app. At the first run, Xcode asks a permission to run the plugin. Click "Trust & Enable All"
For unattended use (e.g. on CI), you can disable the package validation dialog by
- individually passing
-skipPackagePluginValidationtoxcodebuildor - globally setting
defaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YESfor that user.
Note: This implicitly trusts all Xcode package plugins and bypasses Xcode's package validation dialogs, which has security implications.
LicensePlist command requires Swift package installation.
In the project contextual menu click "GenerateAcknowledgementsCommand".
The command dialog allows to specify command line arguments. Since Xcode doesn't save the arguments for future use, it's recommended to use a configuration file.
Click "Run" to run LicensePlist.
Click "Allow Command to Change files". This action provides LicensePlist write access to your project directory.
"Don't ask again" option prevents showing this dialog in the future.
Note: --package-sources-path option and packageSourcesPath config parameter are ignored by the command plugin.
The main parameters from the Options can be defined in the configuration file.
All the parameters are optional.
The tool uses the command line value if both the command line and the config specify values for the same attribute.
options:
outputPath: "./com.mono0926.LicensePlist.Output"
cartfilePath: Cartfile
mintfilePath: Mintfile
podsPath: Pods
packagePaths:
- Package.swift
packageSourcesPath: "./SourcePackages"
xcodeprojPath: "*.xcodeproj"
xcworkspacePath: "*.xcworkspace"
prefix: com.mono0926.LicensePlist
gitHubToken: YOUR_GITHUB_TOKEN
htmlPath: acknowledgements.html
markdownPath: acknowledgements.md
licenseFileNames:
- LICENSE
- LICENSE.*
force: false
addVersionNumbers: false
suppressOpeningDirectory: false
singlePage: false
failIfMissingLicense: false
addSources: false
sandboxMode: falseA GitHub source can be explicitly defined to include the license in the scenario where it can't be inferred from your dependency files.
github:
- owner: mono0926
name: LicensePlist
version: 1.2.0If you need to include a license that isn't available on GitHub, you can place the license text in the config file to be included in the output. The license text can also be read from a local file, to keep the config file clean.
License body directly in the config file:
manual:
- source: https://webrtc.googlesource.com/src
name: WebRTC
version: M61
body: |-
Copyright (c) 2011, The WebRTC project authors. All rights reserved.
...
...
...License body in local file:
manual:
- name: "Dummy License File"
file: "dummy_license.txt"Excludes can be defined to exclude matching libraries from the final output.
An exclude is a dictionary containing any combination of name, source, owner, or licenseType.
When using the dictionary format:
- The exclusion rule is only applied if all properties match for a dependency. eg,
(name: LicensePlist) AND (owner: mono0926) - Any property can be either a string or a regular expression.
Exclude a package by name:
exclude:
- name: LicensePlistExclude packages using a specific license:
exclude:
- licenseType: "Apache 2.0"Exclude packages using any matching licenses:
exclude:
- licenseType: /BSD/Exclude packages from a specific github owner:
exclude:
- owner: mycompanyExclude packages from a specific github owner containing matching licenses:
exclude:
- owner: mycompany
licenseType: /^(?!.*MIT).*$/ # this regex excludes packages that do NOT use the MIT licenseExclude a package from a specific github owner and repo:
exclude:
- owner: mycompany
name: private-repoIf a library name is unsuitable for the output bundle, you can explicitly rename it. This can be used when a library name is too vague, or if more human-readable names are needed.
rename:
LicensePlist: License Plist # Rename LicensePlist to "License Plist"
WebRTC: Web RTC # Rename WebRTC to "Web RTC" (which is faulty, but used for test)Execute swift package generate-xcodeproj or make xcode.
- LicensePlist というiOSアプリ利用ライブラリのライセンス一覧生成するツールを作りました – Swift・iOSコラム – Medium
- Swift Package Manager(SwiftPM)で作ったコマンドラインツールをHomebrewに登録する方法 - Qiita
Donations are welcome if you like LicensePlist🤗
- PayPal.Me
- Transfer commission will be charged (40 yen + 3.6%)
- mono is creating LicensePlist | Patreon
- Amazonギフト券- Eメールタイプ
- メールアドレス: mono0926@gmail.com
- ほしい物リスト
Send Money by ウォレットアプリ Kyash
