Usage

Usage Guide

Basic Commands

Account Management

# List all accounts
namecheap-dns account list

# Add new account
namecheap-dns account add [name]

# Switch to account
namecheap-dns account switch <name>

# Show account details
namecheap-dns account show [name]

# Edit account
namecheap-dns account edit [name]

# Remove account
namecheap-dns account remove <name>

Domain Management

# List all domains
namecheap-dns domain list

# Get domain information
namecheap-dns domain info <domain>

# Check domain availability
namecheap-dns domain check <domain>

# Renew domain
namecheap-dns domain renew <domain> [years]

# Get nameservers
namecheap-dns domain nameservers get <domain>

# Set nameservers
namecheap-dns domain nameservers set <domain> <ns1> [ns2] [ns3] [ns4]

# Reset to default nameservers
namecheap-dns domain nameservers default <domain>

DNS Record Management

# List DNS records
namecheap-dns dns list <domain>

# Add DNS record
namecheap-dns dns add <domain> <host> <type> <value> [ttl]

# Update DNS record
namecheap-dns dns update <domain> <host> <type> <value> [ttl]

# Delete DNS record
namecheap-dns dns delete <domain> <host> <type>

# Clear all records (with confirmation)
namecheap-dns dns clear <domain>

# Bulk operations
namecheap-dns dns bulk <domain> <file>

# Import zone file
namecheap-dns dns import <domain> <file>

# Export zone file
namecheap-dns dns export <domain> [file]

DNS Record Types

Supported record types:

• A: IPv4 address
• AAAA: IPv6 address
• CNAME: Canonical name
• MX: Mail exchange
• TXT: Text record
• NS: Name server
• SRV: Service record

Examples

Add an A Record

namecheap-dns dns add example.com www A 192.0.2.1

Add an MX Record

namecheap-dns dns add example.com @ MX mail.example.com 10

Add a CNAME Record

namecheap-dns dns add example.com www CNAME example.com

List Records by Type

# List only A records
namecheap-dns dns list example.com | grep "A "

# List only MX records
namecheap-dns dns list example.com | grep "MX "

Using Specific Accounts

Switch Account Permanently

namecheap-dns account switch work
namecheap-dns domain list  # Uses 'work' account

Use Account for Single Command

namecheap-dns --account work domain list
namecheap-dns --account personal dns list example.com

Plugins

List Available Plugins

namecheap-dns plugin list

Plugin Information

namecheap-dns plugin info <plugin-name>

Using Plugins

# Migadu email hosting setup
namecheap-dns migadu setup example.com

# Verify Migadu setup
namecheap-dns migadu verify example.com

# Remove Migadu records
namecheap-dns migadu remove example.com

Bulk Operations

Bulk DNS Updates

Create a file with operations:

operations:
  - action: add
    host: www
    type: A
    value: 192.0.2.1
    ttl: 3600
  - action: update
    host: mail
    type: A
    value: 192.0.2.2
    ttl: 3600
  - action: delete
    host: old
    type: A

Run:

namecheap-dns dns bulk example.com operations.yaml

Dry Run Mode

Some commands support --dry-run to preview changes:

namecheap-dns migadu setup example.com --dry-run

Getting Help

# General help
namecheap-dns help

# Command-specific help
namecheap-dns account --help
namecheap-dns domain --help
namecheap-dns dns --help
namecheap-dns plugin --help

Common Workflows

Setting Up a New Domain

# 1. Check domain
namecheap-dns domain check newdomain.com

# 2. List current DNS records
namecheap-dns dns list newdomain.com

# 3. Add required records
namecheap-dns dns add newdomain.com @ A 192.0.2.1
namecheap-dns dns add newdomain.com www CNAME newdomain.com

# 4. Verify setup
namecheap-dns dns list newdomain.com

Migrating Email Hosting (Migadu)

# 1. Setup Migadu DNS records
namecheap-dns migadu setup example.com --dry-run

# 2. Review changes, then apply
namecheap-dns migadu setup example.com

# 3. Verify setup
namecheap-dns migadu verify example.com

Managing Multiple Accounts

# 1. Add accounts
namecheap-dns account add personal
namecheap-dns account add work

# 2. List domains from different accounts
namecheap-dns --account personal domain list
namecheap-dns --account work domain list

# 3. Switch default account
namecheap-dns account switch work