ProviderPlane Documentation

Start with workflows, not raw provider calls. These docs take you from installation and provider configuration to a first workflow.

Start here

Most users only need a few pages to get moving: install the library, understand the workflow model, copy a representative example, then use the API reference for exact signatures.

Pick the right layer

ProviderPlane has multiple public layers, but they are not equal starting points. Most applications should stay at the workflow layer unless there is a clear reason to move lower.

Workflow layer

Start here. This is the preferred way to build with ProviderPlane when you want explicit multi-step orchestration with less boilerplate.

Job system

Use jobs when you need lower-level control over individual executions. Compared with the workflow layer, they require more manual orchestration.

Direct client

Use direct client calls only for isolated capability access. This is the thinnest layer and the most manual once calls start depending on each other.

Examples to explore

Use these runnable examples as practical patterns once the basic workflow model makes sense.