​

NAME

nhost - A new cli application

​

SYNOPSIS

nhost

[--data-folder]=[value]
[--dot-nhost-folder]=[value]
[--help|-h]
[--local-subdomain]=[value]
[--nhost-folder]=[value]
[--project-name]=[value]
[--root-folder]=[value]

​

DESCRIPTION

Nhost CLI tool

Usage:

nhost [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

​

GLOBAL OPTIONS

—data-folder="": Data folder to persist data (default: “.nhost/data/certs2”)

—dot-nhost-folder="": Path to .nhost folder (default: “.nhost”)

—help, -h: show help

—local-subdomain="": Local subdomain to reach the development environment (default: “local”)

—nhost-folder="": Path to nhost folder (default: “nhost”)

—project-name="": Project name (default: “cli”)

—root-folder="": Root folder of project (default: ”.”)

​

COMMANDS

​

config

Perform config operations

​

default

Create default configuration and secrets

​

example

Shows an example config file

​

pull

Get cloud configuration

—subdomain="": Pull this subdomain’s configuration. Defaults to linked project

—yes: Skip confirmation

​

show

Shows configuration after resolving secrets

—subdomain="": Show this subdomain’s rendered configuration. Defaults to base configuration

​

validate

Validate configuration

—subdomain="": Validate this subdomain’s configuration. Defaults to linked project

​

edit

Edit base configuration or an overlay

—editor="": Editor to use (default: “vim”)

—subdomain="": If specified, edit this subdomain’s overlay, otherwise edit base configuation

​

deployments

Manage deployments

​

list

List deployments in the cloud environment

—subdomain="": Project’s subdomain to operate on, defaults to linked project

​

logs

View deployments logs in the cloud environment

—follow: Specify if the logs should be streamed

—subdomain="": Project’s subdomain to operate on, defaults to linked project

—timeout="": Specify the timeout for streaming logs (default: 5m0s)

​

new

[EXPERIMENTAL] Create a new deployment

—follow: Specify if the logs should be streamed. If set, the command will wait for the deployment to finish and stream the logs. If the deployment fails the command will return an error.

—message="": Commit message

—ref="": Git reference

—subdomain="": Project’s subdomain to operate on, defaults to linked project

—timeout="": Specify the timeout for streaming logs (default: 5m0s)

—user="": Commit user name

—user-avatar-url="": Commit user avatar URL

​

dev

Operate local development environment

​

compose

docker compose wrapper, sets project name and compose file automatically

​

hasura

hasura-cli wrapper

​

up

Start local development environment

—apply-seeds: Apply seeds. If the .nhost folder does not exist, seeds will be applied regardless of this flag

—auth-port="": If specified, expose auth on this port. Not recommended (default: 0)

—ca-certificates="": Mounts and everrides path to CA certificates in the containers

—dashboard-version="": Dashboard version to use (default: “nhost/dashboard:2.20.0”)

—disable-tls: Disable TLS

—down-on-error: Skip confirmation

—functions-port="": If specified, expose functions on this port. Not recommended (default: 0)

—hasura-console-port="": If specified, expose hasura console on this port. Not recommended (default: 0)

—hasura-port="": If specified, expose hasura on this port. Not recommended (default: 0)

—http-port="": HTTP port to listen on (default: 443)

—postgres-port="": Postgres port to listen on (default: 5432)

—run-service="": Run service to add to the development environment. Can be passed multiple times. Comma-separated values are also accepted. Format: /path/to/run-service.toml[:overlay_name]

—storage-port="": If specified, expose storage on this port. Not recommended (default: 0)

​

down

Stop local development environment

—volumes: Remove volumes

​

logs

Show logs from local development environment

​

docker-credentials

Perform docker-credentials operations

​

configure

Install credentials helper and configure docker so it can authenticate with Nhost’s registry

—docker-config="": Path to docker config file (default: “/Users/dbarroso/.docker/config.json”)

—no-interactive: Do not prompt for confirmation

​

init

Initialize a new Nhost project

—remote: Initialize pulling configuration, migrations and metadata from the linked project

​

list

List remote apps

​

link

Link local app to a remote one

​

run

Perform operations on Nhost Run

​

config-show

Shows Run service configuration after resolving secrets

—config="": Service configuration file (default: “nhost-run-service.toml”)

—overlay-name="": If specified, apply this overlay

​

config-deploy

Deploy service configuration

—config="": Service configuration file (default: “nhost-run-service.toml”)

—service-id="": Service ID to update. Applies overlay of the same name

​

config-edit

Edit service configuration

—config="": Service configuration file (default: “nhost-run-service.toml”)

—editor="": Editor to use (default: “vim”)

—overlay-name="": If specified, apply this overlay

​

config-edit-image

Edits configuration file and sets the image

—config="": Service configuration file (default: “nhost-run-service.toml”)

—image="": Image to use

​

config-pull

Download service configuration

—config="": Service configuration file (default: “nhost-run-service.toml”)

—service-id="": Service ID to update

​

config-validate

Validates service configuration after resolving secrets

—config="": Service configuration file (default: “nhost-run-service.toml”)

—overlay-name="": If specified, apply this overlay

—service-id="": If specified, apply this overlay and remote secrets for this service

​

config-example

Shows an example config file

​

env

Outputs environment variables. Useful to generate .env files

—config="": Service configuration file (default: “nhost-run-service.toml”)

—overlay-name="": If specified, apply this overlay

—prepend-export: Prepend ‘export’ to each line

​

secrets

Manage secrets

​

create

Create secret in the cloud environment

—subdomain="": Project’s subdomain to operate on, defaults to linked project

​

delete

Delete secret in the cloud environment

—subdomain="": Project’s subdomain to operate on, defaults to linked project

​

list

List secrets in the cloud environment

—subdomain="": Project’s subdomain to operate on, defaults to linked project

​

update

Update secret in the cloud environment

—subdomain="": Project’s subdomain to operate on, defaults to linked project

​

sw

Perform software management operations

​

uninstall

Remove the installed CLI from system permanently

—force: Force uninstall without confirmation

​

upgrade

Upgrade the CLI to the latest version

​

version

Show the current version of Nhost CLI you have installed

​

login

Login to Nhost

—email="": Email address

—password="": Password

—pat="": Use this Personal Access Token instead of generating a new one with your email/password

​

help, h

Shows a list of commands or help for one command