tix-cli

TixCli is a command line interface to interact with GitHub Authorization API and perform setup and deployment of private TixInc repositories.

No Shell?

Full Install (Windows command prompt)

@PowerShell -NoProfile -ExecutionPolicy unrestricted -Command "If(Test-Path %TEMP%\t.ps1){rm %TEMP%\t.ps1};((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/TixInc/tix-cli/master/src/ps1/download-src.ps1?$(Get-Random)'))|Out-File %TEMP%\t.ps1;%TEMP%\t.ps1 -Install -CleanSource -CleanLocal;rm %TEMP%\t.ps1" && exit

Shell?

Basic Install

npm install -g tix-cli

Install and start interactive tix shell

npm install -g tix-cli && tix

Install with optional dependencies and and start tix shell extended (private repository and deployment access)

npm install -g tix-cli && tix -ox

Table of Contents

• Setup
  • Windows
  • Linux / OSX
  • Any OS
• Usage

Setup

• The TixCli and other TixInc applications require Git and Node.js on the local machine. If the machine does not yet have these dependencies, jump to the OS specific section (Windows or Linux / OSX) and run the oneliner. You will be prompted to enter a username and password so that the TixCli can acquire a GitHub api token to use on your behalf.

• If the local machine already has Git and Node.js, jump to the Any OS section and run the oneliner in a shell.

Windows

Copy/paste the oneliner below into Administrator command prompt to get Git / Node.js and TixCli installed:

@powershell -NoProfile -ExecutionPolicy unrestricted -Command "((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/TixInc/TixCli/master/bin/tix-full-install.ps1'))"|$_

Linux / OSX

Instructions coming soon...

Any OS

If Git and Node.js are installed on the local machine, run this oneliner at git bash or linux shell to install the CLI:

npm install -g tix-cli

Usage

After running the setup steps above, you should eventually be prompted with a command prompt "TIX>" which means the CLI has been setup and is ready to use. You can use the command "?" to list basic information about all the supported commands.

The CLI can be modified by changing the config object literal at the top of the tix-cli.js file. The default uses this configuration:

var config = {
  platform: getPlatform(),
  basePath: {
    windows: 'c:',
    linux: process.env['HOME']
  },
  installPath: 'TixInc',
  path: {
    cliDir: 'TixCli',
    npmDir: 'npm',
    jsDir: 'TixInc.js',
    netDir: 'TixInc.Net',
    classicDir: 'TixInc.Classic',
    cliFile: 'tix-cli.js',
    tokenFile: 'token.json'
  },
  npmDependencies: [
    'minimist',
    'shelljs',
    'lodash',
    'colors',
    'read',
    'q',
    'ftp'
  ],
  flags: {
    cleanIfNotCliWorkingDir: true,
    promptToInstallDependencies: false
  }
};

The TixCli by default gets installed to ~/TixInc/TixCli. Other TixInc applications will get installed by TixCli to the TixInc directory for the respective platform.

After the initial install, the CLI may be run again at any time by executing tix in a shell.

Below are some of the supported commands by TixCli: ->