CLI Reference

terminal

npm install -g nept-cli
nept login

nept login opens Nept in your browser, waits for device approval, validates the issued API token, and stores it in the CLI config directory with user-only permissions.

For automation, use an existing key without printing it in command history:

terminal

export NEPT_API_KEY="nept_..."
nept whoami

nept login --key nept_... is also available. Authenticated commands accept --token and --json.

Deployments

terminal

nept deploy . --name my-app
nept deploy --repo owner/repository --framework Next.js
nept docker deploy --name api --image ghcr.io/acme/api:latest --port 8080

nept deployment list
nept deployment get <deployment-id>
nept deployment logs <deployment-id> --follow
nept deployment redeploy <deployment-id>

Local deploys create a ZIP while excluding Git metadata, dependencies, build output, credentials, .env*, and files matched by .gitignore or .neptignore.

Projects and runtime

terminal

nept project list
nept project get <project-id>
nept project update <project-id> --min-replicas 1 --max-replicas 5
nept project restart <project-id>
nept project logs <project-id> --follow
nept project disconnect-git <project-id>
nept project delete <project-id> --yes

nept project env list <project-id>
nept project env set <project-id> KEY=value
nept project env unset <project-id> KEY

nept project domain add <project-id> example.com
nept project domain list <project-id>
nept project domain set-primary <project-id> <domain-id>
nept project domain connect <project-id> <domain-id>

nept project pod list <project-id>
nept project pod exec <project-id> <pod-name> --command "env"
nept project pod restart <project-id> <pod-name>

Environment values and database credentials are masked unless the corresponding --show-values flag is passed.

Databases

terminal

nept db deploy --name app-db
nept db list
nept db get <database-id>
nept db schema <database-id>
nept db query <database-id> --query "select now()"
nept db generate <database-id> --prompt "show the ten newest users"
nept db delete <database-id> --yes

Teams, usage, and tokens

terminal

nept team create "Platform"
nept team list
nept team get <team-id>
nept team invite <team-id> [email protected] --role member
nept team member role <team-id> <member-id> admin
nept team project move <project-id> <team-id>

nept usage balance
nept usage current
nept usage history
nept metrics --type cpu --time-range 24h --project <project-id>
nept analytics traffic

nept token list
nept token create --show-token
nept token revoke <token-id> --yes

GitHub and checkout

terminal

nept github repos
nept github commits <owner> <repo> --branch main
nept github config <owner> <repo>
nept github fork <owner> <repo>

nept billing plan --plan Pro --open
nept billing credits --credits 100 --provider stripe --open

GitHub commands use the GitHub account connected to Nept. Billing commands create a checkout URL; payment approval stays in the provider’s browser page.

CLI Reference

terminal

npm install -g nept-cli
nept login

nept login opens Nept in your browser, waits for device approval, validates the issued API token, and stores it in the CLI config directory with user-only permissions.

For automation, use an existing key without printing it in command history:

terminal

export NEPT_API_KEY="nept_..."
nept whoami

nept login --key nept_... is also available. Authenticated commands accept --token and --json.

Deployments

terminal

nept deploy . --name my-app
nept deploy --repo owner/repository --framework Next.js
nept docker deploy --name api --image ghcr.io/acme/api:latest --port 8080

nept deployment list
nept deployment get <deployment-id>
nept deployment logs <deployment-id> --follow
nept deployment redeploy <deployment-id>

Local deploys create a ZIP while excluding Git metadata, dependencies, build output, credentials, .env*, and files matched by .gitignore or .neptignore.

Projects and runtime

terminal

nept project list
nept project get <project-id>
nept project update <project-id> --min-replicas 1 --max-replicas 5
nept project restart <project-id>
nept project logs <project-id> --follow
nept project disconnect-git <project-id>
nept project delete <project-id> --yes

nept project env list <project-id>
nept project env set <project-id> KEY=value
nept project env unset <project-id> KEY

nept project domain add <project-id> example.com
nept project domain list <project-id>
nept project domain set-primary <project-id> <domain-id>
nept project domain connect <project-id> <domain-id>

nept project pod list <project-id>
nept project pod exec <project-id> <pod-name> --command "env"
nept project pod restart <project-id> <pod-name>

Environment values and database credentials are masked unless the corresponding --show-values flag is passed.

Databases

terminal

nept db deploy --name app-db
nept db list
nept db get <database-id>
nept db schema <database-id>
nept db query <database-id> --query "select now()"
nept db generate <database-id> --prompt "show the ten newest users"
nept db delete <database-id> --yes

Teams, usage, and tokens

terminal

nept team create "Platform"
nept team list
nept team get <team-id>
nept team invite <team-id> [email protected] --role member
nept team member role <team-id> <member-id> admin
nept team project move <project-id> <team-id>

nept usage balance
nept usage current
nept usage history
nept metrics --type cpu --time-range 24h --project <project-id>
nept analytics traffic

nept token list
nept token create --show-token
nept token revoke <token-id> --yes

GitHub and checkout

terminal

nept github repos
nept github commits <owner> <repo> --branch main
nept github config <owner> <repo>
nept github fork <owner> <repo>

nept billing plan --plan Pro --open
nept billing credits --credits 100 --provider stripe --open

GitHub commands use the GitHub account connected to Nept. Billing commands create a checkout URL; payment approval stays in the provider’s browser page.