@capacitor/cli 7.4.0 → 7.4.1-nightly-20250619T150613.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -4
- package/assets/android-template.tar.gz +0 -0
- package/assets/capacitor-cordova-android-plugins.tar.gz +0 -0
- package/assets/capacitor-cordova-ios-plugins.tar.gz +0 -0
- package/assets/ios-pods-template.tar.gz +0 -0
- package/assets/ios-spm-template.tar.gz +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,84 @@
|
|
|
1
1
|
# Capacitor CLI
|
|
2
2
|
|
|
3
|
-
The Capacitor command-line interface
|
|
3
|
+
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.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
### Project Installation (Recommended)
|
|
8
|
+
|
|
9
|
+
Install the CLI locally in your project:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
6
12
|
npm install @capacitor/cli --save-dev
|
|
7
13
|
```
|
|
8
14
|
|
|
15
|
+
### Global Installation
|
|
16
|
+
|
|
17
|
+
While not recommended for project use, you can install the CLI globally:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g @capacitor/cli
|
|
21
|
+
```
|
|
22
|
+
|
|
9
23
|
## Using Capacitor CLI
|
|
10
24
|
|
|
11
|
-
|
|
25
|
+
The CLI can be used through the `capacitor` or `cap` command. When installed locally, use it through your project's `npm` scripts or `npx`.
|
|
26
|
+
|
|
27
|
+
Common commands:
|
|
28
|
+
|
|
29
|
+
- `cap init`: Initialize a new Capacitor project
|
|
30
|
+
- `cap add`: Add a native platform (ios, android)
|
|
31
|
+
- `cap sync`: Sync your web code to your native projects
|
|
32
|
+
|
|
33
|
+
For detailed information, consult the [Getting Started guide](https://capacitorjs.com/docs/getting-started).
|
|
34
|
+
|
|
35
|
+
## Local Development
|
|
36
|
+
|
|
37
|
+
If you're contributing to the Capacitor CLI or testing local changes:
|
|
38
|
+
|
|
39
|
+
1. Clone and setup:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
git clone https://github.com/ionic-team/capacitor.git
|
|
43
|
+
cd cli
|
|
44
|
+
npm install
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
2. Build the CLI:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npm run build
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
3. Create a local link:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npm link
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
4. Development workflow:
|
|
60
|
+
- Run `npm run watch` to automatically rebuild on changes
|
|
61
|
+
- Use `capacitor` or `cap` commands to test your changes
|
|
62
|
+
- Run `npm test` to execute the test suite
|
|
63
|
+
|
|
64
|
+
## Debugging
|
|
65
|
+
|
|
66
|
+
### Using VS Code Launch Configurations
|
|
67
|
+
|
|
68
|
+
The CLI includes VS Code launch configurations for debugging. To debug a CLI command:
|
|
69
|
+
|
|
70
|
+
1. Open the project in VS Code
|
|
71
|
+
2. Right now we don't have debugging working in the ts files, so select one of the .js files inside of /dist/\*\*.js
|
|
72
|
+
3. Place a breakpoint
|
|
73
|
+
4. Press F5 or go to Run > Start Debugging
|
|
74
|
+
5. Select a launch config and run filling out the path you want to run the cli in, and the command that you want run.
|
|
75
|
+
|
|
76
|
+
You can add more configurations by copying and modifying the existing ones in `.vscode/launch.json`.
|
|
77
|
+
|
|
78
|
+
## Contributing
|
|
79
|
+
|
|
80
|
+
Contributions are welcome! Please read our [Contributing Guide](https://github.com/ionic-team/capacitor/blob/main/CONTRIBUTING.md) for details.
|
|
12
81
|
|
|
13
82
|
### License
|
|
14
83
|
|
|
15
|
-
|
|
84
|
+
- [MIT](https://github.com/ionic-team/capacitor/blob/HEAD/LICENSE)
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@capacitor/cli",
|
|
3
|
-
"version": "7.4.0",
|
|
3
|
+
"version": "7.4.1-nightly-20250619T150613.0",
|
|
4
4
|
"description": "Capacitor: Cross-platform apps with JavaScript and the web",
|
|
5
5
|
"homepage": "https://capacitorjs.com",
|
|
6
6
|
"author": "Ionic Team <hi@ionic.io> (https://ionic.io)",
|