@capgo/capacitor-persistent-account

Store a user's account data in native storage from your Capacitor app, so it can still be there after a delete and reinstall. The iOS Keychain keeps it, while on Android retention after uninstall depends on the system.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-persistent-account in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-persistent-account to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Save: saveAccount() stores any serializable account data.
• Read: readAccount() returns it, including after a reinstall when the platform kept the data.
• iOS: stored in the Keychain.
• Android: stored with AccountManager.
• Platforms: iOS, Android and Web. Web uses localStorage, which does not survive clearing site data.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/persistent-account/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-persistent-account` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-persistent-account
npx cap sync

API

• readAccount()
• saveAccount(...)
• getPluginVersion()

Capacitor Persistent Account Plugin

Provides persistent storage for account data across app sessions using platform-specific secure storage mechanisms. On iOS, this uses the Keychain. On Android, this uses AccountManager. This ensures account data persists even after app reinstallation.

readAccount()

readAccount() => Promise<{ data: unknown | null; }>

Reads the stored account data from persistent storage.

Retrieves account data that was previously saved using saveAccount(). The data persists across app sessions and survives app reinstallation on supported platforms.

Returns: Promise<{ data: unknown; }>

saveAccount(...)

saveAccount(options: { data: unknown; }) => Promise<void>

Saves account data to persistent storage.

Stores the provided account data using platform-specific secure storage mechanisms. The data will persist across app sessions and survive app reinstallation. Any existing account data will be overwritten.

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version

Returns the version string of the native plugin implementation. Useful for debugging and ensuring compatibility between the JavaScript and native layers.

Returns: Promise<{ version: string; }>