Deploykit service

import { Effect } from "effect"
import { Deploykit } from "@deploykit/core"

const program = Effect.gen(function* () {
  const deploykit = yield* Deploykit.Deploykit
  // ...
})

LayersCopy Anchor Link

All of them need a FileSystem, for example NodeFileSystem.layer from @effect/platform-node. limits is { memoryBudgetBytes?, stagingBudgetBytes?, maxFileBytes? }; see Limits. The budgets are created once per layer and shared by every deploy through it.

layerConfig fails with a ConfigError when a required variable is missing.

MethodsCopy Anchor Link

Every method returns an Effect with no further requirements.

capabilities is a plain Capabilities value, not an Effect.

deployManifestCopy Anchor Link

manifest is unknown and is validated for you, so the result of JSON.parse works directly. source is a FileSource:

import { Source } from "@deploykit/core"

export const source = Source.fromReadableStream(async (reference, signal) => {
  const response = await fetch(
    `https://artifacts.example.test/objects/${encodeURIComponent(reference)}`,
    {
      signal,
      redirect: "error"
    }
  )
  if (!response.ok || response.body === null) {
    await response.body?.cancel()
    throw new Error(`Artifact read failed: ${response.status}`)
  }
  return response.body
})

Replace this illustrative origin with your authorized artifact store and resolve opaque references according to your storage mapping. Source.fromPromise accepts a reader returning Promise<Uint8Array> for small files; the streaming reader avoids that allocation.

Deploy optionsCopy Anchor Link

Deploykit.DeployOptions is Provider.DeployOptions without the budgets, which the layer owns:

For Vercel's upload options, see Uploads.

CancellingCopy Anchor Link

Interrupt the fiber. See Lifecycle.

Without DeploykitCopy Anchor Link

Provider.DeploymentProvider is the raw contract underneath. It has the same apps and deployment methods, but optional ones are undefined when unsupported, and deploy takes budgets directly. Use it for Platform, tests, or writing a provider. Provide it with Vercel.vercelLayer, Vercel.layerWith(client), Cloudflare.cloudflareLayer or Cloudflare.layerWith(client).

Waiting and deployment managementCopy Anchor Link

The service also exposes waitUntilReady, deployAndWait, listDeployments, deleteDeployment and rollback. Their result semantics match the Promise reference; Effect calls use fiber interruption instead of AbortSignal. Effect wait options are { schedule?, tolerateFailures? }, not millisecond fields. Supply a bounded schedule and use Effect.timeout for a hard overall deadline.

waitUntilReady fails with ProviderError or DeploymentTimeoutError and returns a terminal failed deployment as data. deployAndWait additionally raises DeploymentFailedError for that failed status. The management operations can fail with UnsupportedError when unavailable. Exact signatures and requirements are in the generated core reference.