Skip to main content

Overview

The Refrain SDK provides programmatic access to runbook execution from your TypeScript/JavaScript applications. It never reads process.env — all configuration is passed explicitly.

Install

Quick start

Key exports

Design principles

  • Zero process.env — All configuration passed explicitly via constructor and method arguments
  • Non-interactive — No user prompts; unresolved required variables throw errors
  • Plan-aware — Features silently disabled if not available in your plan tier
  • Comprehensive diagnostics — Step results include retry counts, resolve methods, and failure categories

Next steps

Local Execution

Refrain class, configuration, and execution options.

Type Reference

All exported types organized by category.

Examples

Practical examples for common use cases.