Basics

To get a full list of all available sub commands use --help as follows:

./tangle-guard --help

The Web User Interface

The Tangle-Guard comes with a fully features web interface. The web application is where the system’s architecture can be defined and where you get insights of the codebase. Any updates made from the UI are stored in the configuration file.

The following is supported:

• View a visualization of you workspace as graph diagram
• Define layers and associated packages with those layers
• Define dependency rules between layers.
• Describe packages for further insights and as documentation.
• Define domains and associate packages to those
• Planned packages that need to be implemented

All configurations are supposed to be made from the UI. When your current working directory is the root of you rust project, you can start the UI with the following command:

./tangle-guard ui

Alternatively use the -d option to specify the directory of your rust project.

Note

The UI reads the your configuration file and adds it as state in the web app.

Caution

If you make changes to the configuration file directly, there is a change that the data is not consistent anymore. E.g. if you rename a layer, make sure you rename the layer also within the rules. To omit this problem, it’s recommended to adjust the configuration only via the UI.

Validate Rules also from the CLI

./tangle-guard validate

This command will validate the rules defined in the configuration file. Best you run this command before committing your changes to the repository. This will ensure that the rules are valid and that the codebase adheres to the defined architecture.