From 88c3e2be3903c00e1ea54f6cd65fe8ba790bde83 Mon Sep 17 00:00:00 2001 From: Chen Asraf Date: Thu, 22 Jan 2026 20:00:32 +0200 Subject: [PATCH] docs: update README.md with `machines` docs --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 84ca0fc..9b01726 100644 --- a/README.md +++ b/README.md @@ -169,6 +169,9 @@ actions. Steps can be of **several types**, such as `brew`, `rsync`, `shell`, an | `platforms` | Object (optional) | Platform-specific execution controls. See `platforms` subfields below. | | `platforms.only` | Array of Strings | Platforms where the step should execute (e.g., `['macos', 'linux']`). Supercedes `platforms.except`. | | `platforms.except` | Array of Strings | Platforms where the step should **not** execute; replaces `platforms.only`. | +| `machines` | Object (optional) | Machine-specific execution controls. Use `sofmani --machine-id` to get your machine ID. You can use raw IDs or aliases defined in `machine_aliases`. | +| `machines.only` | Array of Strings | Machine IDs or aliases where the step should execute. Supercedes `machines.except`. | +| `machines.except` | Array of Strings | Machine IDs or aliases where the step should **not** execute. | | `steps` | Array of Installers | Sub-steps for `group` type. Allows nesting multiple steps together. | | `opts` | Object (optional) | Step-specific options and configurations. Content varies depending on the `type`. See [supported types](#supported-type-of-installers) for a comprehensive list of supported values. | | `bin_name` | String (optional) | Binary name for the installed software, used instead of `name` when checking for app's existence. |