Insites CLI Tool Overview

The Insites CLI Tool () is a Node.js command-line tool that connects your project on your computer to your Insites instances. It deploys and syncs your code, manages data, constants and modules, runs Liquid and GraphQL, and checks your code. Install it, or update it to the latest release, with .

Key Features

• Sign in through the Insites Console - Add an instance with its UUID and approve the sign-in in your browser. The CLI never stores the instance key, so removing someone's access in the Console stops their next command. You can also sign in with an access token from the Console, which records every deploy against your name.
• Deploy code and assets - Send your project to any instance with one command. After each deploy, the CLI prints how many files of each type were upserted, deleted and skipped.
• Dry run - Check a release on the instance and see what would change before you deploy it. Every error is listed at once, with its file path.
• Live file sync - While you develop, sync watches your files and sends each change to your instance as soon as you save it.
• Check your setup - checks Node.js, the CLI version, your environments, their sign-in and the instances, and tells you how to fix each problem.
• Run Liquid and GraphQL - Run a Liquid snippet or a GraphQL query on an instance from your terminal, without deploying a file.
• Data export and import - Export all the data on an instance to a zip file, and import JSON or zip files. Useful for backups, moves between instances, and seeding a staging instance.
• Constants - Set, remove and list the constants on an instance, such as API keys.
• Modules - List, download, start and remove modules.
• Linting and code audit - The linter reports Liquid errors, unknown filters, missing partials, and pages that take an address they should not. It also runs in your editor. The audit reports deprecated code before each deploy.
• Live logs - Follow an instance's logs with , filter them by type, or print them as JSON.
• GUI - Open a local web interface with a GraphQL editor, a Liquid editor, and views of your data, constants and logs.
• Migrations - Generate, list, run, check and retry migrations: Liquid scripts that run once on each instance to set up or change data. Table schemas come from your schema files, not from migrations.
• JSON output for scripts and AI agents - Many commands print JSON with .

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 sync while you develop on a staging instance, and deploy to release to staging or production. See Development Workflow.

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 - The local web interface for GraphQL, Liquid, data, constants and logs.
• Linting Rules - What the linter and the audit check, the linter configuration file, and the addresses your pages should not take.
• Token Regeneration - How to regenerate your CLI token if it expires or needs to be rotated.