CLI
Installation
Install the Laioutr CLI globally:
pnpm install -g @laioutr/cli@latest
Or run commands directly without installing:
npx @laioutr/cli@latest <command>
Global flags
All commands accept these flags:
| Flag | Env variable | Default | Description |
|---|---|---|---|
--cockpitApiHost | COCKPIT_API_HOST | https://cockpit.laioutr.cloud | Cockpit API host |
--cwd | CWD | Current directory | Working directory |
Authentication
Some commands require authentication. Two mechanisms exist depending on the command:
- Project secret — used by
rc fetchto download project configuration. Find it in the Cockpit under Settings > Project Secrets. - Organization API key — used by
app releaseanddeploycommands. Create one in the Cockpit under Organization Settings > API Keys. Pass via--keyflag orLAIOUTR_API_KEYenvironment variable.
Commands
rc fetch
Fetches the laioutrrc.json of a project from the Cockpit API.
laioutr rc fetch -p <org>/<project> -s <projectSecret> [filename]
| Flag / Arg | Required | Default | Description |
|---|---|---|---|
-p, --project | Yes | — | <organization slug>/<project slug> |
-s, --projectSecret | Yes | — | Project secret key |
-e, --environmentName | No | main | Environment name |
filename | No | laioutrrc.json | Output file path |
rc update
Updates an existing laioutrrc.json with the latest data from the Cockpit API. Reads project and secret from the laioutr metadata inside the file, so no flags are needed.
laioutr rc update [filename]
| Flag / Arg | Required | Default | Description |
|---|---|---|---|
filename | No | laioutrrc.json | File to update |
app release
Publishes an app version to the Laioutr platform. Run this from the app's package directory after the npm package has been published.
laioutr app release --key orgKey_xxx
The command reads name, version, and peerDependencies from package.json and extracts configSchema from src/module.ts automatically.
| Flag | Required | Default | Description |
|---|---|---|---|
-k, --key | Yes | — | Organization API key (LAIOUTR_API_KEY) |
-c, --channel | No | Auto-detected | Release channel: stable or testing. Pre-release versions default to testing. |
deploy trigger
Triggers a project deployment and polls until completion.
# Production deployment
laioutr deploy trigger --project <org>/<project> --key orgKey_xxx
# Preview deployment with app version override
laioutr deploy trigger \
--project <org>/<project> \
--key orgKey_xxx \
--preview my-feature \
--with-app @laioutr-app/[email protected]
# Preview deployment with app version and config overrides
laioutr deploy trigger \
--project <org>/<project> \
--key orgKey_xxx \
--preview test-new-store \
--with-app @laioutr-app/[email protected] \
--with-app-config '@laioutr-app/shopify={"shopId":"99900011122","storeDomain":"staging.myshopify.com","publicAccessKey":"074478fbce..."}'
| Flag | Required | Default | Description |
|---|---|---|---|
--project | Yes | — | <organization slug>/<project slug> |
-k, --key | Yes | — | Organization API key (LAIOUTR_API_KEY) |
--preview [name] | No | — | Create a preview deployment with an optional label |
--with-app | No | — | Override an app version for this deployment (repeatable) |
--with-app-config | No | — | Override app config JSON for this deployment (repeatable, requires --with-app) |
--no-wait | No | — | Exit immediately after triggering instead of polling |
--json | No | — | Output final state as JSON |
deploy status
Shows the status of a specific deployment.
laioutr deploy status --project <org>/<project> --key orgKey_xxx --deploymentId dep_abc123
| Flag | Required | Default | Description |
|---|---|---|---|
--project | Yes | — | <organization slug>/<project slug> |
-k, --key | Yes | — | Organization API key (LAIOUTR_API_KEY) |
--deploymentId | Yes | — | Deployment ID to check |
--json | No | — | Output as JSON |
deploy list
Lists recent deployments for a project.
laioutr deploy list --project <org>/<project> --key orgKey_xxx
| Flag | Required | Default | Description |
|---|---|---|---|
--project | Yes | — | <organization slug>/<project slug> |
-k, --key | Yes | — | Organization API key (LAIOUTR_API_KEY) |
--json | No | — | Output as JSON |