README.md

Nhost CLI

Nhost is an open-source Firebase alternative with GraphQL.

The Nhost CLI is used to set up a local development environment. This environment will automatically track database migrations and Hasura metadata.

It's recommended to use the Nhost CLI and the Nhost GitHub Integration to develop locally and automatically deploy changes to production with a git-based workflow (similar to Netlify & Vercel).

Services

• Nhost Dashboard
• Postgres Database
• Hasura's GraphQL Engine
• Hasura Auth
• Hasura Storage
• Nhost Serverless Functions
• Minio S3
• Mailhog

Get Started

Install the Nhost CLI

sudo curl -L https://raw.githubusercontent.com/nhost/cli/main/get.sh | bash

Initialize a project

nhost init

Initialize a project with a remote project as a starting point

nhost init --remote

Start the development environment

nhost up

Use the Nhost Dashboard

nhost up --ui nhost

Documentation

• Get started with Nhost CLI (longer version)
• Nhost CLI
• Reference

Build from Source

Make sure you have Go 1.18 or later installed.

The source code includes a self-signed certificate for testing purposes. Nhost workers with configured access to AWS may use the cert.sh script to generate a real certificate from Let's Encrypt.

go build -o /usr/local/bin/nhost

This will build the binary available as the nhost command in the terminal.

Dependencies

• Docker
• Docker Compose
• curl
• Git

Supported Platforms

• MacOS
• Linux
• Windows WSL2