TeleFork.dev Documentation

Welcome to the TeleFork developer platform. TeleFork allows engineering teams to deploy ephemeral sandboxes automatically for every pull request, mirroring the production environment.

Key Benefit: TeleFork integrates directly with your source control provider. When developers push features, the sandbox builds asynchronously, eliminating traditional static staging bottlenecks.

Quickstart Guide

You can configure your workspace in seconds using the TeleFork CLI. Open your terminal and execute:

# Install the CLI tool npm install -g @telefork/cli # Log in to your keya-it workspace telefork auth login # Initialize a project configs telefork init

The `init` script scans your root folder for Terraform, OpenTofu, or Helm setups, and automatically outputs a `.telefork/telefork.yaml` file.

Authentication

API access is structured around bearer tokens. Workspace keys are managed in the security admin console.

To supply authentication tokens in raw HTTP clients:

Authorization: Bearer tf_live_92f8fa38cfd2a838bca7365

Infrastructure-as-Code Integration

TeleFork parses native IaC files. The engine interprets dependency schemas, isolating cloud variables securely. Here is a typical Terraform resource mapping setup:

# infra/terraform/main.tf resource "aws_db_instance" "prod_replica" { allocated_storage = 20 engine = "postgres" instance_class = "db.t3.micro" db_name = "sales_production" }

During execution, the parsing engine detects `aws_db_instance` and substitutes it with an ephemeral Postgres Docker setup to reduce cloud charges.

Database Seeding

To specify database seeding subsets, edit your `telefork.yaml` configuration:

database: engine: "postgresql" seeding: source: "prod-backup" anonymize: ["users.email", "billing.card_num"] size_limit_mb: 200

Compliance & Compliance configurations

Ensure strict data isolation. Compliance regulations require zero production user logs in dev environments. TeleFork's built-in tokenizers automatically swap user strings with randomized hashes before writing data images.

Webhooks

Register hooks to retrieve real-time workspace updates. When a sandbox finishes provisioning, TeleFork posts metadata to your specified webhook URL:

{ "event": "sandbox.provisioned", "sandbox_id": "sbx-pr24-d8f9", "status": "healthy", "url": "https://sbx-pr24.telefork.dev", "duration_seconds": 12.4 }

SDKs & Library Clients

Official client SDKs are available for Node.js, Go, and Python to manage sandbox instances programmatically:

Node.js: npm install @telefork/sdk
Go: go get github.com/telefork/sdk-go
Python: pip install telefork-sdk