Capacitor App Identifier and Name Updater

1.0.4 · active · verified Tue Apr 21

capacitor-identity is a focused command-line interface (CLI) tool designed to simplify the process of updating the application ID (bundle identifier for iOS, `applicationId` for Android) and the display name (`appName`) for Capacitor-based mobile applications. Currently at version 1.0.4, it serves as a utility for developers needing to quickly configure their Capacitor projects for different environments (e.g., staging vs. production) or rebranding efforts. Its primary differentiator is its simplicity and direct approach to modifying core native project settings without requiring manual edits in Xcode or Android Studio. It is executed via `npx` and directly manipulates the necessary configuration files within the Capacitor project structure. The package is likely updated on an as-needed basis to support new Capacitor versions or address specific platform changes, rather than following a frequent release cadence, given its specialized function.

Common errors

```
Error: ENOENT: no such file or directory, open 'capacitor.config.ts'
```
cause The `capacitor-identity` command was executed outside the root directory of a Capacitor project.

fix Change your current directory to your Capacitor project's root, then re-run `npx capacitor-identity ...`.
```
Error: Missing required argument: bundleId
```
cause The `--bundleId` argument was omitted when running the `capacitor-identity` command.

fix Include the `--bundleId com.your.app` argument in your `npx capacitor-identity` command.
```
Error: Missing required argument: appName
```
cause The `--appName` argument was omitted when running the `capacitor-identity` command.

fix Include the `--appName "Your App Name"` argument in your `npx capacitor-identity` command.

Warnings

gotcha Ensure you run `capacitor-identity` from the root directory of your Capacitor project. Executing it elsewhere will result in 'file not found' errors or incorrect modifications.
Fix: Navigate to your Capacitor project's root directory (where `capacitor.config.ts` or `package.json` resides) before running the command.
gotcha The `--bundleId` and `--appName` flags are mandatory for `capacitor-identity` to perform its updates. Omitting either will lead to an `Error: Missing required argument` and the operation will not complete.
Fix: Always provide both `--bundleId com.your.app` and `--appName "Your App Name"` arguments.
gotcha After running `capacitor-identity`, it is crucial to rebuild your native projects (`npx cap sync && npx cap open [ios|android]`) to ensure the changes are picked up by Xcode and Android Studio.
Fix: Run `npx cap sync` followed by `npx cap open ios` and/or `npx cap open android` in your project root.

Install

npm install capacitor-identity npm
yarn add capacitor-identity yarn
pnpm add capacitor-identity pnpm

Imports

capacitor-identity (CLI)
wrong:
```
import { updateIdentity } from 'capacitor-identity';
```
correct:
```
npx capacitor-identity --bundleId com.example.newapp --appName "New App Staging"
```
This package is a command-line interface (CLI) tool and is not intended for direct programmatic import into JavaScript/TypeScript code. It should be executed via `npx` in your project's root directory.

Quickstart

Demonstrates how to update the application bundle ID and display name of a Capacitor project using the CLI tool.

npx capacitor-identity --bundleId com.example.newapp --appName "New App Staging"
# After running, ensure to sync and rebuild your native projects:
npx cap sync
npx cap open ios
npx cap open android

view raw JSON →