Commands Reference

Description of commands available in the NoVPS console client

Authorization

List of commands related to authorization 

﻿

novps auth login

Authenticate with a Personal Access Token.

Option
Short
Default
Description
--token
-t
—
Personal Access Token. If not provided, you will be prompted interactively.
--project
-p
default
Project alias to store the token under.

Option	Short	Default	Description
`--token`	`-t`	—	Personal Access Token. If not provided, you will be prompted interactively.
`--project`	`-p`	`default`	Project alias to store the token under.

The token must start with nvps_. The CLI validates the token by making a test API call before saving it.

Examples:

﻿

novps auth logout

Remove the saved authentication token.

Option
Short
Default
Description
--project
-p
default
Project alias to remove the token for.

Option	Short	Default	Description
`--project`	`-p`	`default`	Project alias to remove the token for.

Examples:

﻿

novps auth status

Show current authentication status.

Option
Short
Default
Description
--project
-p
default
Project alias to check.

Option	Short	Default	Description
`--project`	`-p`	`default`	Project alias to check.

Displays whether you are authenticated and shows a truncated token prefix for identification.

Examples:

﻿

Applications

List of commands related to applications and resources

﻿

novps apps list

List all applications in the project.

Option
Short
Default
Description
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

Output columns: ID, Name, Resources, Created At.

Examples:

﻿

novps apps resources

List resources belonging to an application.

Argument
Required
Description
APP_ID
Yes
Application ID.

Argument	Required	Description
`APP_ID`	Yes	Application ID.

Option
Short
Default
Description
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

Output columns: ID, Name, Type, Public Domain, Replicas, Schedule.

Examples:

﻿

novps resources get

Show detailed information about a resource.

Argument
Required
Description
RESOURCE_ID
Yes
Resource ID.

Argument	Required	Description
`RESOURCE_ID`	Yes	Resource ID.

Option
Short
Default
Description
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

Displays a detailed table with resource properties: Name, Type, Public Domain, Custom Domains, Private Domain, Schedule, Replica Size (CPU, Memory, Storage), Replicas, Command, HTTP Port, Internal Ports, Docker Image, and Docker Digest.

Examples:

﻿

novps resources logs

View resource logs.

Argument
Required
Description
RESOURCE_ID
Yes
Resource ID.

Argument	Required	Description
`RESOURCE_ID`	Yes	Resource ID.

Option
Short
Default
Description
--follow
-f
false
Follow log output in real time (like tail -f).
--lines
-n
100
Number of log lines to display (1–5000).
--since
-s
1h
Show logs since duration. Format: 30s, 5m, 1h, 1d.
--search
﻿
—
Filter logs by substring.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--follow`	`-f`	`false`	Follow log output in real time (like `tail -f`).
`--lines`	`-n`	`100`	Number of log lines to display (1–5000).
`--since`	`-s`	`1h`	Show logs since duration. Format: `30s`, `5m`, `1h`, `1d`.
`--search`		—	Filter logs by substring.
`--project`	`-p`	`default`	Project alias.

Each log line is displayed with a timestamp in YYYY-MM-DD HH:MM:SSformat (local timezone). When --follow is enabled, new logs are polled every 3 seconds. Press Ctrl+C to stop.

Examples:

﻿

Secrets

List of commands related to secrets

﻿

novps secrets list

List secret keys for an application or a specific resource.

Argument
Required
Description
APP_ID
Yes
Application ID.

Argument	Required	Description
`APP_ID`	Yes	Application ID.

Option
Short
Default
Description
--resource
-r
—
Resource ID. When provided, only secrets for that resource are shown.
--with-values
﻿
false
Include secret values in the output.
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--resource`	`-r`	—	Resource ID. When provided, only secrets for that resource are shown.
`--with-values`		`false`	Include secret values in the output.
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

When called without --resource, displays both global secrets and per-resource secrets in separate tables. When --resource is specified, only shows secrets for that resource.

