CLI Reference

validate · fmt · export · render · md

CLI-viittaus

Se on datro-CLI on ensisijainen vaihtoehto, .dtro-Validoida, muotoilla, viedä ja renderoida tiedostoja sinun terminaalistasi tai CI-piipelineestäsi.

# Install globally
npm install -g datro

# Or run without installing via npx
npx datro --version

validoidafmtvientiäpalautettavamd

Validoida datro

Analysoi .dtro-Dossi, joka suorittaa kaikki neljä validointiprosessia ja tulostaa diagnooseja file:line:col-Varastointipaikat. Lopetettu 0, jos virheitä ei ole (varoitukset ovat sallittuja).

# Validate and print human-readable diagnostics
datro validate arch.dtro

# Suppress info-level hints
datro validate arch.dtro --no-info

# Output machine-readable JSON (for CI pipelines, tooling)
datro validate arch.dtro --json

✓ arch.dtro
  nodes=5  edges=6  groups=1  constraints=1
  errors=0  warnings=1  info=1

[W] arch.dtro:38:3 W602 Theme colour 'cache: #C0FFE8' has contrast ratio 1.82:1 ...
[I] arch.dtro:12:1 I003 No meta block found — consider adding one for documentation

Esimerkki (1 varoitus, 1 tiedonanto, 0 virhe → uloskäynti 0)

Field	Type	Required	Default	Description
`--json`	flag	No	—	Kirjoita diagnoosit ja IR-tilastoja JSON:n muodossa. Käytettävissä CI-työkalujen ja -editorin integraatioissa.
`--no-info`	flag	No	—	Pysäytä diagnoosi tietokannalla `I×××` julkaisusta.

että fmt

Tulostaa tai kirjoittaa kanoninen muoto .dtro-Vaihdattu. Muodostaja on deterministinen: sama IR tuottaa aina saman tuloksen, joten Diff näkee vain todellisia muutoksia.

# Print canonical form to stdout (no file changes)
datro fmt arch.dtro

# Overwrite file with canonical form
datro fmt --write arch.dtro

# CI check — exits non-zero if file is not already canonical
datro fmt --check arch.dtro

Field	Type	Required	Default	Description
`--write`	flag	No	—	Kirjoita tiedosto suoraan kanoniseen muotoon.
`--check`	flag	No	—	Exit ei ole yhtä nolla, jos tiedosto ei ole jo kanoninen käyttää Pre-Commit Hooks tai CI.

💡

Ennakkoratkaisukoko

Lisää datro fmt --check arch.dtro lisätä ennen sitoutumista, jotta kanoninen muoto on aina kirjoitettu. Tämä estää koodivalvonnassa muodostumisen ääniä.

Datro-vienti

Muunnittakoon validoitu .dtro-Tiedosto muussa koneen lukemassa muodossa. Paina standardin mukaan stdout; käytä --out, Kirjoittaminen tiedostoon.

# Export to Graphviz DOT (pipe into dot for rendering)
datro export arch.dtro --to dot

# Export to Cytoscape.js JSON
datro export arch.dtro --to cytoscape --out arch.cytoscape.json

# Export the lossless JSON IR (full metadata preserved)
datro export arch.dtro --to json --out arch.ir.json

Field	Type	Required	Default	Description
`--to`	string "dot""cytoscape""json"	Yes	—	Tavoitteellinen muoto.
`--out`	path	No	—	Kirjoita tulos tähän tiedostoon stdoutin sijaan.

`dot` – Graphviz DOT-Sprache. Siirtäminen dot -Tsvg Käyttöön tarkoitettujen instrumenttiketjun ulkopuolisten esitysten osalta.
`cytoscape` – Cytoscape.js JSON. Yhteentoimittavien verkkosikavien suora tuonti jokaiseen cytoscape-tapahtumaan.
`json` – Luottomuutta JSON IR (täydellinen) DatroIR-Aineisto). Käytä niitä jokaisessa räätälöidyssä tietotekniikan testauksessa, jokaisessa käsikirjoituksessa tai jokaisessa näytöksessä.

