HELIX 3 Docs
CLI & AI tools

HELIX CLI

Scaffold, run, validate, and deploy HELIX worlds from the terminal — the same commands humans and AI agents use.

The @helix/cli is the front door for building worlds. It scaffolds projects, runs them locally with a real instance, validates against platform rules, and deploys immutable builds.

npm install -g @helix/cli
# or: npx @helix/cli <command>

Commands

Prop

Type

Typical loop

npx @helix/cli create my-world --template multiplayer-starter
cd my-world && npm install
helix dev                # iterate
helix validate           # catch issues early
helix deploy             # ship a build, get a link

Templates

Templates are starting points wired with the SDK, a server HelixInstance, and sensible manifest scopes. Start from one rather than an empty directory.

Auto-generated reference

The CLI is also where the docs pipeline lives. On every merge to main:

The Web SDK reference is generated from the @helix/sdk TypeScript source with TypeDoc.

The Native SDK reference is generated from the Unreal plugin headers with Doxygen, then mapped to Blueprint / PuerTS / UnLua.

The /llms.txt index and /llms-full.txt bundle are rebuilt, and the site is deployed.

This is what keeps Web reference and Native reference in sync with shipped code. See the repo's .github/workflows/deploy.yml and CONTRIBUTING.md for the exact pipeline.

For AI agents

Agents drive the same CLI — and get a richer interface through the MCP server, which exposes discovery, validation, and publishing as tools.

On this page