Examples:

﻿

novps secrets get

Get a single secret value by key name.

Argument
Required
Description
APP_ID
Yes
Application ID.
SECRET_KEY
Yes
Secret key name (e.g. DATABASE_URL).

Argument	Required	Description
`APP_ID`	Yes	Application ID.
`SECRET_KEY`	Yes	Secret key name (e.g. `DATABASE_URL`).

Option
Short
Default
Description
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

Displays a table with columns: Key, Value, Resource ID (shows "global" if not resource-specific).

Examples:

﻿

Databases

List of commands related to databases

﻿

novps databases list

List all databases in the project.

Option
Short
Default
Description
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

Output columns: ID, Name, Engine, Status, Node Type, Nodes.

Examples:

﻿

Registry

List of commands related to docker registry

﻿

novps registry list

List Docker registry namespaces.

Option
Short
Default
Description
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

Output columns: ID, Name, Plan, Created At.

Examples:

﻿

S3 Storage

List of commands related to S3-compatible storage

﻿

novps storage list

List S3 buckets.

Option
Short
Default
Description
--json
﻿
false
Output as JSON.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--json`		`false`	Output as JSON.
`--project`	`-p`	`default`	Project alias.

Output columns: ID, Name, Access Level, Created At.

Examples:

﻿

Port forwarding

Port forwarding allows you to access remote resources (application ports, databases) on your local machine. This is particularly useful for connecting to databases without exposing them to the public internet, or for accessing internal services during development.

The connection is established through a secure WebSocket tunnel.

﻿

novps port-forward resource

Forward a local port to a resource.

Argument
Required
Description
RESOURCE_ID
Yes
Resource ID to forward to.
REMOTE_PORT
Yes
Remote port on the resource.

Argument	Required	Description
`RESOURCE_ID`	Yes	Resource ID to forward to.
`REMOTE_PORT`	Yes	Remote port on the resource.

Option
Short
Default
Description
--local-port
-l
Same as remote port
Local port to listen on.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--local-port`	`-l`	Same as remote port	Local port to listen on.
`--project`	`-p`	`default`	Project alias.

Press Ctrl+C to stop forwarding.

Examples:

﻿

novps port-forward database

Forward a local port to a database.

Argument
Required
Description
DATABASE_ID
Yes
Database ID to forward to.

Argument	Required	Description
`DATABASE_ID`	Yes	Database ID to forward to.

Option
Short
Default
Description
--local-port
-l
Database engine default port
Local port to listen on.
--project
-p
default
Project alias.

Option	Short	Default	Description
`--local-port`	`-l`	Database engine default port	Local port to listen on.
`--project`	`-p`	`default`	Project alias.

The remote port is determined automatically based on the database engine. Press Ctrl+C to stop forwarding.

Examples:

﻿

Global Options

These options are available across all commands:

Option
Short
Description
--project
-p
Project alias for multi-project setup. Defaults to default.
--json
﻿
Output as JSON instead of a formatted table. Available on all list/get commands.

Option	Short	Description
`--project`	`-p`	Project alias for multi-project setup. Defaults to `default`.
`--json`		Output as JSON instead of a formatted table. Available on all list/get commands.

﻿

Configuration

The CLI stores its configuration in ~/.novps/config.json.

Setting
Source
Default
Token
~/.novps/config.json
—
API URL
NOVPS_API_URL env var
https://api.novps.io
WebSocket URL
NOVPS_WS_URL env var
wss://websocket.novps.io

Setting	Source	Default
Token	`~/.novps/config.json`	—
API URL	`NOVPS_API_URL` env var	`https://api.novps.io`
WebSocket URL	`NOVPS_WS_URL` env var	`wss://websocket.novps.io`

Configuration file structure:

Environment variables take precedence over values in the config file.

Read also

Getting started with NoVPS CLI

NoVPS console client description

How to create Personal Access Token

Step-by-step guide to creating a personal access token for use with NoVPS CLI