Running the Ampersand compiler

NAME
ampersand
Runs the Ampersand compiler (from your command prompt)
SYNOPSIS (run from the command line in Windows, MacOS, and Linux.)
ampersand [OPTIONS] FILE
This presumes you have ampersand installed on your computer and it can be found (i.e. the path is set correctly).
SYNOPSIS (run on Docker)
docker run -it -v "$(pwd)":/scripts ampersandtarski/ampersand [OPTIONS] FILE
This alternative presumes you have docker installed on your computer and it can be found (i.e. the path is set correctly). If ampersand is not present, docker will get it from docker hub. So you need to be connected to internet. The docker image is built as a linux container (which is relevant if you run docker from Windows 10)
DESCRIPTION
ampersand takes a file as input. It must contain a valid ampersand script, i.e. a script that complies to the syntax and semantics of ampersand. The compiler will not generate any output unless the script is valid.
When used without any options, it will check if the input is valid. If so, it will do nothing, if not, it will tell you what is wrong.
OPTIONS
The list of options contains all compiler options.
The standard behavior of ampersand is affected by the following environment variables.
CCdbName  Sets the name of the database that is to be generated. Can be overruled by --dbName
CCdirOutput Sets the default output directory for generated assets. Can be overruled by --outputDir 
CCdirPrototype Sets the default directory where functional prototypes are being generated. Can be overruled by --proto
EXAMPLES
ampersand -fdocx --verbose Hawaii.adl             # generates a specification document for Hawaii.adl
ampersand Delivery.adl                            # just check Delivery.adl for errors
ampersand --proto="D:\htdocs\CvM\" Contracts.adl  # generate a prototype from Contracts.adl
ampersand --help
ampersand --help --verbose
ampersand --version
BUGS
We are happy to receive bug reports at AmpersandTarski . However, please try to help us by first checking that it has not been reported already. You can do so by searching the issues. When in doubt however, don't hesitate to create a new issue.
Exit status
In case the Ampersand compiler is called by software and fails, it is useful to have an exit code to give some information about the nature of the failure. The Ampersand compiler produces the following exit codes:
Code
Name
Meaning
0
Success
Compilation has terminated without failures
2
Fatal
This is a software error in the Ampersand compiler, that should never have occured in operational use. Please report an issue.
10
Invalid
The script is not valid and the compiler has produced error messages to help you diagnose your mistake(s).
20
Inconsistent
The population would violate invariants. The compiler cannot generate a violation-free database.
30
Invalid SQL
An SQL query gives other results than the semantics of Ampersand prescribes. This should never occur, so please report an issue.
50
Ampersand violations
There are sanity checks on your script that have produced violations, so the compiler will not generate an application.
60
Composer
The installation of Composer failed, so the front-end application will not work. This is most likely a configuration error.
70
Wrong arguments
The command-line arguments by which the compiler was called contain errors. Inspect the compiler output for a diagnosis.
80
Back-end
The compiler failed to install the prototype framework. This is most likely a configuration error.

Design considerations

Run Ampersand on Docker

Last updated 2 months ago

Code	Name	Meaning
0	Success	Compilation has terminated without failures
2	Fatal	This is a software error in the Ampersand compiler, that should never have occured in operational use. Please report an issue.
10	Invalid	The script is not valid and the compiler has produced error messages to help you diagnose your mistake(s).
20	Inconsistent	The population would violate invariants. The compiler cannot generate a violation-free database.
30	Invalid SQL	An SQL query gives other results than the semantics of Ampersand prescribes. This should never occur, so please report an issue.
50	Ampersand violations	There are sanity checks on your script that have produced violations, so the compiler will not generate an application.
60	Composer	The installation of Composer failed, so the front-end application will not work. This is most likely a configuration error.
70	Wrong arguments	The command-line arguments by which the compiler was called contain errors. Inspect the compiler output for a diagnosis.
80	Back-end	The compiler failed to install the prototype framework. This is most likely a configuration error.