The Swift Package Index logo.Swift Package Index

Add a Package

Anyone can add a package to the Swift Package Index. Every package indexed by the site comes from a list of package repository URLs stored in a publicly available JSON file. To add a package to the index, add a URL to a package git repository to that file.

Please feel free to submit your own, or other people's repositories to this list. There are a few requirements, but they aren't onerous.

The easiest way to validate that packages meet the requirements is to run the validation tool included in this repository. Fork this repository and clone your fork locally. Then edit packages.json and add the package URL(s) to the JSON. Finally, in the directory where you have the clone of your fork of this repository, run the following command:

swift ./validate.swift

When validation succeeds, commit your changes and submit your pull request! Your package(s) will appear in the index within a few minutes.

Note: If submitting your own packages, don't forget to add badges to your package's README to always have up to date swift version and platform compatibility information readily available. Once your package appears in the index, use the "Do you maintain this package?" link in the right-hand sidebar of your package page and use the provided markdown.

For example:

If you would prefer to validate the requirements manually, please verify that:

Note: There's no gatekeeping or quality threshold to be included in the Swift Package Index. As long as packages are valid, and meet the requirements above, we will accept them.