Prerequisites

Before continuing, ensure you have the following pieces of software at the correct minimum versions installed on your machine:

Step 1. Install and authorize the Hasura CLI

You can download the CLI binary below. The latest version of the CLI is v1.0.1. Please follow the instructions for your system.

macOS and Linux

Simply run the installer script in your terminal:

curl -L https://graphql-engine-cdn.hasura.io/ddn/cli/v3/get.sh | bash

Windows

Download the latest cli-ddn-windows-amd64.exe binary and run it.

curl -L https://graphql-engine-cdn.hasura.io/ddn/cli/v3/latest/cli-ddn-windows-amd64.exe -o ddn.exe

Unrecognized application warning

In Windows, if you get an "Unrecognized application" warning, click "Run anyway".

Additionally, you'll need to add this executable to your system's PATH:

Step 1: Locate the and rename the executable: Find the full path to the directory containing the executable. For example, if the executable is located in C:\Program Files\cli-ddn-windows-amd64.exe, note this path. Also, rename it to ddn for ease when writing commands later on.

Step 2: Open System Properties:

• Press Win + X and select System.
• Click on Advanced system settings on the left side.
• In the System Properties window, click on the Environment Variables button.

Step 3: Edit the PATH Variable:

• In the Environment Variables window, find the System variables section.
• Scroll down and select the Path variable, then click Edit.
• In the Edit Environment Variable window, click New and paste the path to the directory containing your executable (e.g., C:\Program Files\ddn.exe).

Step 4: Save Your Changes:

• Click OK to close the Edit Environment Variable window.
• Click OK to close the Environment Variables window.
• Click OK to close the System Properties window.

Step 5: Verify the Changes: Open a new Command Prompt or PowerShell window and type the following.

From any directory, run:

ddn

Step 1.1 Login with the CLI

After installation, from any directory, run the following command to authenticate your CLI session with Hasura DDN.

ddn auth login

A new window will open either asking you to sign in or authenticating your current session and allow you to return to the CLI.

Step 2. Install the Hasura VS Code extension

If you don't already have Visual Studio Code installed, we recommend you download and install it. Then, install the Hasura VS Code extension so that you can make use of features like autocomplete, contextual suggestions, and inline validation to enhance your development experience.

Step 3. Install Docker Compose v2.22.0 or greater

Finally, install Docker, which will be used for local development. This helps you iterate and develop locally without deploying any changes to Hasura DDN, making the development experience faster and your feedback loops shorter.

Docker version requirement

Docker Compose v2.27.1 or greater is required to run local services. To check your version of Docker Compose, run:

docker compose version

Click here to download the latest version of Docker which includes Docker Compose.

If you have Docker Desktop installed on your system you can upgrade from inside the application.

Console compatible browsers

Your browser settings, privacy tools or browser extensions may prevent the Console from accessing your local Hasura instance. This could be due to features designed to protect your privacy and security. Should you encounter one of these issues, we recommend disabling these settings for the console.hasura.io domain.

Chrome and Firefox are the recommended browsers for the best experience with the Hasura Console including for local development.

Next Steps

At this point, you're ready to create your first supergraph!

Alternatively, if you've been invited to an existing supergraph repository, you might want to add a new subgraph, connect a data source, create a relationship, or add some business logic.