Install

PrerequisitesCopy Anchor Link

• Node.js >= 24
• Bun >= 1.1
• Docker (optional, for container-based checks)

Install the CLICopy Anchor Link

bun add -g sverka

This installs the sverka command globally.

Add the SDK to your projectCopy Anchor Link

The CLI generates a sverka.config.ts that imports from @sverka/workflow, so that package must be resolvable from your project. sverka init adds the dependency automatically — a file:/link: spec when run from a local checkout, or a semver range once the packages are published to npm.

To add it manually:

cd your-project
bun add @sverka/workflow        # after npm publish
bun add link:/path/to/sverka/packages/workflow   # local checkout

InitializeCopy Anchor Link

sverka init

This creates a sverka.config.ts file with a default Construct-based verification workflow. Sverka auto-discovers your project type and suggests relevant checks.

Scaffold a new project (create-sverka)Copy Anchor Link

The create-sverka package is the create-* convention entry point — it forwards to sverka init with argument translation, so no global install is needed:

bun create sverka          # = sverka init (current directory)
bun create sverka my-app   # = sverka init --root my-app (creates the dir)
npm create sverka my-app   # same via npm

A leading positional argument is the target directory; every other flag forwards verbatim to sverka init (--template full, --detect, --force, …).

Next stepsCopy Anchor Link

• Define your first plan