Home

sipnab

SIP & RTP capture, analysis, and security for VoIP — one Rust binary covering an interactive TUI, CLI batch mode, NDJSON, a REST API, and an MCP server.

This wiki mirrors the in-repo docs/ directory and is regenerated automatically on every change to main. For the polished documentation site see https://www.sipnab.com.

Quick start

# Install: detects OS/CPU/glibc, verifies the sha256, installs to
# /usr/local/bin (see Installation for .deb, .rpm and manual options)
curl -fsSL https://www.sipnab.com/install.sh | sh

sudo sipnab --setup-caps      # one-time: live capture without sudo (Linux)

sipnab                        # live TUI on the default interface
sipnab -I capture.pcap        # open a pcap in the TUI
sipnab -N -I capture.pcap --problems   # headless: only problem calls

Start here

New to sipnab? Read in this order:

1. Installation — packages, capture permissions, feature flags
2. Cookbook — copy-paste recipes for triage, filtering, recording, security
3. Keybindings — driving the TUI: call list, call flow, RTP streams, search
4. Filter DSL — narrowing to the calls you care about
5. CLI Reference and Output Formats — headless use and NDJSON pipelines
6. Troubleshooting — symptom → command when a call misbehaves
7. REST API and MCP — programmatic access and AI-agent integration

All pages

Getting started

• Installation
• Cookbook
• Troubleshooting
• Backers

Using the TUI

• TUI Walkthrough
• Keybindings
• Theme Guide

CLI & automation

• CLI Reference
• Filter DSL
• Output Formats

Configuration

• Configuration

Integrations (API & MCP)

• REST API
• Authentication
• MCP
• MCP Walkthrough

Development & internals

• Internals Index
• Internals Subsystem Guide
• Internals Invariants
• Internals Testing
• Internals Walkthroughs
• Internals Build CI Release
• Internals Domain Primer
• Library API
• Benchmarks
• Fault Model
• Architecture
• Internals Threading
• Internals TUI Testing
• Internals Zero Copy Payloads