Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Usage

Find help using the singularity-dotfiles-manager by running:

singularity-dotfiles-manager --help
.
├── 📂 apps/
│   ├── 📄 arch.json            # App suite for Arch and Arch-like distros
│   └── 📄 ...                  # App suites for other systems
├── 📂 dependencies/            # Package dependencies for the dotfiles repo separated by newline
│   ├── 📄 arch                 # Packages list for Arch and Arch-like distros
│   └── 📄 ...                  # Packages lists for other distros
├── 📂 dotfiles/                # The part of the repository that is symlinked to the home directory
│   ├── 📂 .config/
│   │   └── ...
│   └── ...
├── 📂 hooks/
│   ├── 📜 arch.rhai            # Hooks script for Arch and Arch-like distros
│   └── 📜 ...                  # Scripts for other distributions
├── 📄 dotfiles-rolling.json    # Release config for rolling release on main
├── 📄 dotfiles-stable.json     # Release config for stable release
└── 📄 install.sh               # Optional bootstrap script

Install Dotfiles

The core command of Singularity. It pulls a dotfiles repository based on a configuration file.

singularity-dotfiles-manager install https://example.com/release-config.json

The dotfiles release config is a detailed description of your dotfiles repository. Find the JSON schema here.

Extend the installation workflow with Rhai hook scripts as described in Hooks API.

App Suite

Let the user install from a suite of applications defined in your profile. The app suite is defined in JSON. Find the JSON schema here.

singularity-dotfiles-manager apps