inwx/readme.md
Christian Fraß 72192ed2bf [fix] readme
2023-10-26 11:53:01 +02:00

936 B

Description

A simple CLI client for the API of INWX

Usage

Credentials

For most API calls it is necessary to provide login information. There are two ways to do this:

Via command line arguments

  • --username for specifying the username of the account
  • --password for specifying the username of the account

Via configuration file

  • the location of a configuration file can be specified via --conf

  • the default location is ~/.inwx-conf.json

  • a minial configuration file for specifying the credentials would look as follows:

    { "account": { "username": "", "password": "" } }

Commands

list

  • synopsis: inwx list <domain>
  • description: for listing the records of a domain

save

  • synopsis: inwx save <domain> <name> <type> <content>
  • description: for creating or updating a records of a domain
  • example: inwx save example.org dat TXT 'foo bar'