Quick start

1. Connect

Interactive login creates and selects a named profile:

nginxpm login

For non-interactive use, set credentials directly instead:

export NGINXPM_URL=https://npm.example.com
export NGINXPM_EMAIL=admin@example.com
export NGINXPM_PASSWORD=changeme

2. Confirm connectivity and identity

nginxpm status
nginxpm user current

status checks the server without authenticating. user current verifies the credentials by fetching the authenticated user.

3. Inspect and manage

# Inventory proxy hosts as JSON
nginxpm proxy list -o json

# Inspect one certificate as YAML
nginxpm cert get 1 -o yaml

# Create a proxy host from a JSON or YAML definition
nginxpm proxy create -f proxy.json

Create and update commands that take -f also accept standard input as -f -. Delete commands prompt for confirmation unless you pass --confirm.

Discovering commands

Every command has -h/--help:

nginxpm --help
nginxpm proxy --help
nginxpm proxy create --help

Output formats

table, json, and yaml output for human and machine use.

Commands

The command surface, grouped by area.