Skip to content

neotesk/truct

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tructlogo

Truct1 is a pretty minimal workflow runner, allowing you to store your tasks inside one single Truct file (generally stored as truct.yaml) which is a YAML2 file, this way it will be readable for humans! Compared to other systems like Make3, Truct aims to be simple and beginner-friendly for small projects.

Installation (Manual)

You can install Truct manually through the Releases section. Currently there are builds only for *Nix operating systems (Linux4, OpenBSD5, macOS6 etc) and Windows7.

Installation (Automatic for Linux/Unix systems)

bash <(curl -sSL https://raw.githubusercontent.com/neotesk/truct/main/docs/install.sh)

Installation (Automatic for Termux)

bash <(curl -sSL https://raw.githubusercontent.com/neotesk/truct/main/docs/termux-install.sh)

Usage

You can start with the help command like so:

truct help

After writing your workflow file, you can run workflows with this command:

truct do

Why does this exist?

This exists because I like making small projects that will make my job easier and I don't want to adapt to many many other systems on the current market, so I like to combine my favorite parts of these systems into one single unit, thus many of my projects have born into existence. Truct is one of them since I only needed a simple workflow runner that does basic work and nothing else. For more information, please visit the Truct wiki

Footnotes

  1. Truct comes from "construct" in English.

  2. YAML is a human-readable markup language, stands for "Yet Another Markup Language"

  3. Make is a command-line interface software tool that performs actions ordered by configured dependencies as defined in a configuration file called a makefile

  4. Linux is an Unix-like Operating system.

  5. OpenBSD is a security-focused, free software, Unix-like operating system based on the Berkeley Software Distribution (BSD).

  6. macOS is a popular computer operating system used in Apple's Mac and Macbook computers.

  7. Windows is a popular computer operating system used world-wide.