{"id":15038826,"url":"https://github.com/mono0926/licenseplist","last_synced_at":"2026-05-14T04:03:23.598Z","repository":{"id":37336483,"uuid":"89676988","full_name":"mono0926/LicensePlist","owner":"mono0926","description":"A license list generator of all your dependencies for iOS applications","archived":false,"fork":false,"pushed_at":"2025-03-28T01:19:38.000Z","size":33470,"stargazers_count":2454,"open_issues_count":35,"forks_count":149,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-04-10T02:15:13.867Z","etag":null,"topics":["automation","cli","commandline","ios","license","license-management","licenses","productivity","settings","swift-package-manager","xcode"],"latest_commit_sha":null,"homepage":"https://www.slideshare.net/mono0926/licenseplist-a-license-list-generator-of-all-your-dependencies-for-ios-applications","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mono0926.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["mono0926"]}},"created_at":"2017-04-28T06:53:36.000Z","updated_at":"2025-04-08T14:35:05.000Z","dependencies_parsed_at":"2023-01-31T17:31:06.745Z","dependency_job_id":"80552aa0-0e31-4127-ac3e-bd383da31084","html_url":"https://github.com/mono0926/LicensePlist","commit_stats":{"total_commits":668,"total_committers":56,"mean_commits":"11.928571428571429","dds":"0.38622754491017963","last_synced_commit":"f3f802009c9f71ad46356adb453fcb57b8931ff9"},"previous_names":[],"tags_count":141,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mono0926%2FLicensePlist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mono0926%2FLicensePlist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mono0926%2FLicensePlist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mono0926%2FLicensePlist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mono0926","download_url":"https://codeload.github.com/mono0926/LicensePlist/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142904,"owners_count":21054671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cli","commandline","ios","license","license-management","licenses","productivity","settings","swift-package-manager","xcode"],"created_at":"2024-09-24T20:40:22.406Z","updated_at":"2026-05-14T04:03:18.566Z","avatar_url":"https://github.com/mono0926.png","language":"Swift","funding_links":["https://github.com/sponsors/mono0926","https://www.paypal.me/mono0926","https://www.patreon.com/licenseplist"],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"LicensePlist.png\" width=\"200\" height=\"200\" alt=\"LicensePlist Logo\"\u003e LicensePlist\n======================================\n\n![platforms](https://img.shields.io/badge/platforms-iOS-333333.svg)\n[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mono0926/NativePopup/master/LICENSE)\n[![Language: Swift 5.3](https://img.shields.io/badge/swift-5.3-4BC51D.svg?style=flat)](https://developer.apple.com/swift)\n[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)\n\n[![Lint](https://github.com/mono0926/LicensePlist/actions/workflows/lint.yml/badge.svg)](https://github.com/mono0926/LicensePlist/actions/workflows/lint.yml)\n[![Test](https://github.com/mono0926/LicensePlist/actions/workflows/test.yml/badge.svg)](https://github.com/mono0926/LicensePlist/actions/workflows/test.yml)\n\n`LicensePlist` is a command-line tool that automatically generates a Plist of all your dependencies, including files added manually(specified by [YAML config file](https://github.com/mono0926/LicensePlist/blob/master/Tests/LicensePlistTests/Resources/license_plist.yml)) or using `Carthage` or `CocoaPods`. All these licenses then show up in the Settings app.\n\n![Flow](Screenshots/flow.png)\n\n![Demo](https://github.com/mono0926/Resource/raw/master/LicensePlist/LicensePlist.gif)\n\n| App Setting Root          | License List              | License Detail              |\n| ------------------------- | ------------------------- | --------------------------- |\n| ![](Screenshots/root.png) | ![](Screenshots/list.png) | ![](Screenshots/detail.png) |\n\n## Installation\n\n\u003e **Warning**  \n\u003e SPM(Swift Package Manager) are not supported.\n\n### CocoaPods (Recommended)\n\n```\npod 'LicensePlist'\n# Installation path: `${PODS_ROOT}/LicensePlist/license-plist`\n```\n\n### Homebrew (Also Recommended)\n\n```sh\nbrew install licenseplist\n```\n\n### Mint (Also Recommended)\n```sh\nmint run mono0926/LicensePlist\n```\n\n### Xcode project - SPM\n\nIn Project Settings, on the tab \"Package Dependencies\", click \"+\" and add `https://github.com/mono0926/LicensePlist`.\n\nClick \"Add Package\" without selecting any package products.\n\n### Download the executable binary from [Releases](https://github.com/mono0926/LicensePlist/releases)\n\nDownload from [Releases](https://github.com/mono0926/LicensePlist/releases), then copy to `/usr/local/bin/license-plist` etc.\n\nOr you can also download the latest binary and install it with a one-liner.\n\n```sh\ncurl -fsSL https://raw.githubusercontent.com/mono0926/LicensePlist/master/install.sh | sh\n```\n\n### From Source\n\nClone the master branch of the repository, then run `make install`.\n\n```sh\ngit clone https://github.com/mono0926/LicensePlist.git\nmake install\n```\n\n## Usage\n\n1. When you are in the directory that contains your `Cartfile` or `Pods`, simply execute `license-plist`.\n2. `com.mono0926.LicensePlist.Output` directory will be generated.\n3. Move the files in the output directory into your app's `Settings.bundle`.\n    - [Settings.bundle's sample is here](Settings.bundle.zip)\n    - The point is to [specify `com.mono0926.LicensePlist` as license list file on your `Root.plist`](https://github.com/mono0926/LicensePlist/blob/master/Settings.bundle/Root.plist#L19).\n\n```\nSettings.bundle\n├── Root.plist\n├── com.mono0926.LicensePlist\n│   ├── APIKit.plist\n│   ├── Alamofire.plist\n│   └── EditDistance.plist\n├── com.mono0926.LicensePlist.plist\n├── en.lproj\n│   └── Root.strings\n└── ja.lproj\n    └── Root.strings\n```\n\n### Options\n\nYou can see options by `license-plist --help`.\n\n#### `--cartfile-path`\n\n- Default: `Cartfile`\n\n#### `--mintfile-path`\n\n- Default: `Mintfile`\n\n#### `--nestfile-path`\n\n- Default: `nestfile.yaml`\n\n#### `--pods-path`\n\n- Default: `Pods`\n\n#### `--package-path`\n\n- Default: `Package.swift`\n- `LicensePlist` tries to find `YourProjectName.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved` and `YourProjectName.xcworkspace/xcshareddata/swiftpm/Package.resolved`, then uses new one.\n\n#### `--package-paths`\n\n- Support for multiple `Package.swift`\n- Example: `license-plist --package-paths /path/to/package1/Package.swift /path/to/package2/Package.swift`\n\n#### `--package-sources-path`\n\n- Default: None.\n- The directory with cloned Swift package sources. If specified `LicensePlist` uses cloned files instead of GitHub API. For more information, see parameter `-clonedSourcePackagesDirPath` of [xcodebuild](https://developer.apple.com/library/archive/technotes/tn2339/_index.html).\n- Example: `license-plist --package-sources-path ./SourcePackages`\n\n#### `--xcodeproj-path`\n\n- Default: `\"*.xcodeproj\"`\n- By specifiying the path to the `.xcodeproj` `LicensePlist` will attempt to load the `Package.resolved` from that Xcode project. If you specify `somedir/*.xcodeproj` then `LicensePlist` will load from the first `xcodeproj` it finds in `somedir`.\n\n#### `--xcworkspace-path`\n\n- Default: `\"*.xcworkspace\"`\n- By specifying the path to the `.xcworkspace` `LicensePlist` will load the `Package.resolved` from that Xcode workspace. If you specify `somedir/*.xcworkspace` then `LicensePlist` will load from the first `xcworkspace` it finds in `somedir`.\n- `--xcworkspace-path` supersedes any provided `--xcodeproj-path`.\n\n#### `--output-path`\n\n- Default: `com.mono0926.LicensePlist.Output`\n- Recommended: `--output-path YOUR_PRODUCT_DIR/Settings.bundle`\n\n#### `--github-token`\n\n- Default: None.\n- LicensePlist uses GitHub API, so sometimes API limit errors occur. You can avoid those errors by specifying a GitHub token.\n- [You can generate a token here](https://github.com/settings/tokens/new)\n    - `repo` scope is needed.\n- You can also pass the GitHub token via the `LICENSE_PLIST_GITHUB_TOKEN` environment variable.\n\n#### `--config-path`\n\n- Default: `license_plist.yml`\n- You can specify GitHub libraries(introduced by hand) and excluded libraries\n    - [Example is here](https://github.com/mono0926/LicensePlist/blob/master/Tests/LicensePlistTests/Resources/license_plist.yml)\n    - See [Configuration](#Configuration) for more information\n\n#### `--prefix`\n\n- Default: `com.mono0926.LicensePlist`\n- You can specify output file names instead of default one.\n\n#### `--html-path`\n\n- Default: None.\n- If this path is specified, a html acknowledgements file will be generated.\n  - [Example is here](https://github.com/mono0926/LicensePlist/blob/master/Assets/acknowledgements.html)\n\n#### `--markdown-path`\n\n- Default: None.\n- If this path is specified, a markdown acknowledgements file will be generated.\n  - [Example is here](https://github.com/mono0926/LicensePlist/blob/master/Assets/acknowledgements.md)\n\n#### `--csv-path`\n\n- Default: None.\n- If this path is specified, a csv acknowledgements file will be generated.\n  - [Example is here](https://github.com/mono0926/LicensePlist/blob/master/Assets/acknowledgements.csv)\n\n#### `--license-file-names`\n\n- Default: `LICENSE, LICENSE.*`.\n- License file name variants for cloned Swift packages. \n  - Case insensitive. \n  - Supports any non-empty path extensions if `FILENAME.*` is specified.\n  - Used only in combination with `--package-sources-path`.\n\n#### `--force`\n\n- Default: false\n- `LicensePlist` saves latest result summary, so if there are no changes, the program interrupts.\n    - In this case, **execution time is less than 100ms for the most case**, so **you can run `LicensePlist` at `Run Script Phase` every time** 🎉\n- You can run all the way anyway, by using `--force` flag.\n\n#### `--add-version-numbers`\n\n- Default: false\n- When the library name is `SomeLibrary`, by adding `--add-version-numbers` flag, the name will be changed to `SomeLibrary (X.Y.Z)`.\n    - `X.Y.Z` is parsed from CocoaPods and Cartfile information, and GitHub libraries specified at [Config YAML](https://github.com/mono0926/LicensePlist/blob/master/Tests/LicensePlistTests/Resources/license_plist.yml) also support this flag.\n\n\u003cimg src=\"Screenshots/list_version.png\" width=\"320\" height=\"568\" alt=\"License list with versions\"\u003e\n\n#### `--add-sources`\n\n- Default: false\n- 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.\n\n#### `--suppress-opening-directory`\n\n- Default: false\n- Only when the files are created or updated, the terminal or the finder opens. By adding `--suppress-opening-directory` flag, this behavior is suppressed.\n- Automatically enabled if `--sandbox-mode` is specified.\n\n#### `--single-page`\n\n- Default: false\n- All licenses are listed on a single page, not separated pages.\n\n#### `--fail-if-missing-license`\n\n- Default: false\n- If there is even one package for which a license cannot be found, LicensePlist returns exit code 1.\n\n#### `--silence-mode` / `--verbose`\n\n- By adding the `--silence-mode` flag, the logger's output will not print.\n- The logger's output will be more detailed than the average log level by adding the `--verbose` flag.\n- LicencePlist uses the latter option if you simultaneously set the `--silence-mode` option and the `--verbose` option.\n- Default: average log level\n\n#### `--no-color` / `--color`\n\n- The logger's output is printed in monochrome by adding the `--no-color` flag. If any escape characters in CI/CD log bother you, the `--no-color` option will help.\n- By adding the `--color` flag, LicensePlist will always print the logger's output in color.\n- LicencePlist uses the latter option if you simultaneously set the `--no-color` option and the `--color` option.\n- If neither option is specified, LicensePlist will look for the `NO_COLOR` environment variable. If you set the `NO_COLOR` environment variable to `\"1\"`, LicensePlist runs without colors.\n- Default: auto - LicensePlist decides its color mode depending on the terminal type.\n\n#### `--sandbox-mode` / `--no-sandbox-mode`\n\n- Default: false\n- Enables or disables the \"sandbox\" mode.\n- 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-path` must be specified.\n\n\n### Integrate into build - run script\n\nAdd a `Run Script Phase` to `Build Phases`:\n\n```sh\nif [ $CONFIGURATION = \"Debug\" ]; then\ncd $SRCROOT\n/usr/local/bin/license-plist --output-path $PRODUCT_NAME/Settings.bundle --github-token YOUR_GITHUB_TOKEN\nfi\n```\n\n![Run Script Phase](Screenshots/run_script_phase.png)\n\nAlternatively, if you've installed LicensePlist via CocoaPods the script should look like this:\n\n```sh\nif [ $CONFIGURATION = \"Debug\" ]; then\n${PODS_ROOT}/LicensePlist/license-plist --output-path $PRODUCT_NAME/Settings.bundle --github-token YOUR_GITHUB_TOKEN\nfi\n```\n\n### Integrate into build - build tool plugin\n\n_LicensePlist build tool plugins requires [Swift package installation](#xcode-project---spm)._\n\n![Choose package plugins](Screenshots/choose_plugin.png)\n\nSelect your target, on the tab \"Build Phases\", in the section \"Run Build Tool Plug-ins\", click \"+\" and add `LicensePlistBuildTool`.\n\n![Run build tool plug-ins](Screenshots/run_build_tool_plugins.png)\n\nIn the case of using the build tool plugin, define all the settings in `license_plist.yml` at the root of your project.\n\n`license_plist.yml` example:\n```yml\noptions:\n  xcworkspacePath: \"*.xcworkspace\"\n  prefix: Acknowledgements\n  singlePage: true\n```\n\n**Important**: to process Swift Package licenses, the config must include one of the following parameters:\n- `xcworkspacePath`,\n- `xcodeprojPath`,\n- `packagePaths`.\n\n_Note: `outputPath` and `packageSourcesPath` config parameters are ignored by the build tool plugin._\n\nSee the [configuration](#configuration) section for more information.\n\nIf you need to put license files to `Settings.bundle` or any other specific place add the following script to build phases:\n```bash\necho \"Will copy acknowledgements\"\nACKNOWLEDGEMENTS_DIR=${BUILT_PRODUCTS_DIR}/${CONTENTS_FOLDER_PATH}/com.mono0926.LicensePlist.Output\nDESTINATION_PATH=${BUILT_PRODUCTS_DIR}/${CONTENTS_FOLDER_PATH}/Settings.bundle/\ncp -r \"${ACKNOWLEDGEMENTS_DIR}\"/* \"${DESTINATION_PATH}\"\nrm -rf \"${ACKNOWLEDGEMENTS_DIR}\"\n```\n\nOr in project contextual menu click \"AddAcknowledgementsCopyScriptCommand\" and select application target to create the build phase automatically.\n\n![AddAcknowledgementsCopyScriptCommand](Screenshots/copy_script_command.png)\n\nBuild the app. At the first run, Xcode asks a permission to run the plugin. Click \"Trust \u0026 Enable All\"\n\n![Trust \u0026 Enable All](Screenshots/trust_and_enable.png)\n\nFor unattended use (e.g. on CI), you can disable the package validation dialog by\n\n* individually passing `-skipPackagePluginValidation` to `xcodebuild` or\n* globally setting `defaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YES` \n  for that user.\n\n_Note: This implicitly trusts all Xcode package plugins and bypasses Xcode's package validation\n       dialogs, which has security implications._\n\n### Contextual menu command\n\n_LicensePlist command requires [Swift package installation](#xcode-project---spm)._\n\nIn the project contextual menu click \"GenerateAcknowledgementsCommand\".\n\n![Generate Acknowledgements menu command in Xcode](Screenshots/generate_acknowledgements_menu.png)\n\nThe command dialog allows to specify [command line arguments](#options). Since Xcode doesn't save the arguments for future use, it's recommended to use a [configuration file](#configuration).\n\nClick \"Run\" to run LicensePlist.\n\n![Generate Acknowledgements command dialog in Xcode](Screenshots/generate_acknowledgements_command.png)\n\nClick \"Allow Command to Change files\". This action provides LicensePlist write access to your project directory.\n\n\"Don't ask again\" option prevents showing this dialog in the future.\n\n![Allow command to change files dialog in Xcode](Screenshots/allow_command_to_change_files.png)\n\n_Note: `--package-sources-path` option and `packageSourcesPath` config parameter are ignored by the command plugin._\n\n## Configuration\n\n### General options\n\nThe main parameters from the [Options](#Options) can be defined in the configuration file.\n\nAll the parameters are optional.\n\nThe tool uses the command line value if both the command line and the config specify values for the same attribute.\n\n#### Example\n\n```yml\noptions:\n  outputPath: \"./com.mono0926.LicensePlist.Output\"\n  cartfilePath: Cartfile\n  mintfilePath: Mintfile\n  nestfilePath: nestfile.yaml\n  podsPath: Pods\n  packagePaths:\n    - Package.swift\n  packageSourcesPath: \"./SourcePackages\"\n  xcodeprojPath: \"*.xcodeproj\"\n  xcworkspacePath: \"*.xcworkspace\"\n  prefix: com.mono0926.LicensePlist\n  gitHubToken: YOUR_GITHUB_TOKEN\n  htmlPath: acknowledgements.html\n  markdownPath: acknowledgements.md\n  licenseFileNames:\n    - LICENSE\n    - LICENSE.*\n  force: false\n  addVersionNumbers: false\n  suppressOpeningDirectory: false\n  singlePage: false\n  failIfMissingLicense: false\n  addSources: false\n  sandboxMode: false\n```\n\n### Manual GitHub source\n\nA GitHub source can be explicitly defined to include the license in the scenario where it can't be inferred from your dependency files.\n\n#### Examples\n\n```yml\ngithub:\n  - owner: mono0926\n    name: LicensePlist\n    version: 1.2.0\n```\n\n### Manual License Body\n\nIf 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.\nThe license text can also be read from a local file, to keep the config file clean.\n\n#### Examples\n\nLicense body directly in the config file:\n\n```yml\nmanual:\n  - source: https://webrtc.googlesource.com/src\n    name: WebRTC\n    version: M61\n    body: |-\n      Copyright (c) 2011, The WebRTC project authors. All rights reserved.\n      ...\n      ...\n      ...\n```\n\nLicense body in local file:\n\n```yml\nmanual:\n  - name: \"Dummy License File\"\n    file: \"dummy_license.txt\"\n```\n\n### Excludes\n\nExcludes can be defined to exclude matching libraries from the final output.\nAn exclude is a dictionary containing any combination of `name`, `source`, `owner`, or `licenseType`.\n\nWhen using the dictionary format:\n\n- The exclusion rule is only applied if _all_ properties match for a dependency. eg, `(name: LicensePlist) AND (owner: mono0926)`\n- Any property can be either a string or a regular expression. \n\n#### Examples\n\nExclude a package by name:\n\n```yml\nexclude:\n  - name: LicensePlist\n```\n\nExclude packages using a specific license:\n\n```yml\nexclude:\n  - licenseType: \"Apache 2.0\"\n```\n\nExclude packages using any matching licenses:\n\n```yml\nexclude:\n  - licenseType: /BSD/\n```\n\nExclude packages from a specific github owner:\n\n```yml\nexclude:\n  - owner: mycompany\n```\n\nExclude packages from a specific github owner containing matching licenses:\n\n```yml\nexclude:\n  - owner: mycompany\n    licenseType: /^(?!.*MIT).*$/ # this regex excludes packages that do NOT use the MIT license\n``` \n\nExclude a package from a specific github owner and repo:\n\n```yml\nexclude:\n  - owner: mycompany\n    name: private-repo\n```\n\n### Rename\n\nIf 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.\n\n#### Examples\n\n```yml\nrename:\n  LicensePlist: License Plist # Rename LicensePlist to \"License Plist\"\n  WebRTC: Web RTC # Rename WebRTC to \"Web RTC\" (which is faulty, but used for test)\n```\n\n## Q\u0026A\n\n### How to generate Xcode project?\n\nExecute `swift package generate-xcodeproj` or `make xcode`.\n\n---\n\n## Related Articles\n\n- [LicensePlist というiOSアプリ利用ライブラリのライセンス一覧生成するツールを作りました – Swift・iOSコラム – Medium](https://medium.com/swift-column/license-plist-c0363a008c67)\n- [Swift Package Manager(SwiftPM)で作ったコマンドラインツールをHomebrewに登録する方法 - Qiita](http://qiita.com/mono0926/items/c32c008384df40bf4e41)\n\n\n---\n\n## Stargazers over time\n\n[![Stargazers over time](https://starcharts.herokuapp.com/mono0926/LicensePlist.svg)](https://starcharts.herokuapp.com/mono0926/LicensePlist)\n\n---\n\n## 寄付(Donation)\n\nDonations are welcome if you like LicensePlist🤗\n\n- [PayPal.Me](https://www.paypal.me/mono0926)\n  - Transfer commission will be charged (40 yen + 3.6%)\n- [mono is creating LicensePlist | Patreon](https://www.patreon.com/licenseplist)\n- [Amazonギフト券- Eメールタイプ](https://www.amazon.co.jp/exec/obidos/ASIN/B004N3APGO/mono0926-22/)\n  - メールアドレス: mono0926@gmail.com\n- [ほしい物リスト](https://www.amazon.co.jp/gp/registry/wishlist/3P51MRDW2WBN6/ref=nav_wishlist_lists_1)\n\n\n### Send Money by [ウォレットアプリ Kyash](https://kyash.co/)\n\n![Kyash](Screenshots/kyash.jpeg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmono0926%2Flicenseplist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmono0926%2Flicenseplist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmono0926%2Flicenseplist/lists"}