buzz

<p align="center">
    <img src="https://github.com/buzz-language/buzz/raw/main/logo.png" alt="buzz" width="204" height="204">
</p>

# 👨‍🚀 buzz

A small/lightweight statically typed scripting language written in Zig

<p align="center">
    <img src="https://github.com/buzz-language/buzz/raw/main/example.png" alt="buzz code example">
</p>

<p align="center">
    <a href="https://buzz-lang.dev">Homepage</a> — <a href="https://discord.gg/VnMdNSdpNV">Discord</a>
</p>

> [!WARNING]
> buzz is in alpha and is **not** ready for any professional or production use

## Features

- Small in size and complexity
- Statically typed
- Unambiguous
- No nonsense coercion
- [Fibers](#fibers)
- JIT compilation with [MIR](https://github.com/vnmakarov/mir)
- Tooling
    - [VS Code extension](https://marketplace.visualstudio.com/items?itemName=giann.buzz)
    - Helix support thanks to [tree-sitter grammar](https://github.com/buzz-language/tree-sitter-buzz)
    - LSP
    - DAP
    - Formatter
    - Package manager

## How to build and install

### Requirements
- Zig 0.17.0
- Since this is built with Zig, you should be able to build buzz on a wide variety of architectures even though this has only been tested on x86/M1.
- Supports linux, macOS or windows
- libc

### Build
1. Clone the project: `git clone https://github.com/buzz-language/buzz <buzz_dir>`
2. Checkout submodules: `git submodule update --init`
3. Build it `zig build -Doptimize=safe`
4. Have fun (with `BUZZ_PATH=./zig-out`)
    - `buzz` launches the REPL
    - `buzz <script.buzz>` to run a lone script
    - `buzz <directory>` to run a buzz package
    - `buzz init` to start a buzz package
 
### Install

```bash
# install locally at ~/.local
zig build -Doptimize=ReleaseSafe install -p ~/.local

# install globally at /usr/local
sudo zig build -Doptimize=ReleaseSafe install -p /usr/local
```

If you're usage if performance critical (game dev for example), you can build using `-Doptimize=fast`.

Remember to modify PATH to include the `bin` directory where it is installed. For example, `export PATH=PATH:/home/xxx/.local/bin`. You can then run buzz with `buzz <myscript.buzz>` or `buzz <directory>`. Or you can simply run `buzz` to start the REPL.

# AI policy

The fact that this repo as a AGENTS.md file is not an invitation to submit AI generated code. I make a important distinction between, "AI assisted coding" where AI is used as a helper to better understand, debug and improve your code vs "AI generated code" where the understanding of the author ends at the prompt.
**Blatant slope PRs will be rejected**.