casraf/sofmani
1
0
Fork 0
mirror of https://github.com/chenasraf/sofmani.git synced 2026-05-17 17:28:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README.md with machines docs

Browse Source
This commit is contained in:
Chen Asraf
2026-01-22 20:00:32 +02:00
parent ccdb1a726a
commit 88c3e2be39
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -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. |