Articles in this section
The Process Designer Data Source Designer VTAP - App Creator Vtiger Add-ons Publisher Insights Designer VTAP Release Notes VTAP Tables

VTAPIT - Command line tool

V
Vikas Kumar
19 Jun, 2023 - Updated  1 year ago

Introduction

VTAPIT is a Command line tool that enables you to develop and manage VTAP Apps created from the App Creator (Platform > Apps). It has sub-commands similar to the GIT tool, which makes it easy to learn and get started.

Get Started

Sub-commands

Clone

Makes a copy of the application created in the CRM to your local working directory.

Run

Enables runtime on the local working directory, which uses local files and CRM Apis for data.

Add

 Lets you add newly created local files to the CRM app. 

Push

Uploads all the local changes (add or modify functions) made to the files to the CRM app.

Pull

Downloads all the changes from the CRM app back to a local working directory.

A conflict marker file is created if a file has changed in the CRM but not in the local directory. You need to use the diff tool to compare changes and then use the Resolve sub-command.

Resolve  

Indicates conflict (diff) changes you have managed to review.

Publish

When all local changes are pushed - use this sub-command to make it available.

 

Clone

This will copy the files of the custom app to your local system. 
vtapit clone --crmapp=testapp --crmurl=https://your.odx.vtiger.crm --crmuser=[email protected] --crmpassword=******** local_dir/testapp

Run

This command will run the custom app on your local server. After running this command, you can access it http://localhost:8080/myapps/YOUR_APPNAME 
cd local_dir/testapp
vtapit run --crmurl=
https://your.odx.vtiger.crm --crmuser=[email protected] --crmpassword=********

Add

This command will add a new file to your application.
cd local_dir/testapp
vtapit add path_to_new_file


Push

This command will send the updated files and commit them to the app creator.
cd local_dir/testapp
vtapit push --crmurl
=https://your.odx.vtiger.crm --crmuser=[email protected] --crmpassword=********

Pull

This command will pull the changes done on the app creator by other developers to your local copy.
cd local_dir/testapp
vtapit pull --crmurl=https://your.odx.vtiger.crm --crmuser=[email protected] --crmpassword=********
 

Resolve

In case of conflict resolution, this command will mark the file path to resolve so it can be published to the app creator.
cd local_dir/testapp
vtapit resolve path_to_file
 

Publish

Send the changed files to the app creator and publish them for the users to view the new changes to the app.
cd local_dir/testapp
vtapit publish --crmurl=https://your.odx.vtiger.crm --crmuser=[email protected] --crmpassword=********

 

Note: You can set up CRM environment variables to avoid repeating on the command line.

CRM_URL=https://crm.url.tld

[email protected]

CRM_PASSWORD=pass

CRM_APP=appname

Home Privacy Policy Terms of Service Security Center Policy & Legal Center Contact Us
© Copyright 2025 Vtiger. All rights reserved.
Powered by Vtiger
Facebook Twitter Linkedin Youtube