Getting Started with the Insites CLI Tool

This guide takes you from nothing to a working setup: install the CLI, connect it to your instance, deploy your project and keep it in step as you edit. It describes the CLI 6.4.1.

Step 1: Check Node.js

The CLI needs Node.js 22 or newer. Node 24 is recommended. Check your version:

node --version

If it is older than 22, install a newer Node from nodejs.org or with a version manager such as nvm. On an older Node, npm installs an older CLI, and that release tells you to upgrade.

Step 2: Install the CLI

npm i -g @insites/insites-cli --no-fund

--no-fund is optional. It hides npm's note about packages that accept donations. Check that it works:

insites --version

insites is a short name for insites-cli. Both do the same thing. If your terminal says the command is not found, see Troubleshooting.

Step 3: Find Your Instance UUID

To use the CLI on an instance, you need the Developer role or above on it.

1. Sign in to the Insites Console.
2. Open Instances and select your instance.
3. Open the CLI Commands tab. It shows the instance UUID and the commands to add the instance.

Step 4: Add an Environment

An environment is a name for one instance, such as staging. Go to your project folder and run:

insites env add staging --instance-uuid <instance-uuid>

Your browser opens the Insites Console sign-in. Check that it shows the same code as your terminal, then approve. The CLI saves the environment in a .insites file in that folder. Add .insites to your .gitignore, because it holds your sign-in.

You can add several environments to one project, for example staging for testing and production for the live site, and deploy the same code to each.

To sign in with an access token instead of the browser, copy the command from the instance's CLI Commands tab. See Commands and Options.

Step 5: Create the Project Folders

Skip this step if your project already has an app/ folder.

insites init

Step 6: Check Your Setup

insites doctor

It checks Node.js, the CLI version, the .insites file, each environment's sign-in and the instance, and prints the command that fixes each problem.

Step 7: Deploy

insites deploy staging

The CLI prints a report: for each type of file, how many were upserted, deleted and skipped. To see what would change first, add --dry-run.

Step 8: Sync While You Work

insites sync staging

Sync watches your files and sends each change to the instance when you save it. Press Ctrl+C to stop.

Step 9: Connect Your AI Assistant

If you use Claude Code, Cursor or VS Code, connect it to Insites:

insites ai init

See Connect Your AI Assistant.

Next Steps

• Commands and Options
• Graphical User Interface
• Linting Rules