blob: 7c902976b7b84d8334c904dc6ecc2a9e5c882e28 [file] [log] [blame] [view]
<!--
#
# 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.
#
-->
Bash shell support
==================
Cordova CLI comes bundled with a script which provides command-line tab-completion for Bash. If you're running a sufficiently
Unix-y operating system (Linux, BSD, OS X) you can install this to make typing cordova command lines easier.
Installation
------------
### Linux
To install on a Linux or BSD system, copy the `scripts/cordova.completion` file to your `/etc/bash_completion.d` directory. This will be read the next time you start a new shell.
### OS X
On OS X, put the `scripts/cordova.completion` file anywhere readable, and add the following line to the end of your `~/.bashrc` file:
source <path to>/cordova.completion
This will be read the next time you start a new shell.
Usage
------
It's easy! As long as your command line begins with an executable called 'cordova', just hit `<TAB>` at any point to see a list of valid completions.
Examples:
$ cordova <TAB>
build compile create emulate platform plugin prepare serve
$ cordova pla<TAB>
$ cordova platform <TAB>
add ls remove rm
$ cordova platform a<TAB>
$ cordova platform add <TAB>
android blackberry ios wp7 wp8 www
$ cordova plugin rm <TAB>
$ cordova plugin rm org.apache.cordova.<TAB>
org.apache.cordova.file org.apache.cordova.inappbrowser