Command Line Interface (CLI)

Commands

All command support -?, -h, --help option that shows help and usage information.

Generating Architecture as Code (AaC)

Use execute-aac-strategy command to generate AaC in either C# or YAML. AaC can be generated either from C# source code or from CSV Architecture Catalogue making the following four scenarios possible:

1. Generating C# AaC from C# source code
2. Generating C# AaC from CSV Architecture Catalogue
3. Generating YAML AaC from C# source code
4. Generating YAML AaC from CSV Architecture Catalogue

NOTE: More scenarios may be supported in the future.

Usage

C4InterFlow execute-aac-strategy [options]

Options

AaC Root Namespace

-aac-rn, --aac-root-namespace: Architecture As Code root Namespace. (Required).

AaC Output Path

-aac-outp, --aac-output-path: The path to the Architecture As Code output (Required).

AaC Writer Strategy

-aac-ws, --aac-writer-strategy: The full Type name of the Architecture As Code Writer Strategy to execute (Required).

AaC Strategy Parameters

-aac-params, --aac-params: The key/value pairs of additional AaC Strategy parameters.

NOTE: AaC Strategy parameters are spesific for each Strategy e.g. any AaC generators that ultimately extend C4InterFlow.Automation.CSharpToAnyAaCStrategy would require software-system-source-path and software-system-name parameters.

Usage Examples

Example 1

C4InterFlow execute-aac-strategy --aac-root-namespace dotnet.eShop.Architecture --aac-output-path dotnet.eShop.Architecture\dotnet.eShop.Architecture.csproj --aac-writer-strategy "dotnet.eShop.Architecture.Cli.CSharpToCSharpBasketApiAaCGenerator, dotnet.eShop.Architecture.Cli" --aac-params software-system-source-path="C:\Repos\eShop-main\src\Basket.API\Basket.API.csproj" --aac-params software-system-name="BasketApi"

Example 2

C4InterFlow execute-aac-strategy --aac-root-namespace dotnet.eShop.Architecture --aac-output-path dotnet.eShop.Architecture\dotnet.eShop.Architecture\Yaml --aac-writer-strategy "dotnet.eShop.Architecture.Cli.CSharpToYamlCatalogApiAaCGenerator, dotnet.eShop.Architecture.Cli" --aac-params software-system-source-path="C:\Repos\eShop-main\src\Catalog.API\Catalog.API.csproj" --aac-params software-system-name="CatalogApi"

Drawing diagrams

Use draw-diagrams command to draw diagrams of different Types, Scopes and Level of Details using AaC in either C# or YAML.

Usage

C4InterFlow draw-diagrams [options]

Options

AaC Input Paths

-aac-inp, --aac-input-paths: The path to the Architecture As Code input (Required).

AaC Reader Strategy

-aac-rs, --aac-reader-strategy: The full Type name of the Architecture As Code Reader Strategy to use (Required).

Interfaces

-i, --interfaces: The aliases of the interfaces to be used as input for a Command. Multiple values are allowed.

Interfaces input file

-iif, --interfaces-input-file The file where the aliases of the Interfaces, which are intended to be used as input for a Command, can be loaded from.

Business processes

-bp, --business-processes: The full names of Business Process types for which to draw the Diagram(s). Multiple values are allowed.

Scopes

-s, --scopes: Scopes of Diagram(s) to draw. Multiple values are allowed. Default: * (all Scopes).

Possible values:
business-process
component
component-interface
container
container-interface
software-system
software-system-interface
software-systems

Types

-t, --types: Types of Diagram(s) to draw. Multiple values are allowed. Default: * (all Types).

Possible values:
c4
c4-static
sequence

Levels of Details

-l, --levels-of-details: Levels of Details of the Diagram(s). Multiple values are allowed. Default: * (all Levels of Details).

Possible values:
component
container
context

Show Interface Input/Output

-siinout, --show-interface-input-output: Show Interface Input and Output. Default: False.

NOTE: This option is used for component Level of Details only.

Output Directory

-od, --output-dir: The output directory for the current command. Default: Current working directory.

Output Sub-Directory

-osd, --output-sub-dir | The sub-directory where the Diagram(s) should be saved.

Name Prefix

-np, --name-prefix: The name prefix for a Diagram.

Formats

-f, --formats: Diagram format(s) to draw. Multiple values are allowed.

NOTE: Diagram(s) in puml format are always generated by default .

Possible values:
png
svg
md

Usage Examples

Example 1

C4InterFlow draw-diagrams --aac-input-paths dotnet.eShop.Architecture.dll --aac-reader-strategy "C4InterFlow.Automation.Readers.CSharpAaCReaderStrategy,C4InterFlow.Automation" --interfaces dotnet.eShop.Architecture.SoftwareSystems.*.Containers.*.Components.*.Interfaces.*

This command will generate diagrams of all Types, all Scopes and all Levels of Details for all Interfaces of all Components of all Containers of all Software Systems in dotnet.eShop.Architecture Namespace. It will use C# AaC (aac-reader-strategy) that is compiled as dotnet.eShop.Architecture.dll (aac-input-paths)

Example 2

C4InterFlow draw-diagrams --aac-input-paths "dotnet.eShop.Architecture\Yaml" --aac-reader-strategy "C4InterFlow.Automation.Readers.YamlAaCReaderStrategy,C4InterFlow.Automation" --interfaces dotnet.eShop.Architecture.SoftwareSystems.BasketApi.Containers.*.Components.*.Interfaces.* dotnet.eShop.Architecture.SoftwareSystems.CatalogApi.Containers.*.Components.*.Interfaces.* --types sequence --formats svg

This command will generate Plant UML - Sequence diagrams of Component interface Scope and all Levels of Details for all Interfaces of all Components of all Containers of BasketApi and CatalogApi Software Systems in dotnet.eShop.Architecture Namespace. It will use YAML AaC (aac-reader-strategy) that is saved in .yaml files located in dotnet.eShop.Architecture\Yaml directory (aac-input-paths)

Querying Architecture as Code (AaC)

Use query-use-flows command to finds all interface(s) that Use given interface(s) in their Flows.

Usage

C4InterFlow query-use-flows [options]

Options

Interfaces

-i, --interfaces: The aliases of the interfaces to be used as input for a Command. Multiple values are allowed.

Recursive

-r, --recursive: Indicates if the Query should be executed recursively. Default: False.

• Non-recursive Query will return only the immediate (first) instance of a given Interface being Used in a Flow by another Interface.
• Recursive Query will follow the whole Use Flow tree and will return only the top-most Interface from it.

Query Output File

-qof, --query-output-file: The name of the file where the Query results should be saved.

NOTE: If a value for this option is not provided, CLI will output Query results to Console.

Append

-a, --append: Append Query results to an output file. Default: False.

AaC Input Paths

-aac-inp, --aac-input-paths: The path to the Architecture As Code input (Required).

AaC Reader Strategy

-aac-rs, --aac-reader-strategy: The full Type name of the Architecture As Code Reader Strategy to use (Required).

Include Self

-incls, --include-self: Is Interface queried by included in the query result. Default: False.