Console · Sites
CLI Commands and Logs
Last updated 18 November 2026
Copy ready-made CLI commands for a site, and read its logs.
The CLI Commands tab of a site lists the Insites CLI commands you need to work on that site from your own machine, ready to copy. The CLI deploys configuration files and assets to the site from your terminal.
The CLI Commands and Logs tabs are developer tools. They show for the Developer role and above. A Viewer or Editor does not see them.
Opening the Tab
- Navigate to Sites from the main menu.
- Find the site on the main page or inside a folder, and select it.
- Select the CLI Commands tab.
Each command has a Copy to clipboard button. Where a command needs details of this site, such as its UUID or your email, the Console fills them in. Replace <environment-name> with a short name you choose for the site on your machine.
Set Up the CLI
| Step | Command |
|---|---|
| Install the CLI | npm install -g @insites/insites-cli |
| Add this site as an environment | insites-cli env add <environment-name> --email <your-email> --instance-uuid <instance-uuid> |
| List environments | insites-cli env list |
| Open the CLI interface | insites-cli gui serve <environment-name> |
| Update the CLI | npm update -g @insites/insites-cli. Run it as administrator on Windows, or with sudo on macOS and Linux. |
The CLI connects with your personal CLI token. You find it on your My profile page, in the account menu, under CLI token. Do not share it. Regenerate it if it may have been exposed.
Site Commands
| Command | What it does |
|---|---|
insites-cli sync <environment-name> | Uploads each file as you save it, so the site matches your local code. |
insites-cli deploy <environment-name> | Uploads all local changes to the site in one go. |
insites-cli audit | Checks the files in your application directory for deprecations, syntax errors and recommendations. |
insites-cli logs <environment-name> | Streams the site's errors and logs to your terminal. |
Module Commands
These commands manage modules installed from the marketplace or the platform. Modules you deploy from your own modules/ directory are managed with your files instead.
| Command | What it does |
|---|---|
insites-cli modules list <environment-name> | Lists the modules installed on an environment. |
insites-cli modules init <module-name> | Creates a module from the starter repository. |
insites-cli modules pull <environment-name> <module-name> | Downloads one installed module to your machine. |
insites-cli modules remove <environment-name> <module-name> | Removes a module from the site, including its configuration and its data. |
Access Token
The last card on the tab is Access Token: a token for one site that a script or the CLI can use. See Site Access Tokens.
Reading the Logs
To read a site's errors and logs, run insites-cli logs <environment-name> from your terminal. It streams new entries as they happen.
For every CLI command and option, see the Insites CLI overview.