Welcome to HyperRoute

You're about to set up the fastest GraphQL federation on the market. In just a few minutes, you'll have a production-ready federated API running locally.

---

What You'll Get

---

Installation

Install HyperRoute Core and DevKit with two simple commands.

Install Core (Router)

curl -fsSL https://releases.hyperroute.dev/core/install.sh | bash

Install DevKit (CLI)

curl -fsSL https://releases.hyperroute.dev/devkit/install.sh | bash

Verify Installation

routerd --version     # Should print Core version
hyperroute --version  # Should print DevKit version

---

Your First API in 60 Seconds

Let's create a working federated GraphQL API in five simple steps.

Step 1: Initialize DevKit

hyperroute init

This generates a devkit.yaml configuration file in your project root with sensible defaults. It defines how DevKit builds, validates, and deploys your schemas.

Step 2: Start the Router

routerd

You'll see output confirming the router is ready:

✓ Router started on http://localhost:4000
✓ Playground available at http://localhost:4000/playground
✓ Ready to receive schemas

Step 3: Create a Schema

Create a file called hello.graphql:

type Query {
  hello: String @resolver(name: "hello")
  greeting(name: String!): String @resolver(name: "greet")
}

Step 4: Deploy It

hyperroute push --local --name hello --schema hello.graphql

You'll see confirmation:

✓ Schema validated
✓ Composition successful
✓ Pushed to router

Step 5: Query Your API

Open http://localhost:4000/playground and run:

{
  hello
  greeting(name: "World")
}

That's it! You have a working federated GraphQL API.

---

What Just Happened?

Behind the scenes, HyperRoute performed these steps automatically:

1. Validated your schema for errors
2. Composed it into an optimized supergraph
3. Deployed it to the router with zero downtime
4. Exposed it as a queryable GraphQL endpoint

All in under a second.

---

Next Steps

• Architecture Overview — Understand how the components work together
• Security Guide — Learn about built-in protections

---

Need help?

• Contact support — Our team is here to help
• Issue tracker — Report bugs (coming soon)