NATS

High-performance message streaming commands. Manage subjects, streams, consumers, and publish-subscribe messaging.

52 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Context

Connection & contexts

6commands

Pub/Sub

Core messaging

7commands

Streams

JetStream streams

8commands

Consumers

JetStream consumers

7commands

Key-Value

KV store operations

9commands

Object Store

Object storage

5commands

Admin

Server administration

7commands

Install NATS server (macOS)

$ brew install nats-server

Install NATS server using Homebrew on macOS

Install NATS CLI

$ brew install nats-io/nats-tools/nats

Install the NATS CLI tool using Homebrew

Start NATS server

$ nats-server

Start a local NATS server with default settings

Add context

$ nats context add local --server nats://localhost:4222

Create named connection configuration.

List contexts

$ nats context ls

Display all saved contexts.

Select context

$ nats context select local

Switch to different context.

Server info

$ nats server info

Display server version, uptime, connections, cluster info.

Account info

$ nats account info

View account limits and JetStream details.

Check RTT

$ nats rtt

Check round-trip time to server.

Publish message

$ nats pub subject 'Hello World'

Publish a message to a subject.

Publish multiple

$ nats pub demo "message {{.Count}}" --count=10

Publish multiple messages with templating.

Subscribe to subject

$ nats sub 'events.>'

Subscribe using wildcard pattern.

Queue group subscribe

$ nats sub orders --queue=workers

Join queue group for load-balanced delivery.

Request-reply

$ nats request greet.joe 'Hello'

Send request and wait for response.

Reply service

$ nats reply greet.> 'Hello!'

Listen for requests and send responses.

Benchmark pub/sub

$ nats bench test --pub 10 --sub 10 --msgs 10000 --size 512

Benchmark with 10 publishers and subscribers.

Create stream

$ nats stream add ORDERS --subjects 'orders.*' --storage file

Create persistent stream with file storage.

Create stream (interactive)

$ nats stream add

Create stream with interactive prompts.

List streams

$ nats stream ls

List all streams.

Stream info

$ nats stream info ORDERS

View stream configuration and state.

View messages

$ nats stream view ORDERS

Browse messages in stream.

Purge stream

$ nats stream purge ORDERS

Remove all messages without deleting stream.

Delete stream

$ nats stream rm ORDERS -f

Delete stream (force, no confirmation).

Stream report

$ nats stream report

Generate report of all streams.

Create pull consumer

$ nats consumer add ORDERS DISPATCH --pull --ack explicit --max-deliver 20

Create pull-based consumer with retry limits.

Create push consumer

$ nats consumer add ORDERS MONITOR --target monitor.orders --ack none

Create push consumer that sends to target subject.

List consumers

$ nats consumer ls ORDERS

List consumers for a stream.

Consumer info

$ nats consumer info ORDERS DISPATCH

View consumer configuration and state.

Get next message

$ nats consumer next ORDERS DISPATCH

Retrieve next available message from pull consumer.

Pause consumer

$ nats consumer pause ORDERS DISPATCH

Temporarily suspend consumer (NATS 2.11+).

Resume consumer

$ nats consumer resume ORDERS DISPATCH

Resume paused consumer.

Create KV bucket

$ nats kv add my-kv --history=3

Create KV bucket with 3 value revisions.

List buckets

$ nats kv ls

List all KV buckets.

Put value

$ nats kv put my-kv key1 'value1'

Store or update key value.

Get value

$ nats kv get my-kv key1

Retrieve value for key.

Create (exclusive)

$ nats kv create my-kv lock-key 'locked'

Create key only if not exists (semaphore pattern).

Update (CAS)

$ nats kv update my-kv key1 'new-value' 13

Update only if revision matches (compare-and-swap).

Watch bucket

$ nats kv watch my-kv

Watch for real-time changes to all keys.

Key history

$ nats kv history my-kv key1

View full history of key values.

Delete key

$ nats kv del my-kv key1

Remove key from bucket.

Create object store

$ nats obj add files --description 'File storage'

Create object store bucket.

Upload file

$ nats obj put files ./myfile.pdf

Upload file to object store.

Download file

$ nats obj get files myfile.pdf

Download file from object store.

List objects

$ nats obj ls files

List objects in bucket.

Delete object

$ nats obj rm files myfile.pdf --force

Delete file from bucket.

Ping servers

$ nats server ping

Display RTT to all cluster servers.

List servers

$ nats server list

List all servers with details.

Connection report

$ nats server report connections

Report of all connections in cluster.

JetStream report

$ nats server report jetstream

JetStream usage across cluster.

Check stream health

$ nats server check stream ORDERS

Monitor stream health status.

System events

$ nats events

Monitor connects, disconnects, auth errors.

Latency measurement

$ nats latency

Measure round-trip latency with HDR percentiles.

Discussion

Loading comments...

