Titanium CLI
Titanium CLI is a Command Line Tool for creating and building Titanium Mobile applications and modules. It's open-source and easy to use. We've designed Titanium to be suitable for command line beginners, but still be powerful and extensible enough for production usage.
Prerequisites
The Titanium CLI requires Node.js 14 or newer.
Installation
[sudo] npm install -g titanium
After install, Titanium CLI is executable as ti
Obtaining a Titanium SDK
You will need to download a Titanium SDK:
# stable release (recommended)
titanium sdk install --default
Setting up the Titanium CLI
Before you begin using the Titanium CLI, you should configure it by running the "setup" command:
titanium setup
Usage
titanium <command> [options]
Built-in Commands
config
Configure your CLI settings.
Implementation not complete
titanium config <setting> <value>
help
Displays help or help for a specific command.
ti
titanium help
titanium --help
titanium help <command>
titanium <command> --help
sdk
Download and install Titanium SDKs
sdk install
Installs a specific version of the Titanium SDK. If no version is specified, it assumes the latest.
titanium sdk install
titanium sdk install <version>
titanium sdk install <version> --force
Download, install , and set as default SDK.
titanium sdk install <version> --default
sdk uninstall
Uninstalls a Titanium SDK.
titanium sdk uninstall <version>
sdk list
Lists all installed Titanium SDKs. Optionally lists all branches and releases.
titanium sdk list
titanium sdk list -r
titanium sdk list --releases
setup
Reconfigures the Titanium CLI by asking you a series of questions.
titanium setup
version
Displays the current version of the CLI and exits.
titanium -v
titanium --version
info
Displays information about your development environment including Xcode installs, iOS SDKs, Android SDKs, and so on.
titanium info
titanium info -o json
Hacking the Titanium CLI
In order to begin hacking on the Titanium CLI, you need to download and install git.
If you have already installed a previous version of the Titanium CLI, it's recommended you uninstall the old one first:
[sudo] npm uninstall -g titanium
The Titanium CLI is essentially pure JavaScript, so there is no build process. You just need to pull the code and resolve the dependendencies.
git clone [email protected]:tidev/titanium.git
cd titanium
npm install
sudo npm link
Running Unit Tests
To run the unit tests, simply run:
node forge test
Running Code Coverage
To generate the code coverage, you first must install node-jscoverage. The easist way to do this is run:
git clone [email protected]:visionmedia/node-jscoverage.git
cd node-jscoverage
./configure
make
sudo make install
Then run:
node forge test-cov
It will generate a file called coverage.html in the Titanium CLI directory.
Contributing
Interested in contributing? There are several ways you can help contribute to this project.
New Features, Improvements, Bug Fixes, & Documentation
Source code contributions are always welcome! Before we can accept your pull request, you must sign a Contributor License Agreement (CLA). Please visit https://tidev.io/contribute for more information.
Donations
Please consider supporting this project by making a charitable donation. The money you donate goes to compensate the skilled engineeers and maintainers that keep this project going.
Code of Conduct
TiDev wants to provide a safe and welcoming community for everyone to participate. Please see our Code of Conduct that applies to all contributors.
Security
If you find a security related issue, please send an email to [email protected] instead of publicly creating a ticket.
Stay Connected
For the latest information, please find us on Twitter: Titanium SDK and TiDev.
Join our growing Slack community by visiting https://slack.tidev.io
Legal
Titanium is a registered trademark of TiDev Inc. All Titanium trademark and patent rights were transferred and assigned to TiDev Inc. on 4/7/2022. Please see the LEGAL information about using our trademarks, privacy policy, terms of usage and other legal information at https://tidev.io/legal.