Datro-arviointi

Tarjoaa yksi .dtro-Graphviz-tiedosto pikseliä täsmällisessä SVG:ssä tai PNG:ssä. Tarvitaan laitteen asennus dot-Graphviz:n binary-tiedosto ja $PATH.

# Render to SVG (requires Graphviz installed)
datro render arch.dtro --out diagram.svg

# Render to PNG
datro render arch.dtro --out diagram.png

Field	Type	Required	Default	Description
`--out`	path	Yes	—	Lähtötiedoston polku. Laajentaminen määrittelee muodon: `.svg` tai `.png`.

ℹ️

Grafiikka vaaditaan

Laittakaa Graphviz [graphviz.org/download]](https://graphviz.org/download/) ja varmista, että dot Seuraavassa on $PATH on. CLI lopetetaan selkeällä virheellä, jos sitä ei löydetä.

datro md

Käsitellään datro-fensoituja koodiblokkeja, jotka on sisällytetty markdown-tiedostoihin. Kaksi alajoukkoa: check (vain validointi, graffiti ei tarvita) ja render (Validointi + SVG/PNG-muutos).

# Validate all Datro blocks embedded in a Markdown file
datro md check docs/architecture.md

# Validate and output JSON (CI-friendly)
datro md check docs/architecture.md --json

# Render all blocks to SVG files next to the Markdown file
datro md render docs/architecture.md

# Render to a specific output directory in PNG format
datro md render docs/architecture.md --out-dir public/diagrams --format png

# Continue even when some blocks have errors
datro md render docs/architecture.md --no-fail

Sisäytetyn paikan muoto

Valitse seinävartiossa oleva kappale, jossa on kielellinen tunnistus datro. Plokki on sisällettävä Magic Header.:

Markdown

<!-- docs/architecture.md -->

# System Overview

```datro
#!DATRO 1.0

node api { type: gateway label: "API Gateway" }
node svc { type: service label: "Auth Service" }

edge api -> svc { kind: http }
```

Run `datro md render docs/architecture.md` to generate
`docs/architecture-block-1.svg` alongside this file.

Datro-blokki on merkintätiedostossa

Field	Type	Required	Default	Description
`--out-dir`	path	No	—	`md render` – Editustiedostojen luettelo. Säännöllisesti sama luettelo kuin merkintä- ja merkintätiedosto.
`--format`	string "svg""png"	No	`svg`	`md render` – Valmistusmuoto.
`--json`	flag	No	—	`md check` – Tulokset JSON:n sijaan ihmisille lukemattoman tekstin.
`--no-fail`	flag	No	—	Jatkakaa käsittelyä jäljellä olevista lohkoista, vaikka ne olisivat virheellisiä. Lopetettu `0`.

CI:n integrointi

Lisää nämä askeleet jokaiseen CI-piipelineen, jotta grafiikan laatu voittaa jokaisen pull-kysymyksen:

.github/workflows/ci.yml

# .github/workflows/ci.yml (excerpt)
- name: Validate Datro diagrams
  run: |
    npx datro fmt --check docs/arch.dtro
    npx datro validate docs/arch.dtro --no-info
    npx datro md check docs/architecture.md --json

fmt --check – epäonnistuu, jos kaavio ei ole kanonisesti muotoiltu.
validate --no-info – epäonnistuu jokaisessa virheiden painopisteessä.
md check --json – validoi kaikki sisäänrakennetut kaaviot; JSON-muodostus voidaan integroida merkintävälineisiin.

Seuraava askel

Lue Language Reference täydelliseksi .dtro-Syntaxis.
Lue, miten tehdä se Remark- tai Markdown-it-pluginilla.

Avaa kaavioiden tekijä

Mieluummin selaimetta? Validoida ja palauttaa ilman mitään asennusta.