Provider Binaries

The binaries section lists helper binaries Devsy downloads for a provider, such as a cloud CLI.

Each entry is a name with one item per platform:

binaries:
  MY_BINARY:
    - os: linux
      arch: amd64
      path: https://example.com/my-binary-linux-amd64  # URL or local path
      checksum: <sha256 of the file>
      name: my-binary             # optional, defaults to the file name
    - os: darwin
      arch: arm64
      path: https://example.com/my-binary-darwin-arm64
      checksum: <sha256 of the file>

Supported archives are .tgz, .tar, .tar.gz and .zip. When a user adds the provider, Devsy picks the item that matches their OS and architecture, downloads it and, if checksum is set, verifies it.

See the official providers, such as devsy-provider-aws, for complete examples.

ArchivesCopy Anchor Link

Archive extraction applies only when path is an http:// or https:// URL. Devsy picks the extraction format from the path extension, not from archivePath. Devsy requires archivePath when path is an archive. Setting archivePath on a direct binary URL makes Devsy try to extract the binary and fails with unrecognized archive format.

binaries:
  MY_BINARY:
    - os: linux
      arch: amd64
      path: https://example.com/my-binary-linux-amd64.tar.gz
      archivePath: bin/my-binary  # executable inside the archive
      checksum: <sha256 of bin/my-binary after extraction>

Devsy extracts the whole archive into a folder for the binary and keeps its layout, then uses the file at archivePath. For HTTP(S) archives, name is ignored.

ChecksumCopy Anchor Link

checksum is optional, except for the agent.binaries entry selected by agent.external.binary, which needs one for every platform. See External Driver.

When set, Devsy computes the SHA256 of the file it will run and compares it case-insensitively. For an HTTP(S) archive that file is the extracted file at archivePath; the archive itself is never hashed. A mismatch deletes the file and fails the download without retrying.

Use a binaryCopy Anchor Link

Devsy exposes each binary's path as an environment variable with the same name.

In exec:

exec:
  init: ${MY_BINARY} init

In an option command:

options:
  MY_OPTION:
    command: ${MY_BINARY} retrieve-option

On the agent side, declare the binary under agent.binaries and use it in agent.exec:

agent:
  binaries:
    MY_BINARY:
      - os: linux
        arch: amd64
        path: https://example.com/my-binary-linux-amd64
        checksum: <sha256 of the file>
  exec:
    shutdown: ${MY_BINARY} stop