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:

Use kebab-case for long flag names. The previous camelCase forms remain available as deprecated aliases for compatibility.

Authentication

Some commands require authentication. Two mechanisms exist depending on the command:

• Project secret — used by rc fetch to download project configuration. Find it in the Cockpit under Settings > Project Secrets.
• Organization API key — used by app release and deploy commands. Create one in the Cockpit under Organization Settings > API Keys. Deployment commands require the project:deploy scope. Pass the key via the --key flag or LAIOUTR_API_KEY environment variable.

Output and errors

The CLI removes ANSI color sequences from deployment logs when output is redirected or piped. You can also disable color with --no-color, a non-empty NO_COLOR environment variable, or TERM=dumb.

API requests time out after 30 seconds. Authentication, missing-resource, rate-limit, server, network, and invalid-response failures include an actionable message without exposing the API response body.

Deployment commands support --json. Errors in JSON mode use a structured object that CI scripts can parse:

{
  "error": {
    "code": "HTTP_RESPONSE_ERROR",
    "message": "Laioutr API authentication failed (401 Unauthorized). Check the API key and required permissions, then try again.",
    "status": 401
  }
}

Commands

rc fetch

Fetches the laioutrrc.json of a project from the Cockpit API.

laioutr rc fetch -p <org>/<project> -s <project-secret> [filename]

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]

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.

deploy trigger

Triggers a project deployment. By default, the command waits for the deployment to complete.

# Production deployment
laioutr deploy trigger --project <org>/<project> --key orgKey_xxx

# Return immediately after triggering
laioutr deploy trigger --project <org>/<project> --key orgKey_xxx --no-wait

# Stream build logs while waiting
laioutr deploy trigger --project <org>/<project> --key orgKey_xxx --logs

# Named preview deployment
laioutr deploy trigger \
  --project <org>/<project> \
  --key orgKey_xxx \
  --preview my-feature

deploy status

Shows the status of a specific deployment.

laioutr deploy status --project <org>/<project> --key orgKey_xxx --deployment-id dep_abc123

deploy logs

Fetches and displays build logs for a deployment.

laioutr deploy logs --project <org>/<project> --key orgKey_xxx --deployment-id dep_abc123

deploy list

Lists recent deployments for a project.

# Use the default limit of 20 deployments
laioutr deploy list --project <org>/<project> --key orgKey_xxx

# Return up to 50 deployments
laioutr deploy list --project <org>/<project> --key orgKey_xxx --limit 50