cli

command module
v1.28.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 11, 2024 License: MIT Imports: 16 Imported by: 0

README

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

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

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

Supported Platforms

  • MacOS
  • Linux
  • Windows WSL2

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
dev
run
This package provides functionality to interact with the Nhost API.
This package provides functionality to interact with the Nhost API.
env
Package system provides functionality to interact with the local system
Package system provides functionality to interact with the local system

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL