Skip to content

docs: update README with --name and yaml config #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cherusk merged 1 commit into from
Jan 9, 2026
Merged

docs: update README with --name and yaml config #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,29 @@ godon_cli --hostname https://localhost:8443 --insecure breeder list

#### Create a Breeder

Create a YAML configuration file `breeder.yaml`:
Create a YAML configuration file `breeder_config.yaml` with native YAML syntax:

```yaml
name: "genetic-optimizer-1"
config: >
{"setting1": "value1", "setting2": 42, "optimization_target": "performance"}
meta:
configVersion: "0.2"
description: "Linux network performance optimization"

breeder:
type: "linux_performance"

settings:
sysctl:
net.ipv4.tcp_rmem:
step: 100
constraints:
lower: 4096
upper: 6291456
```

Then create the breeder:
Then create the breeder with a name:

```bash
godon_cli breeder create --file breeder.yaml
godon_cli breeder create --name "genetic-optimizer-1" --file breeder_config.yaml
```

#### Show Breeder Details
Expand All @@ -97,14 +108,16 @@ godon_cli breeder show --id 550e8400-e29b-41d4-a716-446655440000

#### Update a Breeder

Create an update configuration file `breeder_update.yaml`:
Create an update configuration file `breeder_update.yaml` with native YAML syntax:

```yaml
uuid: "550e8400-e29b-41d4-a716-446655440000"
name: "updated-genetic-optimizer"
description: "Updated optimizer configuration"
config: >
{"setting1": "new_value1", "setting2": 100}
config:
setting1: "new_value1"
setting2: 100
optimization_target: "throughput"
```

Then update:
Expand Down