This module provides a cross-platform command line interface for developers and IT administrators to create, protect and manage Quixxi based mobile applications.

Features

  • Create app in Quixxi
  • Add packages to app
  • Protect the app using Quixxi protection
  • Download the protected app
  • Integrate Quixxi with your existing CI process using this CLI

Installation

Nodejs

Quixxi CLI is nodejs package, just follow the below instruction to complete the nodejs installation.Please skip this section if you already have nodejs installed.

Verify node js installation

Run following command on your shell Or command prompt to check the version of installed nodejs.

$ node --version


The above command will display the node version installed, if the version is 6.9.2 or above you are good to go with quixxi cli.

Installing Quixxi-CLI

Run following command on your shell Or command prompt to install quixxi-cli.
Please run command prompt as admin user if you are installing on winodws machine.

$ npm i quixxi-cli -g


note -g flag, this will install the package globally on the machine


Available Commands  


Login     

        Login to your Quixxi account        


Usage     

        login <username> <password>    


List Apps     

        Shows list of apps under your Quixxi account       


Usage        

        list apps       


Create App      

        Creates a new app under your account in Quixxi.         


Usage      

        create app <appName>          


List Packages   

        Shows list of packages available in Quixxi        


Usage      

        list packages


Output

Package Name
Supported platforms
Security
Android ,iOS  
Licensing
Android  
Analytics
Android ,iOS ,.NET UWP ,Web ,tvOS
Patch
iOS
Quixxi360
Android ,iOS ,Web ,tvOS
Audio  
Android ,iOS  
ANPR  
Android ,iOS  


List Platforms      

        Shows list of platforms supported by Quixxi           


Usage       

        list platforms            


Output

Platform Name
Android
iOS
Web
tvOS
.NET UWP
HoloLens(Unity)


Add Package     

        Adds package to your app in Quixxi

     

Usage        

        add package <packageName> <platformName> <appIdOrName> <appPackageName>             


Example      

        add package analytics android MyApp com.mycompany.myapp          


Output        

        Creates analytics package to your android MyApp            


Protect App     

        Wraps android apk file using quixxi security, and creates output as zip file           


Usage       

        protect androidApp [options] <appIdOrName> <apkFileName> [outputFileName]            


Example        

        protect androidApp MyApp /Users/MyName/MyApp/MyApp.apk   /Users/MyName/MyApp/Output/MyApp.zip             


Output        

        MyApp.zip is generated with protected unsigned version of your app.            


List CloudProtections    

        Shows list of cloud protections enabled/disabled for the app       


Usage     

        list cloudProtections for <appIdOrName>          


Example     

        list cloudProtections for MyApp        


Output

Title
Name
Enabled
Report user and device usage
reportUserAndDeviceUsage
Yes
Block, Unblock & Notify Users
blockUnblockAndNotifyUsers
Yes


Enable CloudProtections   

        Enable analytics,cloud protection option to your app before protecting the app   


Usage  

        enable cloudProtections for <appIdOrName> [listOfItemsToEnable...]   


Example   

        enable cloudProtections for MyApp reportUserAndDeviceUsage   


Output 

        success list cloudProtections for MyApp


Title
Name
Enabled
Report user and device usage
reportUserAndDeviceUsage
Yes
Block, Unblock & Notify Users
blockUnblockAndNotifyUsers
No


Note: Enable/Disable Cloud protection options can be applied only for Enterprise Customers


Disable CloudProtections

        Disable analytics,cloud protection option to your app before protecting the app   


Usage  

        disable cloudProtections for <appIdOrName> [listOfItemsToDiable...]   


Example   

        disable cloudProtections for MyApp reportUserAndDeviceUsage   


Output 

        success 

        list cloudProtections for Sample App

Title
Name
Enabled
Report user and device usage
reportUserAndDeviceUsage
No
Block, Unblock & Notify Users
blockUnblockAndNotifyUsers
No


List ProtectionOptions    

        Shows list of protection options enabled/disabled for the app     


Usage    

        list android protectionOptions for <appIdOrName>       


Example  

        list android protectionOptions for MyApp   


Output

Title
Name
Value
Enable Resource Encryption
encryptResourceFiles
1
Use native hash table
buildNativeHashTable
1
Use offset Randomization
buildOffsetRandomization
1
Use Secure Process
secureAppProcess
1
Remove unused resources
removeUnusedResources
1
SSL pinning Urls
sslPinning


Set ProtectionOptions  

        Sets android protection options for the app before securing the app     


Usage    

        Sets android protection options for <appIdOrName> <optionName> [optionValue]       


Example      

        set android protectionOptions for MyApp encryptResourceFiles 0          


Output      

        Configuration Updated       

                list android protectionOptions for Mypp

Title 
Name 
Value
Enable Resource Encryption
encryptResourceFiles
0
Use native hash table
buildNativeHashTable
1
Use offset Randomization
buildOffsetRandomization
1
Use Secure Process
secureAppProcess
1
Remove unused resources
removeUnusedResources
1
SSL pinning Urls
sslPinning


Download App  

        Download the latest version of your protected app     


Usage     

        download protectedAndroidApp <appIdOrName> [outputFileName]        


Example      

        download protectedAndroidApp MyApp/Users/MyName/MyApp/Output/MyApp.zip             


Output        

        MyApp.zip is generated with protected unsigned version of your app.     


Logout  
        Logout from your Quixxi account      


Usage    

        logout  


Help   

        Provides help for a given command.      


Usage      

        help [command...]           


Output       


Commands:

  help [command...]                                                           Provides help for a given command.
    exit                                                                        Exits application.
    login <username> <password>                                                 Login to your Quixxi account
    logout                                                                      Logout from your Quixxi account
    list apps                                                                   Shows list of apps
    create app <appname>                                                        creates an app
    list packages                                                               Shows list of apps
    list platforms                                                              Shows list of platforms supported by quixxi
    add package <packageName> <platformName> <appIdOrName> <appPackageName>     Add package to app
    protect androidApp [options] <appIdOrName> <apkFileName> [outputFileName]   Wraps android apk file using quixxi security, and creates output as zip file
    download protectedAndroidApp <appIdOrName> [outputFileName]                 Download last protected file
    list cloudProtections for <appIdOrName>                                     Shows list of cloud protections enabled/disabled for the app
    disable cloudProtections for <appIdOrName> [listOfItemsToDisable...]        Disables all cloud protections OR specified in the list.
                                                                                You can get list of items by executing "list cloudProtections" command
    enable cloudProtections for <appIdOrName> [listOfItemsToDisable...]         Enables all cloud protections OR specified in the list.
                                                                                You can get list of items by executing "list cloudProtections" command
    list android protectionOptions for <appIdOrName>                            Shows list of protection options enabled/disabled for the app
    set android protectionOptions for <appIdOrName> <optionName> [optionValue]  Sets android protection options


Exit    

        Exits the Quixxi prompt        


Usage      

        exit