docs

Document Builder Playground custom recipe YAML schema and operational rules.

131|52|Updated Jul 29, 2024
One-click install
npx skills add https://github.com/flashbots/builder-playground --skill docs-flashbots
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/flashbots/builder-playground/tree/main/docs
Command: npx skills add https://github.com/flashbots/builder-playground --skill docs-flashbots

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It helps you create and apply Builder Playground custom recipes without guesswork, by documenting the supported YAML schema, operational rules, and recommended practices for deterministic, low-friction recipe authoring.

Core Features & Use Cases

  • Custom recipe authoring rules: Provides guardrails on how to structure recipes, how to avoid common pitfalls, and how to follow the intended workflow when generating or modifying recipes.
  • Full YAML recipe reference: Documents key fields like base, base_args, setup, predeploys, remove, component/service overrides, and lifecycle/host execution concepts.
  • Template expressions & wiring patterns: Explains how to use {{Port}} and {{Service}} inside service args to declare ports and connect services correctly, plus related conventions for volumes and dependencies.

Quick Start

Open a file named playground.yaml and start it with base set to the recipe you want to extend, then add only the minimal recipe changes under recipe so the playground merges them at runtime.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a custom recipe YAML for an Ethereum devnet setup?

This reference specifies the exact YAML schema, template expressions, and operational rules needed to author deterministic Ethereum devnet custom recipes without guesswork.

What template expressions are supported in Builder Playground recipes?

Builder Playground recipes support {{Port}} and {{Service}} template expressions inside service args to declare ports and wire services correctly. They also define conventions for volumes and dependencies.

How do component and service overrides work in custom recipes?

Component and service overrides in custom recipes allow you to modify base configurations by specifying changes under the recipe key. The playground merges these overrides at runtime to execute deterministic devnet setups.

Does Builder Playground support Docker orchestration for devnet lifecycle hooks?

Yes, Builder Playground supports Docker orchestration by defining lifecycle hooks, host execution modes, and dependency ready-check patterns within the custom recipe YAML to ensure services validate and run correctly.

Why is my custom recipe YAML not validating for my Ethereum devnet?

Custom recipe YAML fails validation when unsupported fields are used or template expressions like {{Port}} and {{Service}} are applied incorrectly. Following the documented schema and config conventions ensures recipes validate.