Install

Culvii is two npm packages: the SDK (@culvii/kit) and the CLI (@culvii/cli). Install both globally:

npm install -g @culvii/kit @culvii/cli

Verify the install:

culvii --version

You should see something like:

culvii v1.0.0

If culvii isn't found, your global npm bin directory may not be on your PATH. The command npm config get prefix shows where global packages live. Add <prefix>/bin to your shell's PATH.

Project setup

Create a directory for your tutorial code:

mkdir culvii-tutorial && cd culvii-tutorial
npm init -y
npm install @culvii/kit zod

We're installing @culvii/kit locally as well so your TypeScript editor picks up types.

You'll also want TypeScript itself for editor integration:

npm install -D typescript

Create a tsconfig.json with sensible defaults:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "Bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

The CLI handles bundling your code when it deploys, so you don't need a build step of your own.

That's the install. Next: Log in.