structurizr / cli

Structura CLI ofera instrumente pentru a analiza definitiile spatiului de lucru Structurizr DSL, a le incarca in serviciul cloud Structurizr / instalare locala si a exporta diagrame in alte formate (de exemplu, PlantUML, Mermaid si WebSequenceDiagrams).

1. Descarcati si instalati Structurizr CLI

Exista o serie de modalitati de a descarca / instala CLI Structurizr.

Instalare locala

Descarcati Structurizr CLI din pagina de lansari si dezarhivati. Veti avea nevoie de Java (versiunea 8+) instalat si disponibil pentru a fi utilizat din linia de comanda ( va rugam sa retineti ca CLI nu functioneaza cu versiunile Java 11.0.0-11.0.3 ).

Homebrew (numai pentru MacOS)

Structurizr CLI poate fi instalat prin Homebrew dupa cum urmeaza:

Si pentru a face upgrade:

Scoop (numai pentru Windows)

Structurizr CLI poate fi instalat prin Scoop dupa cum urmeaza:

Si pentru a face upgrade:

Docker, containere pentru dezvoltatori etc.

Structurizr CLI poate fi incorporat intr-un container, pentru a evita instalarea locala. Vezi leopoldodonnell / structurizr-cli-docker sau aidmax / structurizr-cli-docker pentru cateva exemple de Docker. Alternativ, daca utilizati Visual Studio, aruncati o privire la evilpilaf / structurizr-remotecontainer.

Construiti din sursa

Pentru a construi din sursa, clonati aceasta repo si executati urmatoarea comanda:

2. Creati un model de arhitectura software cu DSL

Creati un nou fisier gol cu ​​editorul de text preferat si copiati urmatorul text in el.

Salvati acest fisier in directorul CLI dezarhivat.

Aceasta definitie DSL:

• creeaza o persoana numita „Utilizator”
• creeaza un sistem software numit „Sistem software”
• creeaza o relatie intre persoana si sistemul software
• creati o vizualizare context a sistemului pentru sistemul software
• creeaza cateva stiluri de elemente care vor fi aplicate la redarea diagramei

Va rugam sa retineti ca Structurizr CLI va va crea cateva vizualizari implicite daca nu le definiti singur in DSL. Consultati Setari implicite pentru mai multe detalii.

3. Redati cu Structurizr sau exportati in alte formate de diagrama

Acum puteti fie sa redati diagramele cu serviciul cloud Structurizr / instalarea locala, fie sa redati diagramele cu un alt instrument (de ex. PlantUML, Mermaid etc.).

Incarcati si redati cu serviciul cloud Structurizr / instalare locala

Daca nu ati facut acest lucru, urmati Structurizr – Notiuni introductive pentru a va inscrie pentru un cont gratuit Structurizr si pentru a crea un spatiu de lucru. Pentru a va incarca spatiul de lucru in serviciul cloud Structurizr / instalarea locala, veti avea nevoie de ID-ul spatiului de lucru, cheia API si secret. Consultati Structurizr – Spatii de lucru pentru informatii despre gasirea acestora.

Deschideti un terminal si lansati urmatoarea comanda pentru a incarca spatiul de lucru (ar trebui sa treceti la directorul CLI dezarhivat sau sa il aveti pe calea dvs.):

sau

• WORKSPACE_ID: ID-ul spatiului dvs. de lucru
• API_KEY: cheia dvs. API
• API_SECRET: secretul dvs. API
• WORKSPACE_FILE: numele fisierului DSL al spatiului dvs. de lucru

Acum va puteti conecta la contul dvs. Structurizr si puteti deschide spatiul de lucru din tabloul de bord. Spatiul dvs. de lucru ar trebui sa contina acum o diagrama ca aceasta:

Exportati si redati in alte formate de diagrama

Alternativ, puteti exporta vizualizarile definite in definitia spatiului de lucru DSL intr-un numar de alte formate, pentru redare cu alte instrumente. Nu aveti nevoie de un cont Structurizr pentru a face acest lucru. De exemplu, pentru a exporta vizualizarile in format PlantUML:

sau

Aceasta va crea o definitie PlantUML per vizualizare. Consultati exportul pentru mai multe detalii.