Documentation
The command reference below is generated from the binary's own
--help, so it describes the version it was built from rather
than what someone remembered to write down. This page documents
v1.1.0 — check yours with
namecheap --version.
Guides
The safety model
What validation, snapshots and read-back each protect you from.
DNS in CI
Assert a zone has not drifted, and authenticate without stored state.
Email forwarding and MX
Why forwarding silently stops, and how the tool warns you first.
Moving a zone in
Export from another provider, sync, and verify it is really being served.
Commands
namecheap auth
Authentication commands
5 subcommands
namecheap domains
Domain management commands
7 subcommands
namecheap dns
DNS record management commands
11 subcommands
namecheap preset
Preset management commands
4 subcommands
namecheap verify
Verify DNS propagation
namecheap ns
Nameserver management commands
7 subcommands
namecheap whoisguard
Domain privacy (WhoisGuard) commands
6 subcommands
namecheap redirect
URL redirect management commands
3 subcommands
namecheap transfer
Inbound domain transfer commands
4 subcommands
namecheap completions
Generate shell completions
Global options
Accepted by every command, and omitted from the per-command listings.
-p, --profile <PROFILE> | Profile to use |
--config <CONFIG> | Path to config file |
--json | Output as JSON |
--dry-run | Dry run mode - don't make any changes |
-q, --quiet | Quiet mode - minimal output |
-v, --verbose | Verbose output |
-y, --yes | Skip confirmation prompts |
--no-backup | Do not snapshot the zone before changing it |
Exit codes
Distinct codes so a script can tell a drifted zone from a failed command.
0 | Success |
1 | General error |
2 | Authentication error |
3 | Domain not found |
4 | Record not found |
5 | Validation error |
6 | Network error |
7 | Verification failed |
8 | dns diff --check found differences |