Docs

If you’re new to Alan, try the “Alan 101” tutorial: Getting Started.

Get the Alan utility

If you start your project from the template, it already has the alan command line utility in the root directory.

You can also download it here:

Get the Alan Connect management app

To manage the stacks that run on your server, use the Alan Connect app:

Get the Alan server

You can use one of our images to run the server on a server or in a virtual machine:

You should be able to double-click the OVA to import it into [VirtualBox]. It’s configured so that on most systems you can simply hit “start” to run it.

If the network connection we configured doesn’t work, change the settings to use Bridged mode, hit OK and you should be all set.

On macOS or Linux you can also run the server on your own machine using this one-liner:

Linux:

bash -c "mkdir -p data runenv/image && curl -s https://dist.alan-platform.com/share/image/image-11-linux-x64.tar.gz | tar xzf - -C runenv/image && ln -s runenv/image/application-server serve"

macOS:

bash -c "mkdir -p data runenv/image && curl -s https://dist.alan-platform.com/share/image/image-11-darwin-x64.tar.gz | tar xzf - -C runenv/image && ln -s runenv/image/application-server serve"

You can then start the server by running:

./serve 127.0.0.1 12345

Tip: run this in a directory dedicated to the server as it will download additional utilities and create directories.

Languages

How to read grammars

Typical quirks of the Alan compiler

Important languages

auto-webclient janeway.6 deployment description.html
janeway.6 settings grammar.html
datastore 38 deployment description.html
38 migration grammar.html
interface 2.3 interface grammar.html
model 36 application grammar.html
36 client_request grammar.html
36 collection_query_to_table grammar.html