Skip to content
Getting Started

Getting Started

Install

# Install platform components (one command)
np install

# Or with auto-pilot (install + project scaffold)
np install --init

Alternative: download the binary directly:

curl -Lo np https://github.com/np-run/np/releases/latest/download/np-linux-amd64
chmod +x np
sudo mv np /usr/local/bin/

Your first project

np init

This creates np.yaml — the single file that defines your deployment:

# np.yaml
version: "1"
services:
  - name: hello
    type: container
    source: nginx:alpine
    port: 8080
    domain: hello.my-app.com  # optional: auto-generates Traefik routing
    resources:
      cpu: "100"
      memory: "128"
    replicas: 1

Deploy

np deploy hello

Preview without deploying:

np deploy hello --dry-run

Check status

# All services
np status

# One service
np status hello

Scale

np scale hello 3

View logs

# Snapshot
np logs hello

# Follow
np logs --follow hello

Run diagnostics

np doctor

Next: Configuration reference →