Skip to content

normenmueller/armlet

Repository files navigation

armlet

armlet, ARchimate Modeling LanguagE Transformations, is to be understood as an accessory with which you can decorate models described in ArchiMate and represented by Archi.

Note: .archimate must be XML. If, e.g., you include a canvas in you model, Archi utilizes a proprietary binary format.

Installation

First of all, get stack if you don't have it already: see the official stack documentation. Note that stack is also included in the Haskell platform, and on Linux it is usually available in your package manager.

If you have git, you can now clone the repository and build:

git clone https://github.com/normenmueller/armlet.git
cd armlet
git checkout <commit/tag/branch>
stack install

If you don't have git, just download the sources for your preferred commit/branch/tag via the GitHub interface, and run stack install in the directory that contains stack.yaml file.

This will install armlet executable to $HOME/.local/bin.

To install the bash completion system-wide:

armlet --bash-completion-script armlet >/etc/bash_completion.d/armlet

To install the zsh completion user-specific, add the following to your .zshrc:

armlet --zsh-completion-script `which armlet` > ${HOME}/.local/_armlet
FPATH=${HOME}/.local/:$FPATH

if type brew &>/dev/null; then
  FPATH=$(brew --prefix)/share/zsh-completions:$FPATH

  autoload -Uz compinit
  compinit
fi

Usage

Usage information is available via armlet -h.

License

See LICENSE for details.

© 2020 Normen Müller