appcelerator

Appcelerator CLI

This software is pre-release and not yet ready for usage. Please don't use this just yet while we're working through testing and finishing it up. Once it's ready, we'll make an announcement about it.

This Appcelerator command line interface.

Install

$ [sudo] npm install -g appcelerator

Usage

≫ appc
Appcelerator Command-Line Interface, version 0.0.4
Copyright (c) 2014, Appcelerator, Inc.  All Rights Reserved.

  Usage: appc cmd [options]

  Commands:

    access <get|set> [options]           get or set access in platform
    config <get|set|list> [key] [value]  get, set, and list configuration settings
    generate [options]                   create a component
    help [cmd]                           display help for [cmd]
    install [options]                    install a component
    login [options]                      login to platform
    logout [options]                     logout of platform
    new [options]                        create a new project
    publish [options]                    publish a project or component
    run <app|server> [options]           run a project
    search [options]                     search for components
    unpublish [options]                  unpublish a project or component
    whoami                               get the current platform user

  Options:

    -h, --help               output usage information
    -V, --version            output the version number
    -l, --log-level <level>  set the log level
    --no-banner              disable banner

CLI Plugins

CLI plugins are identifed by the appc-cli-plugin in the package.json's keywords.

package.json

{
    "keywords": {
        "appc-cli-plugin"
    }
}

The ability to add/update commands and functionality is made possible through functions exposed in a module's appc.js file.

Add a command

appc.js

exports.command = function command(program) {
    program.command('mycommand [options]', 'description of your command');
};

Augment an existing command

When augmenting an existing command, your module must include the appc-cli-plugin keyword, have the appc.js file, and in it expose an object matching the name of the command you wish to augment.

For example, if you wanted to add a new client entry to the new command, you might do the following:

appc.js

exports.new = {

    // "new" command specific properties
    type: 'client',
    name: 'Titanium Classic App',

    // make any necessary updates to the command object
    command: function(program) {
        program.options('-s, --sdk <sdk>', 'titanium sdk to use');
    },

    // the code to be executed if this plugin is used by the "new" command
    execute: function(config, callback) {
        // execute the titanium "new" command
        return callback();
    }
};

Associated projects

Name	type	Description
apibuilder	plugin	API Builder + appc-cli plugin
appc-cli-titanium	plugin	titanium CLI appc-cli plugin

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Licensing

This software is licensed under the Apache 2 Public License. However, usage of the software to access the Appcelerator Platform is governed by the Appcelerator Enterprise Software License Agreement.