https://github.com/niw/cfddns

A simple command line tool to update Cloudflare DNS record.
https://github.com/niw/cfddns

cloudflare ddns dns rust

Last synced: about 2 months ago
JSON representation

A simple command line tool to update Cloudflare DNS record.

• Host: GitHub
• URL: https://github.com/niw/cfddns
• Owner: niw
• License: mit
• Created: 2024-04-04T06:41:45.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-10-31T23:17:17.000Z (2 months ago)
• Last Synced: 2024-11-01T00:19:37.086Z (2 months ago)
• Topics: cloudflare, ddns, dns, rust
• Language: Rust
• Homepage:
• Size: 42 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Cloudflare Dynamic DNS Client

=============================

A simple command line tool to update Cloudflare DNS record with

external IP address to use it as dynamic DNS.

NAME

----

`cfddns` -- A simple command line tool to update Cloudflare DNS record.

SYNOPSIS

--------

```

cfddns --api-token  --zone-id  COMMAND [OPTIONS]

```

- `--api-token` or `API_TOKEN` environment variable is a token that is

  created at .

- `--zone-id` or `ZONE_ID` enrivonment variable is found on "Overview"

  page on each domain name on Cloudflare dashboard.

### Command

#### `update`

Update a Cloudflare DNS record with an external IP address.

- `--record-id` to specify the record id to update. Use `list` command

  to find this.

- `--record-type` is DNS record type. Default to use `A`.

- `--name` is DNS record name.

- `--provider` is the provider to fetch the external IP address.

  Possible values is either

  `upnp` to use UPnP, `aws` to use `https://checkip.amazonaws.com/`,

  `dyndns` to use `http://checkip.dyndns.org/`.

  Default to use `upnp`.

#### `list`

List all Cloudflare DNS records.

This command takes no options.

#### `print-launchd-plist`

Print `launchd(8)` plist file to update DNS record. Useful to install `cfddns` as a repeated task on macOS.

This command takes same options as `update` command.

DESCRIPTION

-----------

`cfddns` is a simple command line tool to update Cloudflare DNS record

with external IP address to use it as dynamic DNS.

External IP address is fetched by UPnP locally or 3rd party API.

USAGE

-----

Use [Cargo](https://www.rust-lang.org/) to build it.

```bash

cargo build --release # Build binary.

target/release/cfddns help # Print usage.

```

DEVELOPMENT

-----------

This source code is mostly generated by the large language model with

a little advice by a human.