Starting new project

Node.js Requirements

Alokai requires Node.js 22 or higher. We recommend using a version manager like nvm to manage Node.js versions.

OS Requirements

Alokai is designed to work on Unix-based systems. Here's what you need to know about operating system compatibility:

Supported

• Linux
• macOS
• Windows with WSL2

Not Supported

• Windows PowerShell
• Windows Command Prompt

Native Windows (PowerShell) moves from Not Supported to best-effort Supported - see Windows support below for details and limitations.

Recommendation

For the best development experience and to avoid potential issues, we strongly recommend using Linux or macOS for your Alokai projects.

Windows support

Cloning, installing, generating a project, and running the Next.js storefront work directly in native Windows PowerShell, without WSL. This support is best-effort: we fix Windows-specific issues reactively as they're reported, rather than testing every code path on Windows up front.

Known limitations

• The Nuxt storefront does not currently start on native Windows.
• Some npm dependencies used by integrations may not support native Windows.

Troubleshooting

• AI coding skills missing or not loading after git clone/git checkout on Windows - see AI coding support troubleshooting.
• **RangeError: path should be a \path.relative()`d stringduring store generation/composition** - this was caused by unnormalized Windows absolute paths and is fixed in current@alokai/cli/@cli/internalversions. Upgrade withyarn alokai version upgrade` if you hit it.
• PowerShell environment variable syntax - PowerShell doesn't support the KEY=value command syntax used in some shell scripts. Use the cross-env package (already used across generated project scripts) instead of inline env var assignment when writing your own scripts.
• yarn install fails to resolve @alokai/* packages - make sure your user-level ~/.npmrc (or, on Windows, your PowerShell/WSL home directory's .npmrc) has the private registry auth token configured; see the onboarding instructions for your project.

Enterprise Integrations

Most of our integrations are available as part of Alokai Enterprise offering along with Alokai Frontend as a Service Platform. You can learn more or book a demo here.

Open Source user

Some of our eCommerce integrations are available in an Open Source model under MIT licenses. These integrations use Alokai core but are maintained by different companies.

Even though we closely collaborate with their creators, we cannot provide any support for these integrations as Alokai. When seeking support please use our Discord Channel.

You can find installation instructions for open-source integrations in the respective docs.