Command reference

Every command, exactly as the tool prints it

This page is generated from the binary, so it can't drift. n <command> shows the usage card; n <command> -h the concept behind it; n <command> . runs it against this machine and n <command> <host> against a remote one.

The front page — n

═══════════════════════════════════════════════════════════════════════════════
  Netscrew ("n") — The Developer's Network Screwdriver & Diagnostic Engine
═══════════════════════════════════════════════════════════════════════════════

Sleuth and harden your own machines & LAN — find out what's really going on, and fix it,
without memorising every ss / netstat / nmap / netsh switch.

THE MODEL:  n <command> = how to use it  ·  n <command> . = this machine  ·  n <command> <host> = a remote host
Every command has a short form — n ping=n pi, n ports=n p, n services=n svc. Run n <command> to see its short forms.

DIAGNOSE A HOST / NETWORK:
  n check    .|<host>   full check: reachability, latency, MAC, ports, web
  n ping     .|<host>   fast reachability radar / who-am-I
  n resolve  <host>     5-layer name-resolution audit (stale ghost IPs)
  n web      .|<host>   discover web UIs & dashboards (clickable)
  n ports    .|<host>   local listeners, or a remote port audit
  n scan     .|<cidr>   sweep a subnet for live devices

LOCAL SOCKETS & PROCESSES:
  n listen   .          listening sockets (+ process & container)
  n estab    .          established connections
  n all      .          all sockets (listening + established + UDP)
  n kill     <port>     kill the process listening on a port (asks first)

THIS MACHINE:
  n sys      .          hardware / OS / disk inventory
  n services .          service & daemon inventory
  n docker   .          containers & published ports
  n top      .          busiest remote IPs (who's connected)
  n choked   .          stalled / backed-up sockets
  n drops    .          NIC dropped-packet audit
  n firewall .          firewall status  ·  n firewall . --harden build a plan
  n flush    .          deep cache flush (asks first)
  n host     .          LAN discoverability  ·  n host . --fix repair it

STORAGE & SHARES:
  n shares   .                audit shares, mounts, permissions & UAC status
  n mount    //host/share     mount a share (SMB/CIFS) — any OS, shows the real command
  n share    .                what this machine shares  ·  n share <folder> to export one
  n bench    //host/share     how fast is it, and WHY — link, protocol, then throughput

SSH & REMOTE ACCESS:
  n ssh-server  .             is this machine set up to accept SSH?
  n ssh-agent   .             agent status / load your keys
  n ssh-copy-id <host>        install your key for passwordless login (Windows too)
  n tunnel      <host> <spec> SSH port-forward, explained as it runs
  n rdp         .|<host>      Remote Desktop readiness (local) or reachability (remote)

DOCS:
  n guide    [topic]    built-in playbooks  ·  n guide export to write HTML
  n license  <key>      $5 removes the coffee message — nothing else changes  ·  n license status

GLOBAL FLAGS: --yes -y skip prompts · --probe public hosts · --full wide audit · --no-sudo

───────────────────────────────────────────────────────────────────────────────
  Help:    n <command> = usage (with its short forms) · n <command> -h = the concept · n -h = all playbooks
  Target:  . = this machine (= me, localhost, 127.0.0.1) · <host> = a remote IP/name

Commands

commandshort formswhat it does
n checkc ch chk health diag diagnostics triageDiagnostic triage ladder or target health check
n pingpi radarFast reachability radar (<300ms) or Who Am I loopback
n resolver res resolv lookup ns5-layer name cache debugger & ghost IP detection
n webw we ui dashboardsWeb services & dashboards discovery (local or remote)
n portsp po portPort inspection (local listening or remote target ports)
n scansc sweep subnetSubnet network scanner
n flushf fl flush-dns flush-cacheDeep DNS/NetBIOS/ARP/Samba cache flush
n hosth ho visibility discoverLAN discoverability audit
n syssy sysinfo system hardwareHardware, OS, storage & system inventory
n dockerd dock containers psDocker containers and published port mapping
n listenl lis listening slList listening ports with process names
n estabe es established activeList active established connections
n alla saMaster socket view (listening + established)
n killk kilKill process bound to port
n servicesse svc service daemonsService & daemon inventory
n firewallfw fir ufw iptablesFirewall rules & port blocking audit
n topt top-ips conns topconnsTop remote IPs by active connections
n chokedchok backlog stalledStalled socket detection
n dropsdr errors rx-errors link-healthPacket drops & CRC framing errors
n guideg gui doc docs playbook playbooks kbInteractive engineering playbooks, offline documentation & HTML export
n sharessh smb nfs mountsNetwork storage, SMB/Samba shares, permissions & remote mounts
n mountmap cifs mntMount a network share (SMB/CIFS) — cross-platform, hides the syntax
n shareexport serveShare (export) a local folder over SMB — the recipe for your OS
n benchb be bm speed speedtestHow fast is a share or host — and WHY: path, protocol, then throughput
n licenselic activate unlockActivate a licence key — removes the coffee message. That is all it changes
n rdpremotedesktop mstscRemote Desktop readiness check & repair (local or remote)
n ssh-copy-idcopy-id ssh-copy pushkey authkeyInstall your SSH key on a host for passwordless login (works on Windows too)
n ssh-serversshd ssh-srv sshserverCheck & repair this machine's SSH server (sshd) — Windows gotchas included
n ssh-agentagent ssh-addSSH agent status & load your keys (starts the Windows agent service)
n tunnelforward port-forward proxySSH port forwarding made easy (-L / -R / -D), explained as it runs