First plan

This page walks through defining a workflow, synthesizing a Definition Graph, and running verification through the native engine.

Define a workflowCopy Anchor Link

Create sverka.config.ts in your project root (or run sverka init to generate one):

import { Project, Pipeline, ShellStep, Entry } from "@sverka/workflow";

const proj = new Project("verify");
const pipeline = new Pipeline(proj, "ci");

new ShellStep(pipeline, "lint", { command: "npm run lint" });
new ShellStep(pipeline, "typecheck", { command: "npm run typecheck" });
new ShellStep(pipeline, "test", {
  command: "npm run test",
  dependsOn: ["lint", "typecheck"],
});

new Entry(pipeline, "on-push", {
  trigger: { kind: "push" },
  roots: ["test"],
});

export default proj;

The workflow runs lint and typecheck in parallel, then test after both complete. Each ShellStep names its operation for the plan output.

Try it in the playgroundCopy Anchor Link

The same pipeline shape, running in your browser — FunctionSteps stand in for ShellSteps because a browser can't spawn processes (a ShellStep in the playground reports an info finding explaining the boundary):

Press Run to execute it and see the findings report. To run real checks, take the same structure home with npm create sverka — the graph transfers verbatim.

See what would runCopy Anchor Link

sverka plan

This discovers your project, synthesizes the Definition Graph, binds a Run Plan, and prints it without executing anything.

Run verificationCopy Anchor Link

sverka run

This executes the Run Plan through the native engine with the host runtime driver. You see step events: pending, started, succeeded/failed, and run completion.

Inspect the graphCopy Anchor Link

sverka graph

This prints the synthesized Definition Graph showing pipelines, steps, entries, and dependencies.

Compile to GitHub ActionsCopy Anchor Link

sverka synth --target github

This lowers the Definition Graph to native GitHub Actions YAML and writes it to .github/workflows/ci.yml.

Authoring surfaceCopy Anchor Link

Pipelines are authored with the Construct API from @sverka/workflow — the same surface sverka init generates:

import { Project, Pipeline, ShellStep, Entry } from "@sverka/workflow";

const proj = new Project("myproj");
const p = new Pipeline(proj, "ci");
new ShellStep(p, "build", { command: "npm run build" });
new Entry(p, "on-push", { trigger: { kind: "push" }, roots: ["build"] });

For programmatic use, synthesize (@sverka/workflow) and bindRunPlan (@sverka/sdk) drive the same graph → Plan pipeline — see From workflow to Plan.