UNPKG

3.85 kBMarkdownView Raw
1<!--
2#
3# Licensed to the Apache Software Foundation (ASF) under one
4# or more contributor license agreements. See the NOTICE file
5# distributed with this work for additional information
6# regarding copyright ownership. The ASF licenses this file
7# to you under the Apache License, Version 2.0 (the
8# "License"); you may not use this file except in compliance
9# with the License. You may obtain a copy of the License at
10#
11# http://www.apache.org/licenses/LICENSE-2.0
12#
13# Unless required by applicable law or agreed to in writing,
14# software distributed under the License is distributed on an
15# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16# KIND, either express or implied. See the License for the
17# specific language governing permissions and limitations
18# under the License.
19#
20-->
21[![Build status](https://ci.appveyor.com/api/projects/status/github/apache/cordova-cli?branch=master)](https://ci.appveyor.com/project/ApacheSoftwareFoundation/cordova-cli)
22[![Build Status](https://travis-ci.org/apache/cordova-cli.svg?branch=master)](https://travis-ci.org/apache/cordova-cli)
23
24# Cordova CLI
25
26> The command line tool to build, deploy and manage [Cordova](http://cordova.apache.org)-based applications.
27
28[Apache Cordova](http://cordova.apache.org) allows for building native mobile applications using HTML, CSS and JavaScript.
29This tool helps with management of multi-platform Cordova applications as well as Cordova plugin integration.
30
31# Installation
32In your command-line on Windows:
33```bash
34 c:\> npm install -g cordova
35```
36
37In your terminal on Mac OS X/Linux:
38```bash
39 $sudo npm install -g cordova
40```
41
42# Creating a new Cordova project
43This simple example demonstrates how Cordova CLI can be used to create a `myApp` project with the `camera` plugin and run it for `android` platform:
44
45```bash
46 cordova create myApp com.myCompany.myApp myApp
47 cd myApp
48 cordova plugin add cordova-plugin-camera --save
49 cordova platform add android --save
50 cordova requirements android
51 cordova build android --verbose
52 cordova run android
53```
54
55# Docs
56- [Overview of Cordova]
57- [Create your first Cordova app] guide
58- [Full reference docs for Cordova CLI][Reference docs] has details of commands to add platforms, add plugins, build, package, and sign your HTML, JS apps.
59- Cordova allows you to build apps for a number of platforms. Learn more about our [Supported platforms].
60- [Project directory structure] documents the details of the directory structure created by Cordova CLI.
61
62# Contributing
63Cordova is an open source Apache project and contributors are needed to keep this project moving forward. Learn more on
64[how to contribute on our website][contribute].
65
66# Reporting Issues
67
68If you find issues with the Cordova CLI, please follow our guidelines for [reporting issues]. Please bear in mind that most of `cordova-cli`'s functionality is implemented in [cordova-lib], so that could be the place to report your issue.
69Platform-specific issues should be reported in the relevant repositories, such as [cordova-android] and [cordova-ios].
70
71[Overview of Cordova]: http://cordova.apache.org/docs/en/latest/guide/overview/
72[Create your first Cordova app]: http://cordova.apache.org/docs/en/latest/guide/cli/index.html
73[Reference docs]: http://cordova.apache.org/docs/en/latest/cordova-cli/index.html
74[Supported platforms]: http://cordova.apache.org/docs/en/latest/guide/support/index.html
75[Project directory structure]: http://cordova.apache.org/docs/en/latest/cordova-cli/index.html#directory-structure
76[Contribute]: http://cordova.apache.org/contribute/
77[Reporting issues]: http://cordova.apache.org/contribute/issues.html
78[cordova-lib]: https://github.com/apache/cordova-lib
79[cordova-android]: https://github.com/apache/cordova-android
80[cordova-ios]: https://github.com/apache/cordova-ios