Welcome to the documentation for ZIPFoundation! This page will guide you through the various features and functions of ZIPFoundation, a Swift framework that allows you to work with ZIP archives.


To start using ZIPFoundation in your project, you need to install it first. You can install ZIPFoundation in different ways:

  1. Using CocoaPods: Add ZIPFoundation to your Podfile and run pod install.
  2. Using Swift Package Manager: Add ZIPFoundation as a dependency in your Package.swift file.
  3. Manual installation: Download the ZIPFoundation source code and manually add it to your project.


To use ZIPFoundation in your project, follow these steps:

  1. Import ZIPFoundation: In the file where you want to use ZIPFoundation, import the framework by adding import ZIPFoundation.
  2. Creating a ZIP archive: To create a new ZIP archive, you can use the ZipArchive class. Initialize it with a path where you want to save the archive and call the createArchive function to create an empty archive.
  3. Adding files to the archive: Use the addEntry function of the ZipArchive class to add files to the archive.
  4. Extracting files from the archive: Use the extract function of the ZipArchive class to extract files from the archive.
  5. Working with entries: ZIPFoundation provides various functions to work with the entries in a ZIP archive, such as renaming, deleting, or updating entries.

Additional Resources

For more detailed information and examples, refer to the official documentation and resources listed below:

  • GitHub Repository: The official ZIPFoundation repository on GitHub: ZIPFoundation.
  • API Reference: Detailed API reference for ZIPFoundation: ZIPFoundation Documentation.
  • Sample Projects: Explore sample projects and code examples using ZIPFoundation to learn more about its capabilities.
  • Community Support: Connect with other developers using ZIPFoundation, ask questions, and share your experiences on related forums and communities.


ZIPFoundation provides a convenient and powerful way to work with ZIP archives in your Swift projects. By following the installation and usage instructions provided in this documentation, you will be able to seamlessly integrate ZIPFoundation into your application. Explore the comprehensive API reference and other resources to discover all the features and possibilities of ZIPFoundation.