Home

Welcome to Truct Wiki!
In this page we'll talk about how you can setup Truct for your own use.

Installation

First, download the correct binary for your system. Since the binaries in the releases are named in truct.OS-ARCH format it will be easy. Second, rename it to "truct" or "truct.exe" if you are using Windows. Third, move it to /usr/bin/ or C:\Windows\System32 if you are using Windows. Now you can use Truct through your terminal.

Setup

After installing Truct to your system, cd into the project you want to truct-ify and run the truct init command. Fill the blanks and you will have a truct.yaml file residing in your project directory. If you don't like the filename, you can change it by supplying --filename myFile.yaml argument into every truct command you use.

Structure

Here's an example structure of truct.yaml:

project:
    name: Lorem
    description: Ipsum dolor sit amet
    version: 1.0.0

.setup:
    description: Performs a setup operation
    actions:
        -
            action: shell
            cmdlines:
                - echo setup is done.

.build:
    description: Performs a build operation
    actions:
        -
            action: shell
            cmdlines:
                - echo Build is done.