Packages

Development tool for capturing Gleam build information in Nix

Current section

Files

Jump to
zeiss README.md
Raw

README.md

# zeiss

[![Package Version](https://img.shields.io/hexpm/v/zeiss)](https://hex.pm/packages/zeiss)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://zeiss.hexdocs.pm/)

_"A gleam of light, focused through a lens, captured for ever."_

```
  .~_/z\_.,
  |-`(*).-|  `manifest.toml` ---> `zeiss.nix`
  '-------'
```

Development tooling for converting Gleams `manifest.toml` with all its dependencies into a `zeiss.nix` file which can be used as an `import` in a Nix derivation.

**Note however**:

> This tool does **not** provide a way to build a Gleam application.

In order to build a Gleam application with Nix, a derivation which understands the generated `zeiss.nix` file needs to be provided.

## Usage

Add `zeiss` as a development dependency to your project

```sh
gleam add --dev zeiss
```

Generate the `.nix` representation of your `manifest.toml`

```sh
gleam run -m zeiss
```