SDK Reference

The Fractal Cloud SDKs provide programmatic access to define, compose, and deploy infrastructure using code. They let you build reusable components, automate complex workflows, and integrate Fractal Cloud into your internal tools, CI/CD pipelines, and GitOps processes. By expressing infrastructure as code you can version it alongside your application code, test it in lower environments, and apply the same engineering practices you already use for software.

Available SDKs

SDK	Language	Package	Samples
TypeScript SDK	TypeScript / Node.js	@fractal_cloud/sdk	Samples
Java SDK	Java	fractal-java-sdk	Samples
Terraform Provider	HCL	fractalcloud/fc	Samples

npm install @fractal_cloud/sdk

What this reference covers

This section documents how to drive an SDK: authoring a Fractal, locking guardrails, specializing it into a Live System, deploying, and managing environments.

Page	Contents
Core API	Authoring Fractals, guardrails vs dev-open parameters, specialization, offer selection, publishing, deployment modes, reading output fields, extending the catalogue.
Link Settings	The settings contract for every link type the platform resolves.
Environments	Management and operational tiers, cloud agents, secrets, CI/CD profiles, deployment options.

Looking for a component and its parameters?

Component types, their parameters, required flags, accepted values and fully-parameterized examples all live in the Component Reference — one page per cloud vendor, covering every offer in the catalogue. It is the same contract whatever SDK you author in, so it is documented once, there:

• AWS Components
• Azure Components
• GCP Components
• OCI Components
• Hetzner Components
• VMware Components
• OpenShift Components
• Aruba Components

For the model behind those types — Bounded Contexts, Fractals, Live Systems, and the Component → Service → Offer hierarchy — see Concepts.

Which level do I reference where?

A Fractal blueprint references abstract Component contracts (Storage.ObjectStorage) so it stays satisfiable by any vendor. A Live System selects a concrete Offer (Storage.PaaS.AwsS3) per component. The Component Reference documents the Offer level — the only level that maps to real infrastructure and the only level an agent reconciles.

Samples

Runnable end-to-end examples for each language live in that SDK's sample repository, linked in the table above. basic_storage in the TypeScript samples is the canonical starting point.