Usage

porkbun-api-client

CLI client for managing domains with Porkbun through API calls.

It can create, edit and list DNS records following a configuration provided in a YAML file. The client is flexible and can restrict its operations to only a subset choosen by the user by supporting several operation modes:

  • append – only new entries are created preserving existing entries

    unchanged

  • replace – replace all existing entries with user configuration

  • update – only update existing entries without creating or removing

    entries that are not listed in the configuration

  • upgrade – create new entries or update exising but do not remove

    entries that are not listed in the configuration

porkbun-api-client [OPTIONS] CONFIG_FILE [ARGUMENTS]...

Options

-m, --mode <mode>
Options:

append | replace | update | upgrade

-n, --dry-run

Perform a trial run without any changes made

-V, --version

Print tool version and exit

-v, --verbose

Output verbosity

Arguments

CONFIG_FILE

Required argument

ARGUMENTS

Optional argument(s)