grml

command module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2023 License: GPL-3.0 Imports: 1 Imported by: 0

README

grml - A simple build automation tool written in Go

grml is a simple Makefile alternative. Build targets are defined in a grml.yaml file located in the project's root directory. This file uses the YAML syntax.

A minimal sample can be found within the sample directory. Enter the directory with a terminal and execute grml.

asciicast

Installation

From Source
go install github.com/desertbit/grml@latest
Prebuild Binaries

https://github.com/desertbit/grml/releases

Specification

  • Environment variables can be defined in the env section. These variables are passed to all run target processes.
  • Variables are also accessible with the ${} selector within help messages and import statements.
  • Dependencies can be specified within the command's deps section.
Additonal Environment Variables

The process environment is inherited and following additonal variables are set:

KEY VALUE
ROOT Path to the root build directory containing the grml.yaml file
PROJECT Project name as specified within the grml file
NUMCPU Number of CPU cores

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
app
cmd
sample module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL