Skip to content
Docs
Getting Started

Getting Started

Install 

curl -fsSL https://np.run/install.sh | bash

Or download the binary directly:

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

Initialize 

np init

This creates np.yaml in your project directory — the single file that describes your deployment.

Your first deployment 

# np.yaml
name: hello
binary: ./hello-server
health_check: /health
resources:
  cpu: 100m
  memory: 64mb
np deploy hello

Output:

Deploying hello (binary)
✅ Deployed hello (1 replica(s))
   * hostname     port 8080
   ✅ health check: http://127.0.0.1:8080/ → 200 OK

Tip: np status hello    # check running state
     np logs hello       # view logs

Check status 

np status
[OK] hello                1/1 running, healthy

Scale 

np scale hello --count 3

View logs 

np logs hello

Stop 

np stop hello

Next: Configuration reference →

Why np