Docs / Installation

Installation & running Falx

Falx has no packaging yet - you run it straight from a clone of the repository with Python. There is nothing to install beyond Python itself.

Clone the repository

$ git clone https://github.com/SharkBlocks00/Falx.git
$ cd Falx

Run a script

Falx is invoked as a Python module, not a standalone binary. Write a script with a .flx extension, then run it with the run subcommand:

$ python -m src.Main run path/to/script.flx

See the CLI & REPL page for every subcommand, including the interactive REPL and the test runner.

Check the version

$ python -m src.Main --version
Falx v0.3.0

Editor support

There is no official syntax highlighting or language server yet (it's listed under "under consideration" on the roadmap). Falx's syntax is close enough to C/JavaScript that a generic C-like highlighter will do a reasonable job on .flx files in the meantime.

Next

Head to the first tutorial to write and run your first script, or jump straight into the Language Guide.