Metadata-Version: 2.1
Name: proteuscmd
Version: 0.4
Summary: A command line interface to modify DNS entries in Proteus.
Home-page: https://github.com/virtUOS/proteuscmd
Author: Lars Kiesow
Author-email: lkiesow@uos.de
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown

# Proteus Command Line Client

A simple command line client to modify DNS entries in Proteus.

## Installation

Use `pip` to install `proteuscmd`:

```
❯ pip install proteuscmd
```

## Configuration

Configure access credentials in `~/.proteus.json`:
```json
{
	"user": "api-user",
	"password": "super.secret!",
	"url": "https://proteus.example.com"
}
```

Additionally, you can specify a map of automatic replacements for domains.
This can be useful if, for example, all your domains also have an alternate domain with a `DNAME` record.
```json
{
	...
	"replace": {
		".ex.com": ".example.com"
	}
}
```

## Usage

```
❯ proteuscmd
usage: proteuscmd [-h] [--view {all,intern,extern}] {get,set,delete} domain [target]
```

Get information about a DNS record:
```
❯ proteuscmd get lktest.uni-osnabrueck.de
```

Set an alias record:
```
❯ proteuscmd set lktest.uni-osnabrueck.de vm123.rz.uni-osnabrueck.de
```

Set a host record:
```
❯ proteuscmd set lktest.uni-osnabrueck.de 131.12.65.123
```

Delete a record:
```
❯ proteuscmd delete lktest.uni-osnabrueck.de
```


