Zekken Documentation

Getting Started

You can download the latest version of Zekken from the Download page, or build from source below.

Prerequisites#

• Rust toolchain installed (rustc, cargo)
• Git installed

1. Get Source#

git clone https://github.com/OzRAGEHarm/Zekken.git
cd Zekken

2. Build CLI#

./scripts/build-cli.sh
# or selectable script:
./scripts/build.sh cli

.\scripts\build-cli.bat
# or selectable script:
.\scripts\build.bat cli

3. Run Script#

./target/release/zekken run main.zk
# or:
cargo run --release run main.zk

CLI Command Reference#

The current CLI subcommands are:

• zekken run <file> - Run a script.
• zekken repl - Interactive REPL session.
• zekken help - View help for all commands or a specific subcommand.
• zekken debug <ast/tokens> <file> - Dumps either the Abstract Syntax Tree (AST) or token stream from the lexer for a given file.