Skip to content

Commands

Complete reference for all gwen CLI commands.

Installation

Install the CLI globally to use the gwen command anywhere:

bash
npm install -g @gwenjs/cli
bash
pnpm add -g @gwenjs/cli
bash
yarn global add @gwenjs/cli

Or run it directly without installing:

bash
npx @gwenjs/cli <command>
bash
pnpm dlx @gwenjs/cli <command>
bash
yarn dlx @gwenjs/cli <command>

Global Options

Available on every command:

OptionAliasTypeDescription
--verbose-vbooleanShow detailed logs
--debugbooleanShow debug information (very verbose)

All Commands

CommandDescription
gwen initScaffold a new GWEN game project
gwen devStart development server with hot reload
gwen buildBuild project for production
gwen prepareGenerate .gwen/ directory (tsconfig + types)
gwen previewPreview the production build locally
gwen addInstall and register a GWEN module
gwen scaffoldScaffold artefacts (plugin, module, package)
gwen lintLint source code with oxlint
gwen formatFormat source code with oxfmt
gwen infoShow parsed gwen.config.ts as JSON
gwen doctorRun project health checks