ungleich-cli/README.md

64 lines
1.1 KiB
Markdown
Raw Normal View History

2019-05-12 12:31:51 +02:00
# ungleich cli
2019-04-27 00:56:57 -04:00
2019-05-12 12:31:51 +02:00
This CLI is used for day-to-day tasks used at ungleich.
It is intended to be used by ungleich engineers and skilled customers.
2019-04-27 00:56:57 -04:00
2019-05-12 12:31:51 +02:00
## Requirements / Installation
2019-06-07 16:37:42 +05:00
* ensure you have **python3** and **pipenv**
2019-05-12 12:31:51 +02:00
* git clone this repo
2019-06-06 15:37:39 +05:00
* cd into this repo
* run the following command
```
2019-06-07 16:37:42 +05:00
pipenv install
pipenv shell
2019-06-06 15:37:39 +05:00
```
2019-05-12 12:42:28 +02:00
## Usage general
2019-04-27 00:56:57 -04:00
```
2019-05-12 12:42:28 +02:00
ungleich --help
```
2019-06-06 15:37:39 +05:00
## Usage: Weather
```
ungleich weather
```
2019-04-27 00:56:57 -04:00
2019-05-12 12:42:28 +02:00
## Usage: DNS
```
2019-05-15 18:49:22 -04:00
ungleich dns --set-reverse <ip> --user <username> --token <token> --realm <realm> --email <email> --name mirror.example.com
2019-05-12 11:25:50 +02:00
```
### Usage: RIPE
Creating a new route6 object:
```
2019-05-12 12:42:28 +02:00
ungleich ripe-add-route6 \
2019-05-12 11:25:50 +02:00
--network 2a09:2947::/32
--description "First REST /32"
--password "very secure"
```
2019-05-30 05:26:12 -04:00
### Usage: Account
Creating a new account object:
```
ungleich account --create-user <username> --name <firstname> --lastname <lastname> --email <email>
```
2019-06-08 19:18:37 +02:00
### Usage: SSH Key
2019-06-08 19:29:03 +02:00
Requires you to have
https://code.ungleich.ch/ungleich-public/ungleich-ssh-keys/ checked
out in ~/vcs/ungleich-ssh-keys
2019-06-08 19:18:37 +02:00
```
ungleich sshkey --key raul.ascencio --host dev.raul.ungleich.cloud
```