tidev / gittio

Search & Install all Titanium Modules and Alloy Widgets on GitHub
http://gitt.io
Other
24 stars 19 forks source link
keep npm-package

gitTio CLI Titanium Alloy

Command-line package manager for Appcelerator Titanium modules & Alloy widgets, powered by the gitTio search engine that indexes all open source components (modules and widgets) on GitHub.

A screencast demonstrating gitTio can be found at: http://youtu.be/Tgyfo8YHKxk

Quickstart gitTio npm

  1. Install gitTio using NPM:

    [sudo] npm install -g gittio
  2. Install missing (versions of) modules and widgets required in tiapp.xml and app/config.json and use the global path for modules:

    ~/myproject $ gittio install -g
  3. Install the latest version of a component and add it to tiapp.xml or app/config.json:

    ~/myproject $ gittio install -g facebook
    ~/myproject $ gittio install nl.fokkezb.loading

Commands

Use gittio or gittio -h for full usage, but this covers 80%:

info

Looks up a component at gitt.io and displays or returns the info.

install

Installs all required or a specific component/version/platform.

Examples:

update

Updates all components to their latest versions.

Examples:

uninstall

Uninstalls a specific component/version/platform.

Examples:

demo

Demos a module by creating a project with the module example included.

~ $ gittio demo dk.napp.drawer -p ios

Options

Use gittio or gittio -h for full usage, but this covers 80%:

-g, --global

Searches and installs modules under the global module path (~/Library/Application Support/Titanium/modules on the Mac).

-f, --force

Forces install of components even if they are already found. When you specify a version to install this option is set automatically.

-p, --platform

Searches and installs modules only for the specified platform.

-t, --type

Installs or updates only missing components for type (module or widget).

-o --output json

Output result of info command as json.

-b --alloy-base

Base directory for alloy. Default is 'app'.

Per Project Configuration

Add a .gittiorc or compatible rc configuration file to your project folder.

{
  "alloyBase": "src"
  "platform": "ios"
}

There are currently only two supported options listed above. Command line options take priority over these options.

Configuration

Starting version 1.4, there's also a config command to override default configuration settings. At the moment, the only - but crucial - setting is registry.url which lets you instruct the CLI to talk a different registry then gitTio's, as long as it follows the same format.

~ $ gittio config registry.url http://registry.mycompany.com

Bugs

When you find issues, please report them. Be sure to include all of the output from the gittio command that didn't work as expected. Also please check if there's not already in issue for it.

Legal Stuff

The gitTio search engine, registry and CLI are owned by Fokke Zandbergen. All rights reserved. See the included LICENSE file for more details.

Appcelerator, Titanium and Alloy are trademarks owned by Appcelerator, Inc.. gitTio is not officially part of, owned by nor officially affiliated with Appcelerator.

The components in the gitTio registry are not part of gitTio itself, and are the sole property of their respective creators. There is absolutely no guarantee, warrantee, or assertion made as to the quality, fitness for a specific purpose, or lack of malice in any given component. Components exposed via gitTio are not affiliated with or endorsed by Fokke Zandbergen or Appcelerator.