forked from sintaxi/phonegap
-
Notifications
You must be signed in to change notification settings - Fork 905
/
guide_command-line_index.md.html
345 lines (272 loc) · 13.2 KB
/
guide_command-line_index.md.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<!DOCTYPE html>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
--><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
<meta name="generator" content="joDoc">
<title>Apache Cordova API Documentation</title>
<link rel="stylesheet" type="text/css" href="index.css">
<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
</head>
<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
<select><optgroup label="English" value="en">
<option value="edge">edge</option>
<option value="2.5.0rc1">2.5.0rc1</option>
<option selected value="2.5.0">2.5.0</option>
<option value="2.4.0rc1">2.4.0rc1</option>
<option value="2.4.0">2.4.0</option>
<option value="2.3.0rc2">2.3.0rc2</option>
<option value="2.3.0rc1">2.3.0rc1</option>
<option value="2.3.0">2.3.0</option>
<option value="2.2.0rc2">2.2.0rc2</option>
<option value="2.2.0rc1">2.2.0rc1</option>
<option value="2.2.0">2.2.0</option>
<option value="2.1.0rc2">2.1.0rc2</option>
<option value="2.1.0rc1">2.1.0rc1</option>
<option value="2.1.0">2.1.0</option>
<option value="2.0.0rc1">2.0.0rc1</option>
<option value="2.0.0">2.0.0</option>
<option value="1.9.0rc1">1.9.0rc1</option>
<option value="1.9.0">1.9.0</option>
<option value="1.8.1">1.8.1</option>
<option value="1.8.0rc1">1.8.0rc1</option>
<option value="1.8.0">1.8.0</option>
<option value="1.7.0rc1">1.7.0rc1</option>
<option value="1.7.0">1.7.0</option>
<option value="1.6.1">1.6.1</option>
<option value="1.6.0rc1">1.6.0rc1</option>
<option value="1.6.0">1.6.0</option>
<option value="1.5.0rc1">1.5.0rc1</option>
<option value="1.5.0">1.5.0</option>
</optgroup>
<optgroup label="Japanese" value="jp">
<option value="2.2.0">2.2.0</option>
<option value="2.1.0">2.1.0</option>
<option value="2.0.0">2.0.0</option>
<option value="1.9.0">1.9.0</option>
<option value="1.8.1">1.8.1</option>
<option value="1.7.0">1.7.0</option>
</optgroup>
<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
</div>
<div id="subheader">
<h1>Command-Line Usage</h1>
<small><select><option value="Command-Line%2520Usage">Command-Line Usage</option>
<option value="Command-Line%20Usage_supported_platforms"> - Supported Platforms</option>
<option value="Command-Line%20Usage_windows_phone_8"> - Windows Phone 8</option>
<option value="Command-Line%20Usage_ios"> - iOS</option>
<option value="Command-Line%20Usage_android"> - Android</option>
<option value="Command-Line%20Usage_blackberry"> - BlackBerry</option></select></small>
</div>
<div id="sidebar">
<div class="vertical_divider"></div>
<h1>API Reference</h1>
<ul>
<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
<li><a href="cordova_device_device.md.html#Device">Device</a></li>
<li><a href="cordova_events_events.md.html#Events">Events</a></li>
<li><a href="cordova_file_file.md.html#File">File</a></li>
<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
<li><a href="cordova_media_media.md.html#Media">Media</a></li>
<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
</ul>
<h1>Guides</h1>
<ul>
<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
<li><a href="_index.html">Keyword Index</a></li>
</ul>
</div>
<div id="scrollable">
<div id="content">
<h1><a name="Command-Line%20Usage">Command-Line Usage</a></h1>
<p>Cordova now ships with a set of command-line tools that make it easier
for you to develop cross-platform applications. You can build, clean,
and launch an emulator with a single command. You can consider these
instructions as an alternative to the Getting Started guides. Whereas
the Getting Started guides help you get setup with the default IDEs and
tooling surrounding the platforms you are working with, the command-line
tools aim to provide a shell-based approach to creating and working with
Cordova projects.</p>
<h2>
<a name="Command-Line%20Usage_supported_platforms">Supported Platforms</a>
</h2>
<ul>
<li><a href="#Command-Line%20Usage_ios">iOS</a></li>
<li><a href="#Command-Line%20Usage_android">Android</a></li>
<li><a href="#Command-Line%20Usage_blackberry">BlackBerry</a></li>
<li><a href="#Command-Line%20Usage_wp8">Windows Phone 8</a></li>
</ul>
<h2>
<a name="Command-Line%20Usage_windows_phone_8">Windows Phone 8</a>
</h2>
<p>The Windows Phone 8 command line tools support creating new projects.</p>
<h3>Create a project</h3>
<p>Run the <code>create</code> command with the following parameters:</p>
<ul>
<li>Path to your new Cordova WP8 project</li>
<li>Package Name, following reverse-domain style convention ( this becomes the default Namespace )</li>
<li>Project name</li>
</ul>
<!-- --><pre class="prettyprint"><code>$ ./path/to/cordova-wp8/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
</code></pre>
<h2>
<a name="Command-Line%20Usage_ios">iOS</a>
</h2>
<p>The iOS command-line tools are built upon shell scripts and rely on
Xcode command-line tools such as <code>xcode-select</code> and <code>xcodebuild</code>.</p>
<h3>Create a project</h3>
<p>Run the <code>create</code> command with the following parameters:</p>
<ul>
<li>Path to your new Cordova iOS project</li>
<li>Package name, following reverse-domain style convention</li>
<li>Project name</li>
</ul>
<!-- --><pre class="prettyprint"><code>$ ./path/to/cordova-ios/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
</code></pre>
<h3>Build a project</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/build
</code></pre>
<h3>Run app on emulator</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/run
</code></pre>
<h3>Releasing</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/release
</code></pre>
<h3>Logging</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/log
</code></pre>
<h2>
<a name="Command-Line%20Usage_android">Android</a>
</h2>
<p>The Android command-line tools are built upon shell scripts. You <em>must</em>
have the Android SDK's <code>tools</code> and <code>platform-tools</code> folders in your
PATH!</p>
<h3>Create a project</h3>
<p>Run the <code>create</code> command with the following parameters:</p>
<ul>
<li>Path to your new Cordova Android project</li>
<li>Package name, following reverse-domain style convention</li>
<li>Main Activity name</li>
</ul>
<!-- --><pre class="prettyprint"><code>$ /path/to/cordova-android/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/cordova-android/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
</code></pre>
<h3>Build a project</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/build
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/build.bat
</code></pre>
<h3>Run app on emulator/device</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/run
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/run.bat
</code></pre>
<p>Make sure you have created at least one Android Virtual <a href="cordova_device_device.md.html#Device">Device</a>. If you did not it will ask you to create one with the <code>android</code> command.
If you have multiple AVDs, it will prompt you to select an AVD.</p>
<h3>Logging</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/log
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/log.bat
</code></pre>
<h3>Cleaning</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/clean
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/clean.bat
</code></pre>
<h3>Releasing</h3>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/release
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/release.bat
</code></pre>
<h2>
<a name="Command-Line%20Usage_blackberry">BlackBerry</a>
</h2>
<p>The BlackBerry command-line tools are built upon shell scripts.</p>
<h3>Create a project</h3>
<p>Run the <code>create</code> command with the following parameters:</p>
<ul>
<li>Path to your new Cordova BlackBerry project</li>
<li>Application name</li>
</ul>
<!-- --><pre class="prettyprint"><code>$ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_cordova_project CordovaProjectName
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_cordova_project CordovaProjectName
</code></pre>
<h3>Build a project</h3>
<p>For BlackBerry projects, please make sure you customize the
<code>project.properties</code> file in the root of your Cordova project folder.
This is necessary for things like supplying your BlackBerry signing key
password, location of the BlackBerry WebWorks SDK, and location of
BlackBerry simulator executables.</p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/debug
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/debug.bat
</code></pre>
<h3>Launch emulator</h3>
<p>For BlackBerry projects, please make sure you customize the
<code>project.properties</code> file in the root of your Cordova project folder.
This is necessary for things like supplying your BlackBerry signing key
password, location of the BlackBerry WebWorks SDK, and location of
BlackBerry simulator executables.</p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/emulate
</code></pre>
<p>or, on <strong>Windows</strong></p>
<pre class="prettyprint"><code>$ /path/to/my_new_cordova_project/cordova/emulate.bat
</code></pre>
<h3>Logging</h3>
<p>Unfortunately streaming logs directly from the device is not
supported at this time. However, BlackBerry offers built-in Web
Inspector support for Playbook and BlackBerry smartphone devices running
BlackBerry OS 7.0 and above. Additionally, you can access your
application's logs (including any calls to <code>console.log</code>) on your device
by holding down the ALT key from the home screen and hitting "lglg"
keys.</p>
</div>
</div>
<!-- Functionality and Syntax Highlighting -->
<script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
</body>
</html>