Skip to content

Commit 291feec

Browse files
committed
Add optional field extractPath to plugin definition
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
1 parent 22fe880 commit 291feec

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

rfcs/xxxx-cli-plugin-system/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ The plugin manifest includes metadata (name, description, homepage, source repo)
124124
The download URLs can point to one of the following formats:
125125

126126
- An archive containing the binary (`tar`, `tar.gz` or `zip`), with the binary at the root of the archive. The binary name inside the archive must match the `bin` field in the manifest.
127+
- An optional `extractPath` field can be specified in a `platforms` entry. It accepts an absolute path to a file within the archive (e.g., `bin/flux-operator`), and can be used to override the top-level bin field either because the binary has a different name on this platform, or because it is nested in a subfolder rather than at the root of the archive. If `extractPath` is omitted, the CLI looks for a file named after the top-level `bin` field at the root of the archive.
127128
- A direct binary URL. The binary is downloaded and saved without extraction. The `bin` field is used for naming the installed plugin, not for discovery in this case.
128129
- Note that when the OS is Windows, the binary name is composed by appending `.exe` to the `bin` field (e.g., `flux-operator.exe`).
129130

0 commit comments

Comments
 (0)