Getting Started

This page describes how to run the ArchiChecker from a command line interface (CLI) on your laptop

To run the Ampersand compiler presumes you have docker installed on your computer. The following is the base command on linux (bash syntax)

docker run -it -v "$(pwd)":/scripts ampersandtarski/archiamp check <yourfilename>

On the Windows-10 command-line this looks slightly different:

docker run -it -v ${PWD}:/scripts ampersandtarski/archiamp check <yourfilename>

(You might consider making an alias for this command, to save yourself some typing.)

This command runs the Ampersand compiler. The first time you run it, Docker will need some time to download the designated image from the internet. After that, it will start as quickly as any other command. Here is an example of the output you can expect:

root-bash> docker run -it -v "$(pwd)":/scripts ampersandtarski/archiamp check repoExample.adl
/Users/sjo00577/ArchiChecker/voorbeeld/repoExample.archimate has been interpreted as an Archi-repository.
ArchiMetaModel.adl written
/Users/sjo00577/ArchiChecker/voorbeeld/repoExample.adl:28:1 error:
There are 11 violations of RULE "Policy 2.1":
ApplicationFunction "HR registration" is not realized by any ApplicationComponent.
ApplicationFunction "Account administration" is not realized by any ApplicationComponent.
ApplicationFunction "Application distribution Office" is not realized by any ApplicationComponent.
ApplicationFunction "Groups administration" is not realized by any ApplicationComponent.
ApplicationFunction "Access management" is not realized by any ApplicationComponent.
ApplicationFunction "CS Poli-Apotheek " is not realized by any ApplicationComponent.
ApplicationFunction "Exchange management" is not realized by any ApplicationComponent.
ApplicationFunction "Manage user profiles" is not realized by any ApplicationComponent.
ApplicationFunction "Site management SharePoint" is not realized by any ApplicationComponent.
ApplicationFunction "Identity provisioning" is not realized by any ApplicationComponent.
... (1 more)==============================
/Users/sjo00577/ArchiChecker/voorbeeld/repoExample.adl:34:1 error:
There is one violation of RULE "Policy 2.2":
ApplicationFunction "Application Function A" is realized by ApplicationComponents {Application A, Application Component B}.==============================
/Users/sjo00577/ArchiChecker/voorbeeld/repoExample.adl:52:1 error:
There are 18 violations of RULE "Policy 4.1":
Business Process 'User deprovisioning' does not have an owner.
Business Process 'Self-service SharePoint' does not have an owner.
Business Process 'Access exchange' does not have an owner.
Business Process 'License management' does not have an owner.
Business Process 'Distribution Outlook client' does not have an owner.
Business Process 'BSN and COV check insurance data' does not have an owner.
Business Process 'Termination of employment' does not have an owner.
Business Process 'User provisioning' does not have an owner.
Business Process 'User provisioning Exchange' does not have an owner.
Business Process 'Capacity management' does not have an owner.
... (8 more)==============================
/Users/sjo00577/ArchiChecker/voorbeeld/repoExample.adl:84:1 error:
There are 14 violations of RULE "Policy 7.1":
Application Component 'Brocacef supplier (orders)' does not have an owner.
Application Component 'Central application (Chipsoft HiX)' does not have an owner.
Application Component 'Autopharma ' does not have an owner.
Application Component 'Tenant management Office 365' does not have an owner.
Application Component 'Application A' does not have an owner.
Application Component 'App-V/ThinApp' does not have an owner.
Application Component 'MIRA (CGM Pharmacy) ' does not have an owner.
Application Component 'ServiLocker' does not have an owner.
Application Component 'Azure AD' does not have an owner.
Application Component 'National Exchange Point ' does not have an owner.
... (4 more)
ExitFailure 10