Installer Configuration

The install field describes the steps to execute. Each step represents an action or group of actions. Steps can be of several types, such as brew, rsync, shell, and more.

Fields

These fields are shared by all installer types. Some fields may vary in behavior depending on the type.

name
- Type: String (required)
- Description: Identifier for the step. It does not have to be unique, but is usually used to check for the app's existence (can be overridden using bin_name).
type
- Type: String (required)
- Description: Type of the step. See supported types for a comprehensive list of supported values.
enabled
- Type: String or Boolean (optional)
- Description: Enable or disable the step. Disabled steps are not run. This can either be a static boolean (true or false), or a command that returns a success status code for true, or a failure for false.
tags
- Type String (optional)
- Description: Arbitrary tags to attach to an installer. These can later be used to filter this installer in or out when running sofmani. This should be a string containing space-separated tags.
platforms
- Type: Object (optional)
- Description: Platform-specific execution controls. See platforms subfields below.
- Subfields:
  - platforms.only
    - Type: Array of Strings
    - Description: Platforms where the step should execute (e.g., ['macos', 'linux']). Supercedes platforms.except.
  - platforms.except
    - Type: Array of Strings
    - Description: Platforms where the step should not execute; replaces platforms.only.
steps
- Type: Array of Installers
- Description: Sub-steps for group type. Allows nesting multiple steps together. Ignored for all other types.
opts
- Type: Object (optional)
- Description: Step-specific options and configurations. Content varies depending on the type. See supported types for a comprehensive list of supported values.
bin_name
- Type: String (optional)
- Description: Binary name for the installed software, used instead of name when checking for app's existence.
check_has_update
- Type: String (shell script)
- Description: Shell command to check whether an update is available for the installed software. This will override the default check provided by the corresponding type. The check must succeed (return exit code 0) if the app has an update, or fail (other status codes) if the app is up to date.
check_installed
- Type: String (shell script)
- Description: Shell command to check if the step has already been installed. If the check succeeds (exits with status 0), it means the app is already installed and can be skipped if not checking for updates.
pre_install
- Type: String (shell script)
- Description: Shell script to execute before the step is installed.
post_install
- Type: String (shell script)
- Description: Shell script to execute after the step is installed.
pre_update
- Type: String (shell script)
- Description: Shell script to execute before the step is updated (if applicable).
post_update
- Type: String (shell script)
- Description: Shell script to execute after the step is updated (if applicable).
env_shell
- Type: Object (optional)
- Description: Shell to use for command executions. See env_shell subfields below. Windows always uses cmd.
- Subfields:
  - env_shell.macos
    - Type: String (optional)
    - Description: Shell to use for macOS command executions. If not specified, the default shell will be used.
  - env_shell.linux
    - Type: String (optional)
    - Description: Shell to use for Linux command executions. If not specified, the default shell will be used.

Supported `type` of Installers

shell
- Description: Executes arbitrary shell commands.
- Options:
  - opts.command: The command to execute for installing.
  - opts.update_command: The command to execute for updating.
group
- Description: Executes a logical group of steps in sequence.
  - Allows nesting multiple steps together.
- Options:
  - steps: List of nested steps.
git
- Description: Clones a git repository to a local directory.
  - If name is a full git URL (https or SSH), the repository is cloned directly.
  - If it is a repository path, e.g. chenasraf/sofmani, GitHub is assumed.
- Options:
  - opts.destination: The local directory to clone the repository to.
  - opts.ref: The branch, tag, or commit to checkout after cloning.
github-release
- Description: Downloads a GitHub release asset. Optionally untar/unzip the downloaded file.
- Options:
  - opts.repository: The repository to download from. Should be in the format: user/repository-name
  - opts.destination: The target directory to extract the files to.
  - opts.strategy: The download strategy. Can be one of: tar, zip, none (default)
    - none - the release file is not compressed, and should be copied directly
    - tar - the release file is a tar file, and should be extracted
    - zip - the release file is a zip file, and should be extracted
  - opts.download_filename: The filename of the release asset to download.
    
    This should either be a string, or a map of platforms to filenames.
    
    You can use {tag} and {version} to replace the relevant tokens in the filename:
    - {tag} - will be replaced by the full tag name, e.g. v1.0.0
    - {version} - will be replaced by the version, e.g. 1.0.0
    Examples:
