Docs
To get started with Alan:
- An introduction to Alan
- Tutorial A: developing software with Alan
- Tutorial B: a Restaurant app, Part I
- Tutorial C: a Restaurant app, Part II
- The Alan stack from the bottom up
Other useful resources:
- Migrating application data with the Alan IDE
- Version control & offline editing for the Alan IDE
- Spreadsheet data import & export in Alan apps
- Users & Authentication in Alan apps
- Background information on the syntax
- An older tutorial: a quick starter
The alan script (2026.2):
The alan script is the command-line entry point to the platform.
It downloads the toolchain for its platform version, sets up an empty project from a template, builds the project, and packages it for deployment.
curl -O https://dist.alan-platform.com/share/versions/2026.2/alan
chmod +x alan
./alan init # empty project from the default template, fetches the 2026.2 toolchain
./alan build
Run ./alan --help for all subcommands.
Language documentation (2024.2):
Below you can find a list of languages that are part of the Alan platform.
The application language is for application.alan files.
The interface language for interface.alan files.
The wiring language for wiring.alan files, the deployment language for deployment.alan files, and so on. If you cannot find the language documentation for a file, please ask about it on the forum. We plan to add a complete overview to this page in the near future.
See versions.json for the latest recommended versions of the different system types that are compatible with the specified platform version.
| model | 106 | application |
|---|---|---|
| client_request | ||
| interface | 20 | interface |
| project-build-environment | 41 | deployment |
| project_wiring | ||
| wiring | ||
| auto-webclient | yar.11 | generator_annotations |
| generator_settings | ||
| parameters | ||
| phrases | ||
| query | ||
| translations | ||
| connector | 36.5 | processor |
| variables | ||
| datastore | 116 | consumed_interfaces_mapping |
| migration_mapping | ||
| provided_interface_implementation | ||
| regular_expression_engine | ||
| relational-database-bridge | 110 | database |
| database_transformation | ||
| regular_expression_engine | ||
| sql-mirror | 116 | sql_mapping |
| webclient | yar.11.0 | client bindings |
| default features | ||
| gui_model | ||
| handheld features | ||
| main | ||
| parameters | ||
| phrases | ||
| production features | ||
| query | ||
| settings | ||
| translations | ||
| views | ||
| widget |