cli

README

Nhost CLI

Nhost is an open source Firebase alternative with GraphQL.

The Nhost CLI is used to get a local development environment. The local development 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

You can also 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 cert.sh script to generate a real certificate from Let's Encrypt.

go build -o /usr/local/bin/nhost will build the binary available as nhost command in terminal.

## Dependencies

- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [curl](https://curl.se/)
- [Git](https://git-scm.com/downloads)

## Supported Platforms:

- MacOS
- Linux
- Windows WSL2