Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 2.31 KB

README.md

File metadata and controls

75 lines (52 loc) · 2.31 KB
Raw

KireiSakura-Kit

KireiSakura-Kit is a library written in Bash for making powerful shell scripts.


"KireiSakura-Kit" is combination of two Japanese words, "Kirei" and "Sakura," along with the suffix "Kit".
Kirei(綺麗) means "clean" & Sakura(桜) refers to cherry blossoms. Together, "KireiSakura-Kit" could be interpreted as a library that emphasizes a beautiful and clean design inspired by the elegance of cherry blossoms.

Features

  • Written in purely bash, can be used in POSIX* shell script.
  • Mudular, import only stuff you need.
  • Log support, with various levels.
  • Many in-built functions, no need to write from scratch.
  • See TODO for planned stuff.

Installation & setup

  • Make sure you have curl, grep installed.

  • Follow below steps to Install Kireisakura-Kit

For system wide

  • In terminal run:-

    curl -L https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/refs/heads/install/install.sh | bash -s

  • Then in your script, include this line at the top:-

    eval "$(kireisakura --init)"

For directly using in script

  • This will check if Kit is installed or download & setup KireiSakura-Kit.
  if command -v kireisakura &> /dev/null; then
    eval "$(kireisakura --init)"
  else
    echo "> Installing KireiSakura-Kit"
    curl -sSL https://raw.githubusercontent.com/soymadip/KireiSakura-Kit/refs/heads/install/install.sh -o kirestaller.sh
    bash kirestaller.sh -ds
  fi

Methods & Docs

  • Docs To be done.
  • Run kireisakura -h for help.
  • See my dotfiles for example.

Warning

  • MAJOR CHANGES ARE BEING MADE as this project is in alpha, so be careful.
  • As of now, some part of this library is Arch-linux centric, but can be extended to any distro.
  • Contribute if you find this useful and wanna make this more powerful.