Skip to content

seal-runtime/seal

Repository files navigation

seal, make shell scripts readable

seal mascot reading reference book
the cutest scripting runtime
seal version Luau version

Usage | Programming | API Reference

seal is a cross-platform scripting tool that emphasizes correctness, performance, and fun.

It can surreptitiously replace your shell and single-use Python scripts with Luau scripts, making them more readable to everyone. Or you can use it to write a full application.

Some features:

  • Faster than Python for general purpose scripting.
  • seal projects are more scalable than shell scripts.
  • Built in terminal manipulation for TUIs.
  • Powerful multithreading.
  • 1103 handcrafted error messages.

Install

Grab the latest release or check out these install instructions for a detailed walkthrough.

To get started, you just need:

  1. A text editor (VSCode, Zed, and nvim are supported by Luau Language Server).
  2. Luau Language Server installed in your editor.
  3. The seal executable in your $PATH

Usage

To start a new project with seal, make a new directory, run seal setup project inside it, and open it up with code .

  • seal ./filename.luau runs a Luau file with seal.
  • seal run runs the project at your current working directory.
  • seal compile bundles and compiles the project at your current working directory into a standalone executable for your platform.

Check out the full usage instructions for more.

Programming

Check out the programming intro to get started or the standard library reference for all current features and APIs. In supported editors, you can take advantage of modern tooling such as strict typechecking and autocomplete, inline documentation, automatic imports, etc.

Some quick examples:

Roadmap

  • More featureful @extra library.
  • Custom and customizable seal setup scripts.
  • Ecosystem of external libraries to expand seal's functionality with native bindings.
  • Cross-platform GUI and input automation libraries.
  • Dedicated tooling integrations such as extensions and an MCP server.

Community

Join the Discord if you want to talk about seal, need help, or want to contribute!

Reliability

seal wants to empower you to write correct code that doesn't explode at runtime. In most cases, runtime errors will be expressly documented, and/or returned as an error type to facilitate nonthrowing error handling with the typechecker.

If you encounter a bug, panic, or security vulnerability, please make an issue in this repo right away; you may attach a repro or send one privately to dev@deviaze.com or @deviaze on Discord.

About

A simple, user-friendly, and useful runtime for Luau

Topics

Resources

License

Contributing

Stars

46 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors