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

Dependencies

• Docker
• Docker Compose
• curl
• Git

Supported Platforms:

• MacOS
• Linux
• Windows WSL2

Documentation

Overview

MIT License

Copyright (c) Nhost

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.