CLI Reference

Commands

graph LR
    DN[darwin-nic] --> SETUP[setup]
    DN --> CONF[configure]
    DN --> STATUS[status]
    DN --> DASH[dashboard]
    DN --> TEST[test]
    DN --> RESTORE[restore]
    DN --> CONFIG[config]
    DN --> PROFILES[profiles]
    DN --> INIT[init-config]

darwin-nic setup

Interactive guided setup wizard with Rich TUI.

darwin-nic setup

Walks through:

1. Baseline detection (no USB NIC)
2. USB NIC insertion detection
3. Cable connection guidance
4. IP configuration
5. Connectivity verification

darwin-nic configure

CLI configuration for scripting and automation.

darwin-nic configure [OPTIONS]

Options

When using --profile, device-ip and laptop-ip are loaded from the config file. Without --profile, they are required on the command line.

Examples

# Use a saved profile
darwin-nic configure --profile homelab

# Use profile with dry-run
darwin-nic configure --profile homelab --dry-run

# Manual configuration
darwin-nic configure --device-ip 192.0.2.1 --laptop-ip 192.0.2.100

# With WiFi preservation
darwin-nic configure \
  --device-ip 192.0.2.1 \
  --laptop-ip 192.0.2.100 \
  --preserve-wifi

# Custom network
darwin-nic configure \
  --device-ip 10.0.0.1 \
  --laptop-ip 10.0.0.100 \
  --netmask 255.255.0.0 \
  --mgmt-network 10.0.0.0/16

darwin-nic status

Display current network status.

darwin-nic status

Shows:

• Active interfaces
• WiFi status
• USB NIC status
• Service order
• Bastion/OOB diagnostics on macOS when relevant, including scutil --nwi, Tailscale system-extension state, and recent NECP drop hints

darwin-nic dashboard

Real-time network monitoring dashboard.

darwin-nic dashboard [OPTIONS]

Options

Examples

# Static dashboard
darwin-nic dashboard

# Monitor interference for 60 seconds
darwin-nic dashboard --interference --duration 60

darwin-nic test

Test connectivity to common endpoints.

darwin-nic test

Tests:

• Local interfaces (en0, en1, en11)
• Common management IPs (192.0.2.1, 192.168.1.1)
• Internet connectivity (8.8.8.8)

darwin-nic restore

Restore backup network configuration.

darwin-nic restore

Restores:

• Service order backup
• WiFi priority

Configuration Commands

darwin-nic config

Display current configuration and available profiles.

darwin-nic config

Shows:

• Config file locations and which are loaded
• Current settings (device IP, laptop IP, etc.)
• Available profiles with their settings

darwin-nic profiles

List available profiles from config files.

darwin-nic profiles

darwin-nic init-config

Initialize a user config file with defaults.

darwin-nic init-config

Creates ~/.config/darwin-nic/config.toml with example profiles.

Configuration Files

Settings are loaded from TOML config files in order of precedence:

Example Config

default_profile = "homelab"

[defaults]
netmask = "255.255.255.0"
preserve_wifi = true

[profiles.homelab]
device_ip = "192.168.88.1"
laptop_ip = "192.168.88.100"
mgmt_network = "192.168.88.0/24"
device_name = "Lab Management Device"
description = "Home lab management network"

[profiles.datacenter]
device_ip = "10.200.0.1"
laptop_ip = "10.200.0.100"
mgmt_network = "10.200.0.0/24"
device_name = "DC Core Switch"

See examples/config.toml for a full example.

Global Options

Exit Codes