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 |
---|---|---|
![]() |
![]() |
![]() |
pod 'LicensePlist'
# Installation path: `${PODS_ROOT}/LicensePlist/license-plist`
$ brew install mono0926/license-plist/license-plist
Or
$ brew tap mono0926/license-plist
$ brew install license-plist
$ mint run mono0926/LicensePlist
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 | sh
Clone 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
Cartfile
orPods
, simply executelicense-plist
. com.mono0926.LicensePlist.Output
directory 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
LicensePlist
tries to findYourProjectName.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
andYourProjectName.xcworkspace/xcshareddata/swiftpm/Package.resolved
, then uses new one.
- Default:
"*.xcodeproj"
- By specifiying the path to the
.xcodeproj
LicensePlist
will attempt to load thePackage.resolved
from that Xcode project. If you specifysomedir/*.xcodeproj
thenLicensePlist
will load from the firstxcodeproj
it finds insomedir
.
- Default:
"*.xcworkspace"
- By specifying the path to the
.xcworkspace
LicensePlist
will load thePackage.resolved
from that Xcode workspace. If you specifysomedir/*.xcworkspace
thenLicensePlist
will load from the firstxcworkspace
it finds insomedir
. --xcworkspace-path
supersedes 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 error occures. You can avoid it by using github-token.- You can generate token here
repo
scope is needed.
- Default:
license_plist.yml
- You can specify GitHub libraries(introduced by hand) and excluded libraries
- 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: false
LicensePlist
saves 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
LicensePlist
atRun Script Phase
every 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
--force
flag.
- Default: false
- When the library name is
SomeLibrary
, by adding--add-version-numbers
flag, the name will be changed toSomeLibrary (X.Y.Z)
.X.Y.Z
is 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-directory
flag, this behavior is suppressed.
- 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.
- Default: false
- By adding
--silence-mode
flag, the output of the logger will not print.
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
fi
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メールタイプ
- メールアドレス: [email protected]
- ほしい物リスト