Skip to content

Configuration Options

This page details all available configuration options for KireiSakura-Kit.

Configuration follows YAML format.

# example config.toml

Project:
  name: "KireiSakura-Kit"
  author: soymadip

Option:
    debug_mode: false

Below are options, grouped by section : -

Project

name

Specifies the name of your project.

  • Type: string
  • Optional: ❌
  • Default: KireiSakura-Kit

owner

Name of the maintainer of current project.

  • Type: string
  • Optional: ❌
  • Default: Null

module_dir

Path of the directory that holds local modules, relative to the project root.

  • Type: string/path
  • Optional: ✅
  • Default: modules/

config_file

Name or path of the project config file.

Name if config file is in the project root.
Path, relative to project root if it's not in root.

  • Type: String or path
  • Optional: ✅
  • Default: config.toml
Example

Let's suppese project name is Dotfile Heaven.

  1. Config file is in project root but only name is changed:-

    Project:
    name: "Dotfile Heaven"
    config_file: "kirei.roml"

  2. Config file is in config subdirectory & is named kirei.toml. so:-

    Project:
    name: "Dotfile Heaven"
    config_file: "config/kirei.toml"

repo_url

Url of the current project's Repository/Website.

  • Type: String/url
  • Optional: ✅
  • Default: Null


Custom

kit_dir

Directory to use instead of default kit installation.

  • Type: string/path
  • Optional: ✅
  • Default:$XDG_DATA_HOME/<project_name>

cache_dir

Defines the directory path where temporary files will be stored.

  • Type: string/path
  • Optional: ✅
  • Default:
    • Primary: $XDG_CONFIG_HOME/<project name> (If $XDG_CONFIG_HOME is set)
    • Fallback: ~/.config/<project name>

log_file_name

Specifies the name of the log file.

  • Type: string
  • Optional: ✅
  • Default: <project_name>.log

installer_url

Direct URL to the installer script. This is used for installing/updating kit.

  • Type: string/url
  • Optional: ✅
  • Default: https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/refs/heads/install/install.sh

package_dir

Directory to use to hold installed packages.

  • Type: string/path
  • Optional: ✅
  • Default: $kirei_dir/packages


Kit

docs_url

Url of the Kit's documentation website.

  • Type: string/url
  • Optional: ✅
  • Default: https://soymadip.github.io/KireiSakura-Kit

installer_url

Direct link to kit's installer script.

  • Type: string/url
  • Optional: ✅
  • Default: https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/refs/heads/install/install.sh

upstream_ver_url

Direct download link of the file that holds the version number.

  • Type: string/url
  • Optional: ✅
  • Default: https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/main/.version


Options

auto_update

Should the Kit update everytime it's run?

  • Type: bool
  • Optional: ✅
  • Default: true

debug_mode

Enable Debug mode.

In this mode, extra messages are printed (helpful for debugging).

  • Type: bool
  • Optional: ✅
  • Default: false

quiet_mode

Enable quiet mode.

In this mode, most of the logs are supressed & delays are removed.

  • Type: bool
  • Optional: ✅
  • Default: flase

failsafe_mode

Enable failsafe mode.

Exit (stop execution of) script in case of error.

  • Type: bool
  • Optional: ✅
  • Default: false