NAMECHEAP(1)

✨ NAMECHEAP ✨

okay bestie, gather round 💖 this is the manual page for namecheap, and it lives in section 1 of the General Commands Manual. it's a CLI tool to manage NameCheap.com domain records. that's it, that's the vibe. you're about to be so good at DNS 🦋

🌸 PREREQUISITES 🌸

so before you can do literally anything, namecheap needs three things from you: an api key, a username, and an address. the very first time you run the tool it creates a config file for you at ~/.namecheap_cfg. cute, right? 🎀

but bestie, listen, the defaults in there are not yours. you must replace them with your own values:

#!/usr/bin/env python

api_key = '0123456789abcdef0123456789abcdef'

username = 'myusername'

ip_address = '10.0.0.1'

not me leaving placeholder credentials in a config file 💀 swap those out, fr fr.

✨ SYNOPSIS ✨

namecheap [-h] [--debug] [--sandbox]

(--add | --delete | --list) [--domain DOMAIN]
       [--type TYPE] [--name NAME] [--address ADDRESS] [--ttl TTL]

💅 OPTIONS 💅

• -h, --help — shows you this help message and then dips. bye 👋
• --debug — if you set this, debug output gets enabled. everything's loud now 🔥
• --sandbox — if you set this, it forces usage of the Sandbox API. check README.md for the details, iykyk 📖
• --add — use this to add a record. new record, who dis 🌈
• --delete — use this to remove a record. gone, periodt 💀
• --list — lists the existing records. show me what you got 👑
• --domain DOMAIN — the domain you wanna manage. default is "example.org", and bestie, do not forget to override it 😭
• --type TYPE — record type. default is "A"
• --name NAME — record name. default is "test"
• --address ADDRESS — the address the record points to. default is "127.0.0.1"
• --ttl TTL — Time-To-Live, in seconds. default is 300

and then, the little combo platter again, just so you know the shape of it 🫶:

(--add | --delete | --list) [--domain DOMAIN]
       [--type TYPE] [--name NAME] [--address ADDRESS] [--ttl TTL]

🦋 SEE ALSO 🦋

for more info on this tool, go look at https://github.com/Bemmu/pyNamecheap/ — it's giving documentation, it's giving source 💜

and that's the whole page, bestie!! this one came out of User Commands, dated April 2018 🌸 go forth and manage those domain records, you absolute icon ⭐💖