Cloudflare-DDNS-Sync-CLI is a cli for the NPM package Cloudflare-DDNS-Sync. Cloudflare-DDNS-Sync is a simple NPM package that updates the IP address of Cloudflare DNS records.
What are the goals of this project?
The goal of Cloudflare-DDNS-Sync-CLI is to make updating the IP of Cloudflare DNS records as easy as possible, without the need of any coding experience.
How do I set this project up?
- Node (16, 18)
- Cloudflare Account
To install Cloudflare-DDNS-Sync-CLI simply run:
npm install -g cloudflare-ddns-sync-cli
After installation, simply run
cds configuration in your terminal to set up Cloudflare-DDNS-Sync.
Then you can run
cds sync to sync the records that were configured earlier.
If you run the command with a valid ip like
cds sync 18.104.22.168 Cloudflare-DDNS-Sync will use the ip. Otherwise it will use your external ip.
- cds help
- cds default
- cds configuration
- cds config
- cds addRecords
- cds removeRecords
- cds sync [ip]
- cds syncOnIpChange
Shows everything that Cloudflare-DDNS-Sync-CLI can do.
Set a default command. When a default command is set 'cds' can be used instead of that command-
For example when setting 'syncOnIpChange' as default, 'cds' will do the same as 'cds syncOnIpChange'.
Start the configuration tool of Cloudflare-DDNS-Sync.
Show the configuration of Cloudflare-DDNS-Sync.
Add a record to the existing configuration
Remove a record from the existing configuration
Sync the DNS Records. If the ip is not set it will simply use your external ip.
cds sync 22.214.171.124
Sync the DNS Records as soon as the external ip differs from the ip set in the configured DNS Records.
Note: This will stop as soon as the terminal session ends, or when the command gets aborted.
Get Your Cloudflare API Key
- Go to Cloudflare
- Log In
- In the upper right corner: click on your email address
- Go to "My Profile"
- In the "API Key"-Section: click on the "View API Key"-Button of the Global Key
- Enter your password and fill the captcha
- Copy the API Key
♻️Rewrite Code in TypeScript
✨Add syncOnIpChange Functionality ✨Add default Functionality ✨Add Help Command 💄Improve Code Quality
✨Replace LowDB by Data-Store
🐛Fix Other Functions When CDS is Not Configured
🐛Fix Sync When CDS is Not Configured
✨Add Basic Functionality