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
Files
master
sofmani/docs/getting-started.md
Chen Asraf 0346ec0899 docs: add TOCs
2026-03-24 17:04:50 +02:00

1.5 KiB
Executable File
Raw Permalink Blame History

Getting Started

Table of Contents

Installation

Download Precompiled Binaries

Precompiled binaries for sofmani are available for Linux, macOS, and Windows:

  • Visit the Releases Page to download the latest version for your platform.

Homebrew (macOS/Linux only)

Install from a custom tap:

brew install chenasraf/tap/sofmani

Linux

You can install sofmani by downloading the release tar, and extracting it to your preferred location.

  • You can see an example script for install here: install.sh

  • The example script can be used for actual install, use this command to download and execute the file (use at your own discretion):

    curl https://raw.githubusercontent.com/chenasraf/sofmani/master/install.sh | sh

Config file location

The config file can be in YAML or JSON format.

You can place the config file anywhere, and provide the path to sofmani CLI to load. If you don't give it an explicit path, the CLI will attempt to find a sofmani.yml or sofmani.json file ine the following directories (ordered by priority):

  1. Current working directory
  2. $HOME/.config directory
  3. Home directory