Insites CLI Tool Overview

The Insites CLI Tool () is a Node.js command-line interface that connects your local development environment to your Insites instances. It handles deployments, live file syncing, data management, remote code execution, and much more. If you are building on Insites, the CLI Tool is your primary interface for getting code onto an instance and managing it once it is there.

Key Features

• Deploy code and assets - Push your local codebase to any Insites instance in a single command. The CLI handles file diffing, asset uploads, and build steps automatically.
• Live file sync - Run a sync process during development that watches for local file changes and pushes them to your instance in real time. No manual deploys needed while you work.
• Remote Liquid and GraphQL execution - Execute Liquid templates and GraphQL queries directly against a running instance from your terminal. Useful for debugging, data inspection, and one-off operations.
• Data export and import - Pull data out of an instance as JSON, and push it back in. Helpful for migrations, backups, and seeding environments.
• Instance constants management - View and update the constants (environment variables) configured on your instance without leaving the command line.
• Module management - List, download, create, and remove the modules available on your instance.
• Code auditing and linting - Run built-in lint rules against your codebase to catch common issues, deprecated patterns, and style violations before you deploy.
• Log searching and alerts - Search instance logs and set up alerts to monitor for specific events or errors.
• GUI mode - Launch a graphical interface for visual instance management when you prefer a browser-based workflow over the terminal.
• Migration management - Run and track database migrations across your instances to keep schemas in sync.

Getting Started

If this is your first time using the CLI Tool, follow these steps to get up and running:

1. Install the CLI Tool and configure your environment - The Getting Started guide walks you through installation via npm, authenticating with your instance, and running your first deployment.
2. Learn the available commands - Once installed, review the Commands and Options reference to understand what the CLI can do and the flags each command accepts.
3. Set up your development workflow - Use the sync command for local development and the deploy command for pushing to staging or production. The commands reference covers both in detail.

Learn More

Explore the CLI Tool documentation in detail:

• Getting Started - Installation, environment setup, authentication, and your first deployment.
• Commands and Options - The full command reference with all available flags and usage examples.
• GUI - Using the graphical interface for visual instance management.
• Linting Rules - The built-in code audit rules and how to use them to catch issues before deployment.
• Token Regeneration - How to regenerate your CLI token if it expires or needs to be rotated.