docs/start here/Quick start

Quick start

On this page

One file from Vardum into a repository, locked, in five steps.

You need Node.js 22+ and a workspace. These steps pin published CLI 0.8.3. Frozen snapshots remain schema 2, with minimum compatible CLI 0.6.0. See release status for compatibility and evidence.

1. Prepare a Vard

In the app:

  1. Upload logo.svg.
  2. Create a Vard.
  3. Map the asset to public/logo.svg.
  4. Copy the server URL, workspace ID and Vard ID. Copy setup gives you all of step 2 as one command. Its version depends on the gateway deployment; the manual command below pins CLI 0.8.3.

2. Connect the repository

npm install --save-dev --save-exact @vardum/[email protected]
npx vardum init     # writes vardum.json
npx vardum login    # authorizes this machine in the browser

3. Pull

npx vardum pull     # writes public/logo.svg and .vardum.lock

4. Commit

vardum.json         server, workspace, Vard
.vardum.lock        versions and checksums
package.json        the pinned CLI
package-lock.json

5. Restore in CI

Give CI a read key as VARDUM_API_KEY, then:

npm ci
npx --no-install vardum pull --frozen --json

Every build now gets the same bytes until you run vardum pull again.

Next