--- description: Capacitor plugin to zip and unzip files and directories with support for encryption. Available on Android and iOS. title: Capacitor Zip Plugin for Android & iOS - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/zip.png --- [Skip to content ](#capacitor-zip-plugin) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * Zip [ Zip ](/docs/sdks/capacitor/zip/) * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) # Capacitor Zip Plugin[ΒΆ](#capacitor-zip-plugin "Permanent link") Capacitor plugin to zip and unzip files and directories with support for encryption. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") The Capacitor Zip plugin is one of the most complete file archiving solutions for Capacitor apps. Here are some of the key features: * πŸ–₯️ **Cross-platform**: Supports Android and iOS. * πŸ“ **File Compression**: Zip and unzip single or multiple files. * πŸ”‘ **Encryption**: Encrypt and decrypt files. * 🀝 **Compatibility**: Compatible with the [File Compressor](https://capawesome.io/docs/sdks/capacitor/file-compressor/) plugin. * πŸ“¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. * ⭐️ **Support**: Priority support from the Capawesome Team. * ✨ **Handcrafted**: Built from the ground up with care and expertise, not forked or AI-generated. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll add it for you! ## Use Cases[ΒΆ](#use-cases "Permanent link") The Zip plugin is typically used whenever an app needs to work with zip archives, for example: * **File uploads**: Bundle multiple files or an entire directory into a single zip archive before uploading it to a server. * **Content downloads**: Unzip archives downloaded from a server, for example to make content available offline. * **Data backups**: Compress app data into an archive that can be exported and restored later. * **Sensitive data protection**: Encrypt archives with a password when zipping and decrypt them when unzipping. ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | ## Demo[ΒΆ](#demo "Permanent link") A working example can be found [here](https://github.com/robingenz/capacitor-plugin-demo). ## Installation[ΒΆ](#installation "Permanent link") This plugin is only available to [Capawesome Insiders](https://capawesome.io/insiders/). First, make sure you have the Capawesome npm registry set up. You can do this by running the following commands: `[](#%5F%5Fcodelineno-0-1)npm config set @capawesome-team:registry https://npm.registry.capawesome.io [](#%5F%5Fcodelineno-0-2)npm config set //npm.registry.capawesome.io/:_authToken ` **Attention**: Replace `` with the license key you received from Polar. If you don't have a license key yet, you can get one by becoming a [Capawesome Insider](https://capawesome.io/insiders/). Next, you can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-1-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-2-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome-team/capacitor-zip` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-3-1)npm install @capawesome-team/capacitor-zip [](#%5F%5Fcodelineno-3-2)npx cap sync ` ### Android[ΒΆ](#android "Permanent link") #### Proguard[ΒΆ](#proguard "Permanent link") If you are using Proguard, you need to add the following rules to your `proguard-rules.pro` file: `[](#%5F%5Fcodelineno-4-1)-keep class io.capawesome.capacitorjs.plugins.** { *; } ` #### Variables[ΒΆ](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$zip4jVersion` version of `net.lingala.zip4j:zip4j` (default: `2.11.5`) This can be useful if you encounter dependency conflicts with other plugins in your project. ### iOS[ΒΆ](#ios "Permanent link") #### Minimum Deployment Target[ΒΆ](#minimum-deployment-target "Permanent link") If you are using **Swift Package Manager**, make sure that your iOS deployment target is set to at least `16.0` in your Xcode project settings (usually in `ios/App/App.xcodeproj`): `[](#%5F%5Fcodelineno-5-1)-IPHONEOS_DEPLOYMENT_TARGET = 15.0 [](#%5F%5Fcodelineno-5-2)+IPHONEOS_DEPLOYMENT_TARGET = 16.0 ` If you are using **CocoaPods**, make sure that your iOS deployment target is set to at least `16.0` in your `Podfile`: `[](#%5F%5Fcodelineno-6-1)platform :ios, '16.0' ` ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") The following examples show how to create a zip archive and extract an existing one. ### Zip a file or directory[ΒΆ](#zip-a-file-or-directory "Permanent link") Create a zip archive from a source file or directory. You can optionally provide a `password` to encrypt the archive. Only available on Android and iOS: `[](#%5F%5Fcodelineno-7-1)import { Zip } from '@capawesome-team/capacitor-zip'; [](#%5F%5Fcodelineno-7-2) [](#%5F%5Fcodelineno-7-3)const zip = async () => { [](#%5F%5Fcodelineno-7-4) await Zip.zip({ [](#%5F%5Fcodelineno-7-5) source: 'file:///data/user/0/dev.robingenz.capacitor.plugindemo/cache/1714900095398', [](#%5F%5Fcodelineno-7-6) destination: 'file:///data/user/0/dev.robingenz.capacitor.plugindemo/cache/1714900095398.zip', [](#%5F%5Fcodelineno-7-7) password: 'secret', [](#%5F%5Fcodelineno-7-8) }); [](#%5F%5Fcodelineno-7-9)}; ` ### Unzip an archive[ΒΆ](#unzip-an-archive "Permanent link") Extract a zip archive into a destination directory. If the archive is encrypted, provide the `password` to decrypt it. Only available on Android and iOS: `[](#%5F%5Fcodelineno-8-1)import { Zip } from '@capawesome-team/capacitor-zip'; [](#%5F%5Fcodelineno-8-2) [](#%5F%5Fcodelineno-8-3)const unzip = async () => { [](#%5F%5Fcodelineno-8-4) await Zip.unzip({ [](#%5F%5Fcodelineno-8-5) source: 'file:///data/user/0/dev.robingenz.capacitor.plugindemo/cache/1714900095398.zip', [](#%5F%5Fcodelineno-8-6) destination: 'file:///data/user/0/dev.robingenz.capacitor.plugindemo/cache/1714900095398', [](#%5F%5Fcodelineno-8-7) password: 'secret', [](#%5F%5Fcodelineno-8-8) }); [](#%5F%5Fcodelineno-8-9)}; ` ## API[ΒΆ](#api "Permanent link") * [unzip(...)](#unzip) * [zip(...)](#zip) * [Interfaces](#interfaces) ### unzip(...)[ΒΆ](#unzip "Permanent link") `[](#%5F%5Fcodelineno-9-1)unzip(options: UnzipOptions) => Promise ` Unzip a file. Only available on Android and iOS. | Param | Type | | ----------- | ----------------------------- | | **options** | [UnzipOptions](#unzipoptions) | **Since:** 6.0.0 --- ### zip(...)[ΒΆ](#zip "Permanent link") `[](#%5F%5Fcodelineno-10-1)zip(options: ZipOptions) => Promise ` Zip a file or directory. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------- | | **options** | [ZipOptions](#zipoptions) | **Since:** 6.0.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### UnzipOptions[ΒΆ](#unzipoptions "Permanent link") | Prop | Type | Description | Since | | --------------- | ------ | ------------------------------------- | ----- | | **destination** | string | The destination directory. | 6.0.0 | | **password** | string | The password to decrypt the zip file. | 6.1.0 | | **source** | string | The source file to unzip. | 6.0.0 | #### ZipOptions[ΒΆ](#zipoptions "Permanent link") | Prop | Type | Description | Since | | --------------- | ------ | ------------------------------------- | ----- | | **destination** | string | The destination file. | 6.0.0 | | **password** | string | The password to encrypt the zip file. | 6.1.0 | | **source** | string | The source file or directory to zip. | 6.0.0 | ## FAQ[ΒΆ](#faq "Permanent link") ### Can I create password-protected zip archives?[ΒΆ](#can-i-create-password-protected-zip-archives "Permanent link") Yes. Pass the `password` option to the `zip(...)` method to encrypt the archive and pass the same option to the `unzip(...)` method to decrypt it. See the [usage examples](#usage) above. ### Can I zip an entire directory?[ΒΆ](#can-i-zip-an-entire-directory "Permanent link") Yes. The `source` option of the `zip(...)` method accepts either a single file or a directory. When unzipping, the archive is extracted into the directory specified by the `destination` option. ### Does this plugin work on the Web?[ΒΆ](#does-this-plugin-work-on-the-web "Permanent link") No, the `zip(...)` and `unzip(...)` methods are only available on Android and iOS, as documented in the [API](#api) section. ### How is this plugin different from the File Compressor plugin?[ΒΆ](#how-is-this-plugin-different-from-the-file-compressor-plugin "Permanent link") The [File Compressor](https://capawesome.io/docs/sdks/capacitor/file-compressor/) plugin reduces the file size of individual image files such as PNG, JPEG, and WebP. The Zip plugin, on the other hand, bundles one or more files or directories into a zip archive and extracts them again. Both plugins are compatible and can be used together, for example to compress images before zipping them. ### Can I use this plugin with Ionic, React, Vue or Angular?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link") Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects. ## Related Plugins[ΒΆ](#related-plugins "Permanent link") * [File Picker](https://capawesome.io/docs/sdks/capacitor/file-picker/): Let the user select a file, directory, image, or video from the device. * [File Compressor](https://capawesome.io/docs/sdks/capacitor/file-compressor/): Compress image files such as PNG, JPEG, and WebP. * [File Opener](https://capawesome.io/docs/sdks/capacitor/file-opener/): Open a file with the default application. * [Share Target](https://capawesome.io/docs/sdks/capacitor/share-target/): Receive files shared from other apps. ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/zip/CHANGELOG.md). ## Breaking Changes[ΒΆ](#breaking-changes "Permanent link") See [BREAKING.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/zip/BREAKING.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/zip/LICENSE). July 8, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/zip/#article", "headline": "Capacitor Zip Plugin for Android & iOS", "name": "Capacitor Zip Plugin for Android & iOS", "description": "Capacitor plugin to zip and unzip files and directories with support for encryption. Available on Android and iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/zip/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/zip/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/zip/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/zip/#software", "name": "Capacitor Zip Plugin for Android & iOS", "description": "Capacitor plugin to zip and unzip files and directories with support for encryption. Available on Android and iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/zip/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "Can I create password-protected zip archives?", "acceptedAnswer": {"@type": "Answer", "text": "Yes. Pass the password option to the zip(...) method to encrypt the archive and pass the same option to the unzip(...) method to decrypt it. See the usage examples above."}}, {"@type": "Question", "name": "Can I zip an entire directory?", "acceptedAnswer": {"@type": "Answer", "text": "Yes. The source option of the zip(...) method accepts either a single file or a directory. When unzipping, the archive is extracted into the directory specified by the destination option."}}, {"@type": "Question", "name": "Does this plugin work on the Web?", "acceptedAnswer": {"@type": "Answer", "text": "No, the zip(...) and unzip(...) methods are only available on Android and iOS, as documented in the API section."}}, {"@type": "Question", "name": "How is this plugin different from the File Compressor plugin?", "acceptedAnswer": {"@type": "Answer", "text": "The File Compressor plugin reduces the file size of individual image files such as PNG, JPEG, and WebP. The Zip plugin, on the other hand, bundles one or more files or directories into a zip archive and extracts them again. Both plugins are compatible and can be used together, for example to compress images before zipping them."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/zip/"} ```