```
download_filename: myapp_{tag}_linux.tar.gz # will output: myapp_v1.0.0_linux.tar.gz
download_filename: myapp_{version}_linux.tar.gz # will output: myapp_1.0.0_linux.tar.gz
download_filename:
  macos: myapp_{tag}_macos.tar.gz
  linux: myapp_{tag}_linux.tar.gz
  windows: myapp_{tag}_windows.zip
```
manifest
- Description: Installs an entire manifest from a local or remote file.
  - Every entry in the install array will be run, similar to how steps are run for group installers.
  - debug and check_updates will be inherited by the loaded config.
  - env and defaults will be merged into the loaded config, overriding any existing values.
- Options:
  - opts.source: The local file, or remote git URL (https or SSH) containing the manifest.
  - opts.path: The path to the manifest file within the repository. If opts.source is a local file, opts.path will be appended to it.
  - opts.ref: The branch, tag, or commit to checkout after cloning if opts.source is a git URL. For local manifests, this value will be ignored.
rsync
- Description: Copy files from source to destination using rsync.
- Options:
  - opts.source: Source directory/file.
  - opts.destination: Destination directory/file.
  - opts.flags: Additional rsync flags (e.g., --delete, --exclude).
brew
- Description: Installs packages using Homebrew.
- Options:
  - opts.tap: Name of the tap to install the package from.
npm/pnpm/yarn
- Description: Installs packages using npm/pnpm/yarn.
  - Use type: npm for npm install, type: pnpm for pnpm install, and type: yarn for yarn install.
apt/apk
- Description: Installs packages using apt install or apt add.
  - Use type: apt for apt install, and type: apk for apk add.
pipx
- Description: Installs packages using pipx.
docker
- Description: Pulls and runs Docker containers using docker run. Also supports update checks by comparing image digests.
  - The image is pulled from the registry (e.g., Docker Hub or GHCR) and started with the provided options.
  - If the container already exists, it will be started instead of run again.
  - Updates are detected by comparing the image digest before and after a pull.
  - The container is always run with --restart always -d, unless overridden in a custom shell.
- Required:
  - name: The full Docker image name, including tag (e.g., ghcr.io/open-webui/open-webui:main).
  - bin_name: The container name to assign to the running instance (used in install and update checks).
- Options:
  - opts.flags: A string of flags to pass to docker run (e.g., ports, volumes, extra args). These are appended after the default flags and before the image name.
    - Example:
      opts: flags: > -p 3300:8080 -v data-volume:/app/data --add-host=host.docker.internal:host-gateway
  - opts.platform: Override the platform used when checking the image manifest for updates. Accepts a per-OS map with values in os/arch format (e.g., linux/amd64).
    
    This is useful if you're running on a platform like darwin/arm64, but want to compare digests for a different image target (e.g., linux/amd64).
    - Example:
      opts: platform: macos: linux/amd64 linux: linux/amd64

Installer Examples

All of these examples should be usable, but don't count on them being maintained. Why not look at the Recipes?

group

install:
  - name: pyenv
    type: group
    tags: python
    steps:
      - name: pyenv
        type: brew
        platforms:
          only: ['macos']
      - name: pyenv
        type: shell
        platforms:
          only: ['linux']
        opts:
          command: 'curl https://pyenv.run | bash'

manifest

install:
  - name: lazygit
    type: manifest
    opts:
      source: git@github.com:chenasraf/sofmani.git
      path: docs/recipes/lazygit.yml

git

install:
  - name: github/gitignore
    type: git
    opts:
      destination: ~/.gitignore-templates

github-release

install:
  - name: lazygit
    type: github-release
    opts:
      repository: jesseduffield/lazygit
      strategy: tar
      destination: /usr/local/bin
      download_filename: lazygit_{tag}_Linux_x86_64.tar.gz

shell

install:
  - name: fnm
    type: shell
    tags: node
    post_install: |
      fnm install --lts
      fnm use lts-latest
    opts:
      command: curl -fsSL https://fnm.vercel.app/install | bash

rsync

install:
  - name: xdg-config
    type: rsync
    tags: config
    opts:
      source: ~/.dotfiles/.config
      destination: ~/.config

brew

install:
  - name: sofmani
    type: brew
    opts:
      tap: chenasraf/tap

npm/pnpm/yarn

install:
  - name: prettier
    type: pnpm
    tags: node

apt

install:
  - name: pipx
    type: apt
    tags: python
    platforms:
      only: ['linux']

docker

- name: ghcr.io/open-webui/open-webui:main
  bin_name: open-webui
  type: docker
  opts:
    flags: >
      -p 3300:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data

11 KiB Raw Permalink Blame History