Skip to main content

​
NAME

nhost - A new cli application

​
SYNOPSIS

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

​
DESCRIPTION

Nhost CLI tool Usage: 
nhost [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]

​
GLOBAL OPTIONS

—branch="": Git branch name. If not set, it will be detected from the current git repository. This flag is used to dynamically create docker volumes for each branch. If you want to have a static volume name or if you are not using git, set this flag to a static value. (default: nogit) —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: docs) —root-folder="": Root folder of project (default: .) —version, -v: print the version

​
COMMANDS

​
config

Perform config operations —help, -h: show help

​
default

Create default configuration and secrets —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
example

Shows an example config file —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
apply

Apply configuration to cloud project —help, -h: show help —subdomain="": Subdomain of the Nhost project to apply configuration to. Defaults to linked project —yes: Skip confirmation

​
help, h

Shows a list of commands or help for one command

​
pull

Get cloud configuration —help, -h: show help —subdomain="": Pull this subdomain’s configuration. Defaults to linked project —yes: Skip confirmation

​
help, h

Shows a list of commands or help for one command

​
show

Shows configuration after resolving secrets —help, -h: show help —subdomain="": Show this subdomain’s rendered configuration. Defaults to base configuration

​
help, h

Shows a list of commands or help for one command

​
validate

Validate configuration —help, -h: show help —subdomain="": Validate this subdomain’s configuration. Defaults to linked project

​
help, h

Shows a list of commands or help for one command

​
edit

Edit base configuration or an overlay —editor="": Editor to use (default: vim) —help, -h: show help —subdomain="": If specified, edit this subdomain’s overlay, otherwise edit base configuation

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
deployments

Manage deployments —help, -h: show help

​
list

List deployments in the cloud environment —help, -h: show help —subdomain="": Project’s subdomain to operate on, defaults to linked project

​
help, h

Shows a list of commands or help for one command

​
logs

View deployments logs in the cloud environment —follow: Specify if the logs should be streamed —help, -h: show help —subdomain="": Project’s subdomain to operate on, defaults to linked project —timeout="": Specify the timeout for streaming logs (default: 5m0s)

​
help, h

Shows a list of commands or help for one command

​
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. —help, -h: show help —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

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
dev

Operate local development environment —help, -h: show help

​
compose

docker compose wrapper, sets project name and compose file automatically —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
hasura

hasura-cli wrapper —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
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.38.4) —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) —help, -h: show help —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] (default: []) —storage-port="": If specified, expose storage on this port. Not recommended (default: 0)

​
cloud

Start local development environment connected to an Nhost Cloud project (BETA) —apply-seeds: Apply seeds. If the .nhost folder does not exist, seeds will be applied regardless of this flag —ca-certificates="": Mounts and everrides path to CA certificates in the containers —dashboard-version="": Dashboard version to use (default: nhost/dashboard:2.38.4) —disable-tls: Disable TLS —down-on-error: Skip confirmation —hasura-console-port="": If specified, expose hasura console on this port. Not recommended (default: 0) —help, -h: show help —http-port="": HTTP port to listen on (default: 443) —postgres-url="": Postgres URL —subdomain="": Project’s subdomain to operate on, defaults to linked project

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
down

Stop local development environment —help, -h: show help —volumes: Remove volumes

​
help, h

Shows a list of commands or help for one command

​
logs

Show logs from local development environment —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
docker-credentials

Perform docker-credentials operations —help, -h: show help

​
configure

Install credentials helper and configure docker so it can authenticate with Nhost’s registry —docker-config="": Path to docker config file (default: /homeless-shelter/.docker/config.json) —help, -h: show help —no-interactive: Do not prompt for confirmation

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
mcp

Model Context Protocol (MCP) related commands —config-file="": Configuration file path. Defaults to $NHOST_DOT_NHOST_FOLDER/nhost-mcp.toml —help, -h: show help

​
config

Generate and save configuration file —confirm: Skip confirmation prompt —help, -h: show help

​
dump

Dump the configuration to stdout for verification —help, -h: show help
help, h
Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
start

Starts the MCP server —bind="": Bind address in the form host:host:port. If omitted use stdio —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
gen

Generate GraphQL schema for Nhost Cloud —help, -h: show help —nhost-pat="": Personal Access Token —with-mutations: Include mutations in the generated schema

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
init

Initialize a new Nhost project —help, -h: show help —remote: Initialize pulling configuration, migrations and metadata from the linked project

​
help, h

Shows a list of commands or help for one command

​
list

List remote apps —help, -h: show help

​
help, h

Shows a list of commands or help for one command Link local app to a remote one —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
run

Perform operations on Nhost Run —help, -h: show help

​
config-show

Shows Run service configuration after resolving secrets —config="": Service configuration file (default: nhost-run-service.toml) —help, -h: show help —overlay-name="": If specified, apply this overlay

​
help, h

Shows a list of commands or help for one command

​
config-deploy

Deploy service configuration —config="": Service configuration file (default: nhost-run-service.toml) —help, -h: show help —service-id="": Service ID to update. Applies overlay of the same name

​
help, h

Shows a list of commands or help for one command

​
config-edit

Edit service configuration —config="": Service configuration file (default: nhost-run-service.toml) —editor="": Editor to use (default: vim) —help, -h: show help —overlay-name="": If specified, apply this overlay

​
help, h

Shows a list of commands or help for one command

​
config-edit-image

Edits configuration file and sets the image —config="": Service configuration file (default: nhost-run-service.toml) —help, -h: show help —image="": Image to use

​
help, h

Shows a list of commands or help for one command

​
config-pull

Download service configuration —config="": Service configuration file (default: nhost-run-service.toml) —help, -h: show help —service-id="": Service ID to update

​
help, h

Shows a list of commands or help for one command

​
config-validate

Validates service configuration after resolving secrets —config="": Service configuration file (default: nhost-run-service.toml) —help, -h: show help —overlay-name="": If specified, apply this overlay —service-id="": If specified, apply this overlay and remote secrets for this service

​
help, h

Shows a list of commands or help for one command

​
config-example

Shows an example config file —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
env

Outputs environment variables. Useful to generate .env files —config="": Service configuration file (default: nhost-run-service.toml) —help, -h: show help —overlay-name="": If specified, apply this overlay —prepend-export: Prepend ‘export’ to each line

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
secrets

Manage secrets —help, -h: show help

​
create

Create secret in the cloud environment —help, -h: show help —subdomain="": Project’s subdomain to operate on, defaults to linked project

​
help, h

Shows a list of commands or help for one command

​
delete

Delete secret in the cloud environment —help, -h: show help —subdomain="": Project’s subdomain to operate on, defaults to linked project

​
help, h

Shows a list of commands or help for one command

​
list

List secrets in the cloud environment —help, -h: show help —subdomain="": Project’s subdomain to operate on, defaults to linked project

​
help, h

Shows a list of commands or help for one command

​
update

Update secret in the cloud environment —help, -h: show help —subdomain="": Project’s subdomain to operate on, defaults to linked project

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
sw

Perform software management operations —help, -h: show help

​
uninstall

Remove the installed CLI from system permanently —force: Force uninstall without confirmation —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
upgrade

Upgrade the CLI to the latest version —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
version

Show the current version of Nhost CLI you have installed —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command

​
login

Login to Nhost —email="": Email address —help, -h: show help —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

​
docs

Generate markdown documentation for the CLI —help, -h: show help

​
help, h

Shows a list of commands or help for one command

​
help, h

Shows a list of commands or help for one command