Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.equinix.dev/llms.txt

Use this file to discover all available pages before exploring further.

This page assumes you’ve already run Quickstart and have equinix-dev installed. If you haven’t, do that first.

​
Prerequisites

brew --version          # 4.0 or higher
terraform --version     # 1.6.0 or higher (1.9+ recommended)
equinix-dev --version   # 0.1.0 or higher
You’ll also need an Equinix portal account in plan-only mode — the same credentials you use for the Mintlify Quickstart. The credentials live in .env.local after equinix-dev add.

​
Five-minute path

1

Initialize a project

equinix-dev init my-first-fabric-plan
cd my-first-fabric-plan
The CLI writes .equinix-dev/project.json with mode: plan_only and apply: blocked. Move the directory between machines or check it into a private repo — the project state is fully portable.
2

Add a Fabric Cloud Router package

equinix-dev plugin install providers
equinix-dev add equinix/fabric-cloud-router
The CLI writes:
  • .equinix-dev/providers/equinix/fabric-cloud-router/provider.json (manifest)
  • .equinix-dev/providers/equinix/fabric-cloud-router/terraform.json (Terraform mapping)
  • .equinix-dev/providers/equinix/fabric-cloud-router/mcp.json (MCP profile)
  • .equinix-dev/providers/equinix/fabric-cloud-router/readiness.json (preflight gates)
  • .env.local is created or appended with EQUINIX_CLIENT_ID=, EQUINIX_CLIENT_SECRET=, EQUINIX_ACCOUNT_NUMBER= (empty placeholders)
3

Stage Terraform

equinix-dev compile --target terraform
The CLI emits .equinix-dev/terraform/main.tf and .equinix-dev/terraform/variables.tf. The output is real HCL targeting equinix/equinix ~> 4.15. You can inspect it before any terraform command runs.
4

Run terraform init + plan

cd .equinix-dev/terraform
terraform init
terraform plan
terraform plan should show one new equinix_fabric_cloud_router resource and zero changes elsewhere. If you see auth errors, check .env.local; if you see resource not found errors, check that equinix/equinix ~> 4.15 resolved correctly in terraform init.
5

Verify the readiness gates (don't apply)

cd ../..
equinix-dev preflight
Each gate prints PASS / FAIL with the source of truth. The apply step is intentionally blocked from inside equinix-dev. To actually run it, you exit the equinix-dev shell, run terraform apply directly, and live with the responsibility of doing so.

​
What you should see

A passing plan looks like this (truncated): 
Terraform will perform the following actions:

  # equinix_fabric_cloud_router.fcr_iad will be created
  + resource "equinix_fabric_cloud_router" "fcr_iad" {
      + name              = "fcr-private-ai-iad"
      + type              = "XF_ROUTER"
      + account           = (known after apply)
      + bandwidth         = (known after apply)
      + change_log        = (known after apply)
      + description       = (known after apply)
      + href              = (known after apply)
      + uuid              = (known after apply)

      + location {
          + ibx        = (known after apply)
          + metro_code = "DC"
          + metro_name = (known after apply)
        }

      + package {
          + code = "BASIC"
        }
    }

Plan: 1 to add, 0 to change, 0 to destroy.

​
Where to go next

Provider setup deep dive

Auth methods, env vars, common pitfalls.

Module list

When to wrap with terraform-equinix-fabric.

Three full recipes

Private AI path, multi-cloud regulated, distributed observability.

MCP-driven workflow

Have an agent author the Terraform via the Equinix MCP.