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 quickstart uses the local Homebrew tap committed to the repo. The published tap shape (brew install equinix/equinix/equinix-dev) is shown for reference but is not yet public.

​
1. Install the CLI

1

Tap the local Homebrew formula

The tap is committed to the homebrew-equinix/ directory. No upload, no public registry.
brew tap equinix/equinix file://$(pwd)/equinix-dev-v2/homebrew-equinix
brew install equinix/equinix/equinix-dev
On a clean machine, brew --version should be 4.0 or higher. Older Homebrew may not resolve the file:// tap reliably.
2

Verify the install

The CLI prints its version and the resolved tap.
$ equinix-dev --version
equinix-dev 0.1.0 (private beta · local tap)

​
2. Install the agent skills

The @equinix/agent-skills bundle teaches your AI runtime — Claude Code, Cursor, Codex, VS Code, or any MCP client — what the Equinix Fabric, Network Edge, and Agent Factory surfaces actually do. It’s a folder of SKILL.md + reference Markdown that maps user intent (“design a private AI path to Lambda in IAD”) to the right tools and policy.
1

Install the bundle

During private beta, install from the local repo path. Once published, the same install works from npm.
npx skills add ./equinix-agent-skills
Three skills land in ~/.skills/equinix/ — equinix-fabric, equinix-network-edge, equinix-agent-factory.
2

Confirm the runtime sees them

Open Claude Code, Cursor, or your runtime of choice and ask “what equinix tools do you have?” The skills should advertise themselves with the surfaces they cover.

​
3. Connect an MCP client

The Fabric MCP server lives at mcp.equinix.com/fabric and exposes read-only tools (search_router, get_router_package, search_routes, …). Mutating tools are present in the schema but blocked by the gateway until human confirmation lands. Pick your client: 
{
  "mcpServers": {
    "equinix-fabric": {
      "url": "https://mcp.equinix.com/fabric/sse",
      "headers": { "Authorization": "Bearer ${EQUINIX_TOKEN}" }
    },
    "equinix-peering-insights": {
      "url": "https://mcp.equinix.com/peeringInsights/sse",
      "headers": { "Authorization": "Bearer ${EQUINIX_TOKEN}" }
    }
  }
}
mcp.equinix.com is the real Equinix-operated MCP gateway — see docs.equinix.com/equinix-api/mcp-servers/overview. The skills bundle and the equinix.dev CLI both target it.

​
4. Add your first provider

1

Initialize a project

Project state is written to .equinix-dev/ in the current directory. Move it between machines, agents, and CI without re-onboarding.
equinix-dev init private-ai-inference-iad
A new .equinix-dev/project.json is created with mode: plan_only and apply: blocked.
2

Install the provider catalog

The catalog is a deterministic snapshot of every provider package — 52 in private beta. It installs offline.
equinix-dev plugin install providers
3

Add your first package

equinix/fabric-cloud-router is the canonical first install. It maps to the official Terraform resource.
equinix-dev add equinix/fabric-cloud-router
The CLI writes provider.json, terraform.json, mcp.json, and stages env keys into .env.local.
4

Inspect what was added

Every package is inspectable. The output is JSON; pipe to jq for a quick view of the agent-readable shape.
equinix-dev package inspect equinix/fabric-cloud-router
Or hit the local API mirror at port 8787:
curl -s http://127.0.0.1:8787/api/search?q=equinix%2Ffabric-cloud-router | jq

​
Run the workflow

The full Discover · Plan · Preflight · Approve loop: 
equinix-dev workflow
The CLI prints the six canonical steps with status. Mutating tools (equinix_fabric_create_*) are blocked by default and surface the list of preflight gates that must pass first.
Apply remains blocked. Even with the CLI authenticated to a real Equinix tenant, terraform apply requires explicit human approval after the readiness gates pass. See Safety model for the full set of guarantees.

​
Next steps

Read the workflow

Understand each stage and what an agent can and cannot do.

Browse providers

52 packages organized by category. Each page has install, terraform, mcp, env, and readiness sections.

Open the workspace

The interactive console with KPI band, runbook, object inspector, and MCP request log.

Read the package anatomy

The six-file contract every provider exposes.