@capacitor/cli

Capacitor CLI

The Capacitor command-line interface (CLI) is a tool for creating and managing Capacitor applications. While it can be installed globally, it's recommended to install it locally in your project and execute through npm scripts.

Installation

Project Installation (Recommended)

Install the CLI locally in your project:

npm install @capacitor/cli --save-dev

Global Installation

While not recommended for project use, you can install the CLI globally:

npm install -g @capacitor/cli

Using Capacitor CLI

The CLI can be used through the capacitor or cap command. When installed locally, use it through your project's npm scripts or npx.

Common commands:

• cap init: Initialize a new Capacitor project
• cap add: Add a native platform (ios, android)
• cap sync: Sync your web code to your native projects

For detailed information, consult the Getting Started guide.

Local Development

If you're contributing to the Capacitor CLI or testing local changes:

• Clone and setup:

  git clone https://github.com/ionic-team/capacitor.git
  cd cli
  npm install
  

• Build the CLI:

  npm run build
  

• Create a local link:

  npm link
  

• Development workflow:

  • Run npm run watch to automatically rebuild on changes
  • Use capacitor or cap commands to test your changes
  • Run npm test to execute the test suite

Debugging

Using VS Code Launch Configurations

The CLI includes VS Code launch configurations for debugging. To debug a CLI command:

• Open the project in VS Code
• Right now we don't have debugging working in the ts files, so select one of the .js files inside of /dist/**.js
• Place a breakpoint
• Press F5 or go to Run > Start Debugging
• Select a launch config and run filling out the path you want to run the cli in, and the command that you want run.

You can add more configurations by copying and modifying the existing ones in .vscode/launch.json.

Contributing

Contributions are welcome! Please read our Contributing Guide for details.

License

• MIT

Similar packages

Other packages similar to @capacitor/cli

cordova

Apache Cordova is a mobile application development framework that allows you to use standard web technologies such as HTML5, CSS3, and JavaScript for cross-platform development. It provides a set of APIs to access native device functions. Compared to @capacitor/cli, Cordova has been around longer and has a larger plugin ecosystem, but Capacitor offers a more modern development experience and better integration with modern web frameworks.

react-native-cli

React Native CLI is a command-line interface for React Native, a framework for building native apps using React. It provides commands to create, build, and run React Native projects. Unlike @capacitor/cli, which focuses on web technologies and cross-platform development, React Native CLI is specifically designed for building native mobile apps with React.

expo-cli

Expo CLI is a command-line tool for Expo, a framework and platform for universal React applications. It provides a set of tools and services to build, deploy, and manage React Native apps. Expo CLI simplifies the development process by providing a managed workflow, but it may have limitations compared to @capacitor/cli in terms of accessing native device features directly.