Skip to content
TangleGuard Docs
LinkedInGitHub

Configuration File

All information and configurations associated to your architecture is stored in a file in the root of your project. If you run tangle-guard for the first time, it will create that file for you.

  • src
  • Cargo.toml
  • architecture-def.json

The file is supposed to be included in Git. That way changes will be tracked over time and can be reviewed before merging like a normal code changes.

Below you see an example configuration.

{
  "layers": [
    {
      "name": "Interaction",
      "description": "",
      "packages": ["rest-api", "graphql-api"]
    }
  ],
  "packages": [
    {
      "name": "rest-api",
      "dependencies": ["utils"],
      "focus": "technical"
    }
  ],
  "rules": [
    {
      "from": "Interaction",
      "to": "Services"
    }
  ],
  "domains": [
    {
      "name": "User Management",
      "dsl": ["OAuth", "Token", "Role"],
      "domain_type": "Generic"
    }
  ]
}

You can edit the file manually but it’s highly recommended to use the web UI instead.