# create-capacitor-plugin

**Repository Path**: mirrors_ionic-team/create-capacitor-plugin

## Basic Information

- **Project Name**: create-capacitor-plugin
- **Description**: Create a new Capacitor plugin ⚡️
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-23
- **Last Updated**: 2026-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Create Capacitor Plugin

Generate a new Capacitor plugin.

## Usage

```
npm init @capacitor/plugin [<path>] [options]
```

:memo: `npm init <pkg>` requires npm 6+

You can also try the following methods to use this package:

- `npx @capacitor/create-plugin`
- `yarn create @capacitor/plugin`
- `npm install -g @capacitor/create-plugin && create-capacitor-plugin`

### Example Apps

As of the `0.8.0` release, example apps for testing are included when initializing a new plugin. To use these templates, you can open the `npx cap open android` or `npx cap open ios` command for Android and iOS respectively. Anything in the `example-app` folder will be excluded when publishing to npm.

### Options

```
--name <name> ............. npm package name (e.g. "capacitor-plugin-example")
--package-id <id> ......... Unique plugin ID in reverse-DNS notation (e.g. "com.mycompany.plugins.example")
--class-name <name> ....... Plugin class name (e.g. "Example")
--repo <url> .............. URL to git repository (e.g. "https://github.com/example/repo")
--author <author> ......... Author name and email (e.g. "Name <name@example.com>")
--license <id> ............ SPDX License ID (e.g. "MIT")
--description <text> ...... Short description of plugin features
--android-lang <text> ..... Language for Android plugin development (either "kotlin" or "java", default is "java")
```