Skip to main content

README.md

# Gleem

[![Package Version](https://img.shields.io/hexpm/v/gleem)](https://hex.pm/packages/gleem)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://gleem.hexdocs.pm)
[![](https://img.shields.io/badge/github-repo-blue?logo=github)](https://https://github.com/Thebugcanfly13/gleem)

Gleem is a DSL for the gleam programming language written in gleam.

Currently, it is not ready for use as it is still in heavy testing and development.

## Install
```gleam
import gleem/list

pub fn main() -> {
  install.main()
}
```
```sh
gleam run
```

## Use
```sh
gleem new cool_project
```

```gleam
import gleem/Tasks

pub fn main() -> Nil {
  tasks.define(List(tasks.Task("cool_task", "cool")))
  // The first argument on tasks.Task is the name, and the second is the file name without the ending `.gleam`.
  tasks.run()
```
```sh
cd project_directory
gleem run
```

Any further documentation can be found [here](https://gleem.hexdocs.io)

(c) 2026 Thebugcanfly13