Lustre Dev Tools

Lustre's official CLI and development tooling.

Available on Hex

Lustre | TOML reference | Discord

Built with ❤︎ by Hayleigh Thompson

Features

Philosophy

Lustre’s dev tools are designed to make the experience as simple as possible for folks unfamiliar with frontend development or are exhausted at the state of JavaScript tooling. That means being opinionated about the tools we support and the commands we provide.

If you find yourself needing more configuration or control over your build process, you might be outgrowing what Lustre’s dev tools have set out to provide! We’d love to hear from those users too, though, so please open an issue or reach out on Discord if you think something is missing.

For more advanced users, we recommend using vite and the vite-gleam package.

Installation

Lustre’s dev tools are published on Hex! You can add them as a dev dependency to your Gleam projects from the command line:

gleam add lustre_dev_tools --dev

The --dev flag is important to make sure the dev tools are not included in your application’s build!

To run any of the commands provided by the dev tools, you should run the lustre/dev module using Gleam’s run command:

gleam run -m lustre/dev start

Static assets

Lustre’s dev tools uses a top-level assets directory as a place to store static assets like images, fonts, or other scripts and stylesheets that should not be part of the build process. You can read more about how to use the assets directory in the assets documentation.

External binaries

Lustre’s dev tools are a wrapper around existing binary build tools. Specifically, we use bun for bundling and file watching and we also support Tailwind through their standalone CLI.

Lustre will automatically detect your platform and download the appropriate binaries when you first run a command. These binaries are cached per-project in the project’s .lustre directory. If you prefer, Lustre can be told to use a local path or check your system’s $PATH for the binaries instead. See the TOML reference for an overview on how to define those options.

Support

Lustre is mostly built by just me, Hayleigh, around two jobs. If you’d like to support my work, you can sponsor me on GitHub.

Contributions are also very welcome! If you’ve spotted a bug, or would like to suggest a feature, please open an issue or a pull request.

Search Document