NATS

High-performance message streaming commands. Manage subjects, streams, consumers, and publish-subscribe messaging.

52 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Context

Connection & contexts

6commands

Pub/Sub

Core messaging

7commands

Streams

JetStream streams

8commands

Consumers

JetStream consumers

7commands

Key-Value

KV store operations

9commands

Object Store

Object storage

5commands

Admin

Server administration

7commands

Install NATS server (macOS)

$ brew install nats-server

Install NATS server using Homebrew on macOS

Install NATS CLI

$ brew install nats-io/nats-tools/nats

Install the NATS CLI tool using Homebrew

Start NATS server

$ nats-server

Start a local NATS server with default settings

Add context

$ nats context add local --server nats://localhost:4222

Create named connection configuration.

List contexts

$ nats context ls

Display all saved contexts.

Select context

$ nats context select local

Switch to different context.

Server info

$ nats server info

Display server version, uptime, connections, cluster info.

Account info

$ nats account info

View account limits and JetStream details.

Check RTT

$ nats rtt

Check round-trip time to server.

Publish message

$ nats pub subject 'Hello World'

Publish a message to a subject.

Publish multiple

$ nats pub demo "message {{.Count}}" --count=10

Publish multiple messages with templating.

Subscribe to subject

$ nats sub 'events.>'

Subscribe using wildcard pattern.

Queue group subscribe

$ nats sub orders --queue=workers

Join queue group for load-balanced delivery.

Request-reply

$ nats request greet.joe 'Hello'

Send request and wait for response.

Reply service

$ nats reply greet.> 'Hello!'

Listen for requests and send responses.

Benchmark pub/sub

$ nats bench test --pub 10 --sub 10 --msgs 10000 --size 512

Benchmark with 10 publishers and subscribers.

Create stream

$ nats stream add ORDERS --subjects 'orders.*' --storage file

Create persistent stream with file storage.

Create stream (interactive)

$ nats stream add

Create stream with interactive prompts.

List streams

$ nats stream ls

List all streams.

Stream info

$ nats stream info ORDERS

View stream configuration and state.

View messages

$ nats stream view ORDERS

Browse messages in stream.

Purge stream

$ nats stream purge ORDERS

Remove all messages without deleting stream.

Delete stream

$ nats stream rm ORDERS -f

Delete stream (force, no confirmation).

Stream report

$ nats stream report

Generate report of all streams.

Create pull consumer

$ nats consumer add ORDERS DISPATCH --pull --ack explicit --max-deliver 20

Create pull-based consumer with retry limits.

Create push consumer

$ nats consumer add ORDERS MONITOR --target monitor.orders --ack none

Create push consumer that sends to target subject.

List consumers

$ nats consumer ls ORDERS

List consumers for a stream.

Consumer info

$ nats consumer info ORDERS DISPATCH

View consumer configuration and state.

Get next message

$ nats consumer next ORDERS DISPATCH

Retrieve next available message from pull consumer.

Pause consumer

$ nats consumer pause ORDERS DISPATCH

Temporarily suspend consumer (NATS 2.11+).

Resume consumer

$ nats consumer resume ORDERS DISPATCH

Resume paused consumer.

Create KV bucket

$ nats kv add my-kv --history=3

Create KV bucket with 3 value revisions.

List buckets

$ nats kv ls

List all KV buckets.

Put value

$ nats kv put my-kv key1 'value1'

Store or update key value.

Get value

$ nats kv get my-kv key1

Retrieve value for key.

Create (exclusive)

$ nats kv create my-kv lock-key 'locked'

Create key only if not exists (semaphore pattern).

Update (CAS)

$ nats kv update my-kv key1 'new-value' 13

Update only if revision matches (compare-and-swap).

Watch bucket

$ nats kv watch my-kv

Watch for real-time changes to all keys.

Key history

$ nats kv history my-kv key1

View full history of key values.

Delete key

$ nats kv del my-kv key1

Remove key from bucket.

Create object store

$ nats obj add files --description 'File storage'

Create object store bucket.

Upload file

$ nats obj put files ./myfile.pdf

Upload file to object store.

Download file

$ nats obj get files myfile.pdf

Download file from object store.

List objects

$ nats obj ls files

List objects in bucket.

Delete object

$ nats obj rm files myfile.pdf --force

Delete file from bucket.

Ping servers

$ nats server ping

Display RTT to all cluster servers.

List servers

$ nats server list

List all servers with details.

Connection report

$ nats server report connections

Report of all connections in cluster.

JetStream report

$ nats server report jetstream

JetStream usage across cluster.

Check stream health

$ nats server check stream ORDERS

Monitor stream health status.

System events

$ nats events

Monitor connects, disconnects, auth errors.

Latency measurement

$ nats latency

Measure round-trip latency with HDR percentiles.

Discussion

Loading comments...