Insites CLI Tool Commands and Options

All commands need to be run in the project root directory - one level above the or directory.

Deploy

This command deploys changes to your instance.

Sync Instance on File Change

This command automatically uploads code changes when you save a file, ensuring that the Instance mirrors the code changes you make with minimal manual intervention. To execute, enter the following command on the project root directory:

Graphical User Interface (GUI)

This command offers an integrated development environment for drafting and executing GraphQL queries and Liquid snippets and options to view your data, constants, and logs. The command establishes a direct connection to your environment, thus giving you access to a live preview of data derived from your application. As a result, the potential for errors that arise when data traverses other layers and features within the system is greatly reduced.

Code audit

This command runs statistical analysis on files in your current application directory to check your code for deprecations, recommendations, or syntax errors.

Module List (experimental)

This command lists all installed modules on a given environment. Note, however, that the command will not list modules that you deployed via the directory.

Module Initialize

This command creates a new module based on the module starter repository.

Module Pull

This command downloads the installed modules from a given environment.

Module Remove

This command removes a module from your application.

Reading logs (experimental)

This command pulls the logs from the server every few seconds and displays them in your command line.

Upgrade Version

This command upgrades the version of the Insites CLI tool you are using. You will need to use CMD as administrator or sudo if you are using a Unix-based system