Command-line interface

Install

Install the release package served by raiql.dev. Node.js 20 or newer is required.

npm install -g https://www.raiql.dev/downloads/raiql-cli-0.7.0.tgz
raiql --version

Initialize a project

Create a complete RAIQL project instead of manually creating a source file.

raiql init commerce-core
cd commerce-core
raiql validate

init creates app.raiql, raiql.config.json, a project README and gitignore. Memory is the default zero-setup template; use --template postgres for PostgreSQL + Prisma persistence, or --template secure for PostgreSQL plus executable JWT authentication, roles and access rules.

Project configuration

{
  "$schema": "https://www.raiql.dev/schema/raiql.config.schema.json",
  "version": "0.7",
  "source": "app.raiql",
  "output": "generated",
  "install": true
}

Commands discover this file from the current directory or a parent directory. The configured output is treated as RAIQL-managed and may be safely regenerated.

Validate & compile

raiql validate
raiql validate --json
raiql compile

You can still pass an explicit source path for scripts or one-off specifications.

Generate

raiql generate

The project output defaults to generated/. Re-running generation replaces that managed directory without requiring --force.

Development server

dev regenerates the project, installs dependencies when needed and starts the generated application's development command.

raiql dev

Build

raiql build

Build performs generation, dependency preparation and the generated application's production build.

Explicit-file mode

RAIQL 0.7 keeps the explicit-file workflow for CI and standalone source files.

raiql validate ./specs/commerce.raiql
raiql generate ./specs/commerce.raiql -o ./commerce --force