Skip to content

Install

Install the CLI first. Add the SDK only when your game code needs Vifu APIs.

CLI

bash
curl -fsSL https://vifu.dev/cli | bash
vifu --help

The installer downloads the native Vifu binary for macOS, Linux, or Windows shells. Agent skills are installed separately; see Vifu Agent Skill. npm remains the fallback when native install is unavailable:

bash
npm install -g @vifu/cli@alpha
vifu --help

Project-local CLI install:

bash
npm install --save-dev @vifu/cli@alpha
npx vifu --help

Create A Project

bash
npm create @vifu/vifu my-game -- --template vanilla --no-interactive
cd my-game
vifu deploy --yes

npm create @vifu/vifu is the supported project initializer. The CLI does not expose vifu create or vifu new as public commands.

For an existing browser game, run:

bash
cd path/to/your-game
vifu deploy --yes

vifu deploy also starts setup automatically when it is missing. Use vifu deploy --yes in CI to accept detected defaults.

SDK

npm

Use npm when your game has a bundler or build step:

bash
npm install @vifu/sdk@alpha
ts
import { createVifuSDK } from "@vifu/sdk";

const vifu = createVifuSDK();

CDN

Load the browser build from jsDelivr. Deployed games should use an exact SDK version:

html
<script src="https://cdn.jsdelivr.net/npm/@vifu/[email protected]/dist/browser/vifu-sdk.js"></script>
<script>
  const vifu = window.vifu;
</script>

Sign In For Deploy

Create an account at vifu.ai, then run:

bash
vifu login

Then deploy from a game directory:

bash
vifu deploy

Next Steps