Skip to content

Methods & Modules

Methods

Methods are the functions exposed by Modules.

They are the primary API for interacting with KireiSakura-Kit.

Modules

Modules are shell scripts that store methods.
Each module performs a specific task and can be sourced as needed.

There are 3 types are modules : -

These are essential components of KireiSakura-Kit, providing foundational functionality.

  • Automatically loaded at startup.
  • Cannot be modified or removed.
  • Listed in loaded modules.

Extend the functionality of the framework.

  • These are optional & must be loaded manually.
  • Can be dependent on core modules.
  • Contained in packages. See packages.

Local modules allow users to write their own extensions within a project.

  • These work similarly to plugin modules but are project specific.
  • Core & plugin modules can be used to make these.
  • This makes main entry script clean, separating methods.

Create local modules by making a sub directory called modules within project root.

<PROJECT_ROOT>
|
|-modules/
    |
    |-module1.sh
    |-module2.sh