From 9257a3ea6b0cbc4c40c834e234deaafdc3d0cf9c Mon Sep 17 00:00:00 2001 From: Matthias Tafelmeier Date: Fri, 3 Apr 2026 21:03:25 +0200 Subject: [PATCH] docs: add target management to README --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c592bcd..1ca2397 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ A Rust-based CLI tool for controlling and managing the Godon optimizer breeders - **Breeder Management**: List, create, show, update, and delete breeder configurations - **Credential Management**: Store and manage SSH keys, API tokens, and other sensitive data -- **YAML-based Configuration**: Simple YAML files for breeders and credentials +- **Target Management**: Define and manage target hosts for optimization runs +- **YAML-based Configuration**: Simple YAML files for breeders, credentials, and targets - **RESTful API Integration**: Communicates with the Godon Control API - **Cross-platform Support**: Currently Linux x86_64, extensible to other platforms @@ -178,6 +179,45 @@ godon_cli credential show --id 550e8400-e29b-41d4-a716-446655440001 godon_cli credential delete --id 550e8400-e29b-41d4-a716-446655440001 ``` +### Target Management + +#### List Targets + +```bash +godon_cli target list +``` + +#### Create a Target + +Create a YAML configuration file `target.yaml`: + +```yaml +name: "production-web-01" +targetType: "ssh" +address: "192.168.1.100" +username: "deploy" +description: "Production web server" +allowsDowntime: false +``` + +Then create the target: + +```bash +godon_cli target create --file target.yaml +``` + +#### Show Target Details + +```bash +godon_cli target show --id 550e8400-e29b-41d4-a716-446655440022 +``` + +#### Delete a Target + +```bash +godon_cli target delete --id 550e8400-e29b-41d4-a716-446655440022 +``` + ## Configuration The CLI connects to the Godon API using these default settings: