--- description: Capacitor plugin to access native asset files. It allows copying, listing, and reading files from the app bundle. title: Capacitor Asset Manager Plugin for Android & iOS - Capawesome image: https://capawesome.io/docs/assets/images/social/plugins/asset-manager.png --- [ Skip to content](#capawesomecapacitor-asset-manager) [ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) * [ Enums ](#enums) * [ Changelog ](#changelog) * [ License ](#license) * [ Audio Player ](/docs/plugins/audio-player/) * [ Audio Recorder ](/docs/plugins/audio-recorder/) * [ Background Task ](/docs/plugins/background-task/) * [ Badge ](/docs/plugins/badge/) * [ Barometer ](/docs/plugins/barometer/) * [ Biometrics ](/docs/plugins/biometrics/) * [ Bluetooth Low Energy ](/docs/plugins/bluetooth-low-energy/) * [ Cloudinary ](/docs/plugins/cloudinary/) * [ Contacts ](/docs/plugins/contacts/) * [ Datetime Picker ](/docs/plugins/datetime-picker/) * [ File Compressor ](/docs/plugins/file-compressor/) * [ File Opener ](/docs/plugins/file-opener/) * [ File Picker ](/docs/plugins/file-picker/) * [ Firebase ](/docs/plugins/firebase/) * [ Formbricks ](/docs/plugins/formbricks/) * [ Geocoder ](/docs/plugins/geocoder/) * [ Google Sign-In ](/docs/plugins/google-sign-in/) * [ libSQL ](/docs/plugins/libsql/) * [ Live Update ](/docs/plugins/live-update/) * [ Managed Configurations ](/docs/plugins/managed-configurations/) * [ Media Session ](/docs/plugins/media-session/) * [ ML Kit ](/docs/plugins/mlkit/) * [ NFC ](/docs/plugins/nfc/) * [ OAuth ](/docs/plugins/oauth/) * [ Pedometer ](/docs/plugins/pedometer/) * [ Photo Editor ](/docs/plugins/photo-editor/) * [ PostHog ](/docs/plugins/posthog/) * [ Printer ](/docs/plugins/printer/) * [ Purchases ](/docs/plugins/purchases/) * [ RealtimeKit ](/docs/plugins/realtimekit/) * [ Screen Orientation ](/docs/plugins/screen-orientation/) * [ Screenshot ](/docs/plugins/screenshot/) * [ Secure Preferences ](/docs/plugins/secure-preferences/) * [ Speech Recognition ](/docs/plugins/speech-recognition/) * [ Speech Synthesis ](/docs/plugins/speech-synthesis/) * [ Share Target ](/docs/plugins/share-target/) * [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/) * [ SQLite ](/docs/plugins/sqlite/) * [ Superwall ](/docs/plugins/superwall/) * [ Torch ](/docs/plugins/torch/) * [ Wifi ](/docs/plugins/wifi/) * [ Zip ](/docs/plugins/zip/) * [ Cloud ](/docs/cloud/) * [ Live Updates ](/docs/cloud/live-updates/) * Advanced * Integrations * [ Native Builds ](/docs/cloud/native-builds/) * [ Configuration ](/docs/cloud/native-builds/configuration/) * [ Environments ](/docs/cloud/native-builds/environments/) * Guides * [ Sample Projects ](/docs/cloud/native-builds/sample-projects/) * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ Automations ](/docs/cloud/automations/) * [ Assist ](/docs/cloud/assist/) * Account * Organizations * [ Organization and User Management ](/docs/cloud/organizations/memberships/) * [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/) * [ Teams ](/docs/cloud/organizations/teams/) * [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/) * [ Integrations ](/docs/cloud/integrations/) * [ License Keys ](/docs/cloud/license-keys/) * [ Webhooks ](/docs/cloud/webhooks/) * [ Pricing ](https://capawesome.io/pricing/) * [ FAQ ](/docs/cloud/faq/) * [ Support ](/docs/cloud/support/) * [ Contributing ](/docs/contributing/) * [ LLMs ](/docs/llms/) * [ Insiders ](/docs/insiders/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/insiders/support/) * [ FAQ ](/docs/insiders/faq/) * [ Blog ](/blog/) * Categories * [ Enums ](#enums) * [ Changelog ](#changelog) * [ License ](#license) # @capawesome/capacitor-asset-manager[¶](#capawesomecapacitor-asset-manager "Permanent link") Capacitor plugin to access native asset files. [ ![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") We are proud to offer one of the most complete and feature-rich Capacitor plugins for asset management. Here are some of the key features: * 🖥️ **Cross-platform**: Supports Android and iOS. * 📂 **Asset copying**: Copy files or directories from app bundle to data directory. * 📄 **File listing**: List all files in asset directories. * 📖 **File reading**: Read asset files with Base64 or UTF-8 encoding. * 🔄 **Bundle access**: Direct access to native app bundle assets. * 🗂️ **Directory operations**: Handle both individual files and entire directories. * 📦 **Multiple encodings**: Support for Base64 and UTF-8 file reading. * 🔁 **Up-to-date**: Always supports the latest Capacitor version. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## 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/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | ## Installation[¶](#installation "Permanent link") 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-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-asset-manager` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-asset-manager [](#%5F%5Fcodelineno-2-2)npx cap sync ` ## Configuration[¶](#configuration "Permanent link") No configuration required for this plugin. ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { Directory, Filesystem } from '@capacitor/filesystem'; [](#%5F%5Fcodelineno-3-2)import { AssetManager, Encoding } from '@capawesome/capacitor-asset-manager'; [](#%5F%5Fcodelineno-3-3) [](#%5F%5Fcodelineno-3-4)const copy = async () => { [](#%5F%5Fcodelineno-3-5) const { uri } = await Filesystem.getUri({ [](#%5F%5Fcodelineno-3-6) directory: Directory.Cache, [](#%5F%5Fcodelineno-3-7) path: 'index.html' [](#%5F%5Fcodelineno-3-8) }); [](#%5F%5Fcodelineno-3-9) await AssetManager.copy({ [](#%5F%5Fcodelineno-3-10) from: 'public/index.html', [](#%5F%5Fcodelineno-3-11) to: uri [](#%5F%5Fcodelineno-3-12) }); [](#%5F%5Fcodelineno-3-13)}; [](#%5F%5Fcodelineno-3-14) [](#%5F%5Fcodelineno-3-15)const list = async () => { [](#%5F%5Fcodelineno-3-16) await AssetManager.list({ [](#%5F%5Fcodelineno-3-17) path: 'public' [](#%5F%5Fcodelineno-3-18) }); [](#%5F%5Fcodelineno-3-19)}; [](#%5F%5Fcodelineno-3-20) [](#%5F%5Fcodelineno-3-21)const read = async () => { [](#%5F%5Fcodelineno-3-22) const { data } = await AssetManager.read({ [](#%5F%5Fcodelineno-3-23) encoding: Encoding.Utf8, [](#%5F%5Fcodelineno-3-24) path: 'capacitor.config.json' [](#%5F%5Fcodelineno-3-25) }); [](#%5F%5Fcodelineno-3-26) return JSON.parse(data); [](#%5F%5Fcodelineno-3-27)}; ` ## API[¶](#api "Permanent link") * [copy(...)](#copy) * [list(...)](#list) * [read(...)](#read) * [Interfaces](#interfaces) * [Enums](#enums) ### copy(...)[¶](#copy "Permanent link") `[](#%5F%5Fcodelineno-4-1)copy(options: CopyOptions) => Promise ` Copy a file or directory from the app bundle to the app's data directory. Only available on Android and iOS. | Param | Type | | ----------- | --------------------------- | | **options** | [CopyOptions](#copyoptions) | **Since:** 7.0.0 --- ### list(...)[¶](#list "Permanent link") `[](#%5F%5Fcodelineno-5-1)list(options?: ListOptions | undefined) => Promise ` List files in a directory. Only available on Android and iOS. | Param | Type | | ----------- | --------------------------- | | **options** | [ListOptions](#listoptions) | **Returns:** `Promise<[ListResult](#listresult)>` **Since:** 7.0.0 --- ### read(...)[¶](#read "Permanent link") `[](#%5F%5Fcodelineno-6-1)read(options: ReadOptions) => Promise ` Read a file from the app bundle. **Attention**: Reading large files can cause out of memory (OOM) issues. It is therefore recommended to copy files to the app's data directory using the `copy` method and read them from there using the [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch%5FAPI/Using%5FFetch). Only available on Android and iOS. | Param | Type | | ----------- | --------------------------- | | **options** | [ReadOptions](#readoptions) | **Returns:** `Promise<[ReadResult](#readresult)>` **Since:** 7.0.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### CopyOptions[¶](#copyoptions "Permanent link") | Prop | Type | Description | Since | | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | | **from** | string | The source path to copy from. | 7.0.0 | | **to** | string | The destination path to copy to. **Tip**: Generate this path using the [getUri(...)](https://capacitorjs.com/docs/apis/filesystem#geturi) method of the Capacitor Filesystem plugin. | 7.0.0 | #### ListResult[¶](#listresult "Permanent link") | Prop | Type | Description | Since | | --------- | ---------- | ----------------------------------- | ----- | | **files** | string\[\] | The list of files in the directory. | 7.0.0 | #### ListOptions[¶](#listoptions "Permanent link") | Prop | Type | Description | Since | | -------- | ------ | -------------------------------------------------------------------------- | ----- | | **path** | string | The path to list files from. If not specified, the root path will be used. | 7.0.0 | #### ReadResult[¶](#readresult "Permanent link") | Prop | Type | Description | Since | | -------- | ------ | ------------------------ | ----- | | **data** | string | The content of the file. | 7.0.0 | #### ReadOptions[¶](#readoptions "Permanent link") | Prop | Type | Description | Default | Since | | ------------ | --------------------- | ------------------------------------------ | -------- | ----- | | **encoding** | [Encoding](#encoding) | The encoding to use when reading the file. | 'base64' | 7.0.0 | | **path** | string | The path to read the file from. | 7.0.0 | | ### Enums[¶](#enums "Permanent link") #### Encoding[¶](#encoding "Permanent link") | Members | Value | Since | | ---------- | -------- | ----- | | **Base64** | 'base64' | 7.0.0 | | **Utf8** | 'utf8' | 7.0.0 | ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/asset-manager/CHANGELOG.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/asset-manager/LICENSE). May 17, 2026 Back to top