CLI Overview

The sk-cli is the command-line tool for managing SiteKnock workspaces, projects, apps, locales, Studio, and licenses.

What the sk-cli is

sk-cli is the command-line companion to Studio. Use it to scaffold projects, manage apps and locales, run Studio, verify licenses, and download the knowledge base. Everything it does is also available in Studio's visual UI — pick whichever fits your workflow.

Install

npm install -g @siteknock/sk-cli

Commands

sk-cli --version                              # Show the installed version
sk-cli create [options]                       # Download + scaffold a new project
sk-cli app <create|list|remove> [options]     # Manage apps within a project
sk-cli locale <list|add> [options]            # Manage i18n locales
sk-cli studio <start|stop|restart|status>     # Run Studio
sk-cli verify [options]                       # Verify a license token
sk-cli probe [options]                        # Verify registry visibility
sk-cli kb dump [options]                      # Download the SiteKnock Common KB

Where to go next

Creating Projects

Scaffold a new project from your license.

Apps & Locales

Add and manage apps and languages.

Running Studio

Launch Studio in container or desktop mode.

Licensing

Verify and inspect license entitlements.

The sk-cli operates from a workspace — a base folder containing sk-cli.json and one or more project subfolders. See Workspaces & Projects.

Was this page helpful?