@gwenjs/cli

Command Line Interface for the GWEN Game Engine

Installation

# npm
npm install -g @gwenjs/cli

# pnpm
pnpm add -g @gwenjs/cli

# yarn
yarn global add @gwenjs/cli

Usage

gwen [command] [options]

Global options

Option	Alias	Description
--verbose	-v	Show detailed logs
--debug		Show debug information (very verbose)

Commands

Command	Description
gwen init [name]	Scaffold a new GWEN game project
gwen dev	Start development server with hot reload
gwen build	Build project for production
gwen prepare	Generate .gwen/ (tsconfig + types)
gwen preview	Preview the production build locally
gwen add <module>	Install and register a GWEN module
gwen scaffold	Scaffold artefacts (plugin, module, package)
gwen lint	Lint source code with oxlint
gwen format	Format source code with oxfmt
gwen info	Show parsed gwen.config.ts as JSON
gwen doctor	Run project health checks

📖 Full reference: gwenjs.github.io/cli

Quick start

Scaffold a project without installing the CLI globally:

# npm
npx @gwenjs/cli init my-game

# pnpm
pnpm dlx @gwenjs/cli init my-game

# yarn
yarn dlx @gwenjs/cli init my-game

# bun
bunx @gwenjs/cli init my-game

Then start developing:

cd my-game
pnpm install
gwen prepare
gwen dev

Development

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build
pnpm build

# Docs (dev server)
pnpm docs:dev

License

MIT