mreg-cli 1.4.2__tar.gz → 1.5.0__tar.gz

{mreg_cli-1.4.2 → mreg_cli-1.5.0}/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ## Unreleased -->
 
+## [1.5.0](https://github.com/unioslo/mreg-cli/releases/tag/1.5.0) - 2025-09-01
+
+### Added
+
+- `help health` command for checking the health of the server. The command will display "Unknown" for fields that are not implemented on the server.
+- Caching of API responses. Enabled by default. Configurable:
+  - Enable/disable caching (default: `true`)
+    - Config file: `cache=true|false`
+    - CLI: `--no-cache` (flag)
+  - Cache time-to-live (TTL) in seconds (default: `300`)
+    - Config file: `cache_ttl=<seconds>`
+    - CLI: `--cache-ttl <seconds>`
+
 ## [1.4.2](https://github.com/unioslo/mreg-cli/releases/tag/1.4.2) - 2025-08-15
 
 ### Fixed

{mreg_cli-1.4.2 → mreg_cli-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mreg-cli
-Version: 1.4.2
+Version: 1.5.0
 Summary: MREG interactive command line client
 Author: Others (see AUTHORS)
 Author-email: Øyvind Kolbu <oyvind.kolbu@usit.uio.no>, Safet A <amedov@usit.uio.no>, Magnus Hirth <mhmorgan42@gmail.com>, Nico <nicolaydmohebi@gmail.com>, Marius Bakke <marius.bakke@usit.uio.no>, Fredrik Larsen <fredrik.larsen@usit.uio.no>, Paal Braathen <paal.braathen@usit.uio.no>, Nils Hiorth <nils@nls.me>, Dmytro Karpenko <dmytrok@usit.uio.no>
@@ -701,6 +701,7 @@ Requires-Dist: typing_extensions>=4.12.0
 Requires-Dist: pydantic[email]>=2.7.1
 Requires-Dist: pydantic-extra-types>=2.1.0
 Requires-Dist: platformdirs>=4.3.0
+Requires-Dist: diskcache>=5.6.3
 Dynamic: license-file
 
 # MREG CLI [![Build Status](https://github.com/unioslo/mreg-cli/actions/workflows/test.yml/badge.svg)](https://github.com/unioslo/mreg-cli/actions/workflows/test.yml)
@@ -739,8 +740,55 @@ url=https://mreg.example.com:8000
 user=mreg-user
 ```
 
+An example config file can be found in [data/mreg-cli.conf](data/mreg-cli.conf).
+
 <details>
-<summary>Other options</summary>
+<summary>Config options</summary>
+
+### URL
+
+The URL of the MREG server. This is the only required option.
+
+```ini
+[mreg]
+url=https://mreg.example.com:8000
+```
+
+The URL can also be specified as a command line argument:
+
+```bash
+mreg-cli --url "https://mreg.example.com:8000"
+```
+
+### User
+
+The username to use when connecting to the MREG server. This is optional, and if not specified, the CLI will try to use the current user's username.
+
+```ini
+[mreg]
+user=mreg-user
+```
+
+The user can also be specified as a command line argument:
+
+```bash
+mreg-cli --user "mreg-user"
+```
+
+### Domain
+
+Default domain to use for hostnames. This is optional, and if not specified, the CLI will use `uio.no` as the default domain.
+
+```ini
+[mreg]
+domain=uio.no
+```
+
+The domain can also be specified as a command line argument:
+
+```bash
+mreg-cli --domain "uio.no"
+```
 
 ### Prompt
 
@@ -756,7 +804,7 @@ By default the prompt is set to `{user}@{host}`, which is equivalent to the foll
 
 ```ini
 [mreg]
-PROMPT={user}@{host}
+prompt={user}@{host}
 ```
 
 Which results in a prompt like this:
@@ -779,7 +827,7 @@ The prompt text can be disabled by setting it to no value in the config file or
 
 ```ini
 [mreg]
-PROMPT=
+prompt=
 ```
 
 ```bash
@@ -792,6 +840,66 @@ Which results in the following prompt:
 >
 ```
 
+### Log file
+
+The location of the log file. The default location is `$XDG_DATA_DIRS/mreg-cli/mreg-cli.log`, which is typically `~/.local/share/mreg-cli/mreg-cli.log`.
+
+```ini
+[mreg]
+logfile=/var/log/mreg-cli.log
+```
+
+The log file can also be specified as a command line argument:
+
+```bash
+mreg-cli --logfile "/var/log/mreg-cli.log"
+```
+
+### Timeout
+
+The timeout for HTTP requests to the MREG server. The default is 20 seconds.
+
+```ini
+[mreg]
+timeout=20
+```
+
+### Cache
+
+Enable/disable caching of API results. Cache is always cleared on every write request (POST, PUT, PATCH, DELETE).
+
+```ini
+[mreg]
+cache=true
+```
+
+### Cache TTL
+
+Time-to-live for cached API results, in seconds. Defaults to 300 seconds (5 minutes).
+
+```ini
+[mreg]
+cache_ttl=300
+```
+
+### Category tags
+
+List of valid category tags for networks. Used by `network create`.
+
+```ini
+[mreg]
+category_tags=default,production,development,test
+```
+
+### Location tags
+
+List of valid location tags for networks. Used by `network create`.
+
+```ini
+[mreg]
+location_tags=default,oslo,bergen,stavanger
+```
+
 </details>
 
 ## General usage

{mreg_cli-1.4.2 → mreg_cli-1.5.0}/README.md

@@ -34,8 +34,55 @@ url=https://mreg.example.com:8000
 user=mreg-user
 ```
 
+An example config file can be found in [data/mreg-cli.conf](data/mreg-cli.conf).
+
 <details>
-<summary>Other options</summary>
+<summary>Config options</summary>
+
+### URL
+
+The URL of the MREG server. This is the only required option.
+
+```ini
+[mreg]
+url=https://mreg.example.com:8000
+```
+
+The URL can also be specified as a command line argument:
+
+```bash
+mreg-cli --url "https://mreg.example.com:8000"
+```
+
+### User
+
+The username to use when connecting to the MREG server. This is optional, and if not specified, the CLI will try to use the current user's username.
+
+```ini
+[mreg]
+user=mreg-user
+```
+
+The user can also be specified as a command line argument:
+
+```bash
+mreg-cli --user "mreg-user"
+```
+
+### Domain
+
+Default domain to use for hostnames. This is optional, and if not specified, the CLI will use `uio.no` as the default domain.
+
+```ini
+[mreg]
+domain=uio.no
+```
+
+The domain can also be specified as a command line argument:
+
+```bash
+mreg-cli --domain "uio.no"
+```
 
 ### Prompt
 
@@ -51,7 +98,7 @@ By default the prompt is set to `{user}@{host}`, which is equivalent to the foll
 
 ```ini
 [mreg]
-PROMPT={user}@{host}
+prompt={user}@{host}
 ```
 
 Which results in a prompt like this:
@@ -74,7 +121,7 @@ The prompt text can be disabled by setting it to no value in the config file or
 
 ```ini
 [mreg]
-PROMPT=
+prompt=
 ```
 
 ```bash
@@ -87,6 +134,66 @@ Which results in the following prompt:
 >
 ```
 
+### Log file
+
+The location of the log file. The default location is `$XDG_DATA_DIRS/mreg-cli/mreg-cli.log`, which is typically `~/.local/share/mreg-cli/mreg-cli.log`.
+
+```ini
+[mreg]
+logfile=/var/log/mreg-cli.log
+```
+
+The log file can also be specified as a command line argument:
+
+```bash
+mreg-cli --logfile "/var/log/mreg-cli.log"
+```
+
+### Timeout
+
+The timeout for HTTP requests to the MREG server. The default is 20 seconds.
+
+```ini
+[mreg]
+timeout=20
+```
+
+### Cache
+
+Enable/disable caching of API results. Cache is always cleared on every write request (POST, PUT, PATCH, DELETE).
+
+```ini
+[mreg]
+cache=true
+```
+
+### Cache TTL
+
+Time-to-live for cached API results, in seconds. Defaults to 300 seconds (5 minutes).
+
+```ini
+[mreg]
+cache_ttl=300
+```
+
+### Category tags
+
+List of valid category tags for networks. Used by `network create`.
+
+```ini
+[mreg]
+category_tags=default,production,development,test
+```
+
+### Location tags
+
+List of valid location tags for networks. Used by `network create`.
+
+```ini
+[mreg]
+location_tags=default,oslo,bergen,stavanger
+```
+
 </details>
 
 ## General usage