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.

The equinix-dev CLI is a thin shell over the provider catalog and the Local Explorer. Every command runs offline by default and prints an explicit local, remote-read, or remote-mutate mode marker.

​
Project lifecycle

Create a new project. Writes .equinix-dev/project.json with mode: plan_only and apply: blocked.
$ equinix-dev init private-ai-inference-iad
→ wrote .equinix-dev/project.json
→ mode: plan_only · apply: blocked
Install the provider catalog snapshot into .equinix-dev/plugins/providers/. Offline; no network call.
Print the private-beta catalog as a table. Use --all to include the staged long-tail (52 packages).
Sanity check the local environment: Homebrew tap reachable, Geist fonts cached, 127.0.0.1:8787 Local Explorer responding.
Wipe .equinix-dev/, .env.local, and any generated Terraform. Useful between rehearsals.

​
Provider lifecycle

Install a provider package. Writes the six-file contract to .equinix-dev/providers/<slug>/ and stages env keys into .env.local.
$ equinix-dev add equinix/fabric-cloud-router
→ resolved equinix/fabric-cloud-router@v0.28.1
→ wrote .equinix-dev/providers/equinix/fabric-cloud-router/{provider,terraform,mcp,readiness}.json
→ wrote .equinix-dev/providers/equinix/fabric-cloud-router/{pricing.md,llms.txt}
→ env keys EQUINIX_FABRIC_CLOUD_ROUTER_PROJECT_ID, EQUINIX_FABRIC_CLOUD_ROUTER_TOKEN staged in .env.local
✓ ready — run `equinix-dev workflow` to plan
Upgrade an installed provider to the catalog’s current version. Diffs the new manifest against the local lock and refuses if any resource was removed.
Print the package’s full manifest as JSON.
$ equinix-dev package inspect equinix/fabric-cloud-router
{
  "schema": "equinix.dev/provider-package/v1",
  "slug": "equinix/fabric-cloud-router",
  "sources": ["terraform", "mcp"],
  "terraform": { "status": "official_resource", ... },
  "mcp": { "endpoint": "https://mcp.equinix.com/fabric", ... }
}
Print the canonical Terraform module for the package. Pipes cleanly into tee main.tf.

​
Workflow + run modes

Run the canonical six-step plan. Prints each step with status:
$ equinix-dev workflow
01 ✓ Create a project
02 ✓ Install the private-beta package catalog
03 ✓ Add Fabric, cloud, observability, and repo packages
04 ✓ Inspect package and MCP contracts
05 ✓ Generate Terraform review artifact
06 ✗ Stop at approval gate (terraform apply)
Boot the Local Explorer. Serves 127.0.0.1:8787 with /api/catalog, /api/private-beta/catalog, /api/session, /api/workflow, /api/objects, /api/requests, /api/readiness, /api/graph, /api/artifacts, /api/search, and /openapi.json.
Print the MCP read/mutate trace for the current run. Read tools show timing; mutating tools show blocked_by reason.
Diff the project’s pricing.md references against the catalog. Any missing record is reported as quote_required with a proposed patch.

​
Run-mode markers

Every command prints one of these markers so it’s clear what it touched:
MarkerMeaning
localNo network. Read/write only on the developer’s machine.
remote-readOAuth-scoped read against the customer Equinix tenant.
remote-mutateOAuth-scoped write. Always blocked outside the local demo path until preflight passes.
For the board demo, default to local-only or remote-read. Mutating calls are pre-emptively blocked; the CLI shows the confirmation envelope instead of executing.

​
Exit codes

CodeMeaning
0Success.
2Validation error in .equinix-dev/ state or a manifest.
3Preflight blocked the requested action. See equinix-dev mcp trace --local for the gate that failed.
4Network or auth error reaching the Equinix tenant (only emitted in remote-* modes).
5Local Explorer not running. Start it with equinix-dev dev --port 8787.