Skip to content

guiferpa/aurora

Repository files navigation

aurora

Go Reference Last commit Go Report Card Pipeline workflow Coverage Status

🌌 Aurora's just for studying programming language concepts

⚠ Don't use it to develop something that'll go to production environment

Summary

Get started

Install CLI

go install -v github.com/guiferpa/aurora/cmd/aurora@HEAD

🎈 So far there's no an easier way to download aurora binary. Use Go to install, it's the better way for while.

Using REPL mode

aurora repl
>> ident a = 1_000;
>> a + 1;
= 1001

Execute from file

Create aurora source code file

ident result = 10 * 20;
print result + 1;

Execute file

aurora run ./<file>.ar

That's the output from evaluator

[0 0 0 0 0 0 0 201]

Writing some code

🎈 Unfortunately, this project there's are not contributors enough to make this doc better but be my guest to discovery how to write some code looking at examples folder.

Try it out

Playground

🚀 Feel free to try Aurora with playground built with WebAssembly + Go (Aurora source code)

Screenshot 2025-01-12 at 12 27 41 AM

Extra options

aurora help

Usage:
  aurora [command]

Available Commands:
  build       Build binary from source code
  completion  Generate the autocompletion script for the specified shell
  eval        Evaluate aurora binary file built by build command
  help        Help about any command
  repl        Enter in Read-Eval-Print Loop mode
  run         Run program directly from source code
  version     Show toolbox version

Flags:
  -h, --help   help for aurora

Use "aurora [command] --help" for more information about a command.

Debug flag

All commands it'll show deep dive in instructions and evaluating

$ aurora repl --debug $ aurora run --debug ...