root-at-skic
55894fbade
- examples/: c4-standard-web-app, c4-e-shop (was online-shop), c4-event-based-integration; the same models the extension offers under Archify | New Model… - model-scaffold --example <name> copies one and renames id, name, description and the overview title; never overwrites - tests cover every example and the copy; docs updated
21 lines
1.5 KiB
Markdown
21 lines
1.5 KiB
Markdown
# archify-vscode-ext
|
|
|
|
Agent Skill for Archify diagrams and models as read by the [Archify Diagram Viewer](https://marketplace.visualstudio.com/items?itemName=root-at-skic.archify-vscode-ext) VS Code extension: how to write `.archify` diagrams (architecture, workflow, sequence, dataflow, lifecycle), how to put them together as a model (`main.archify`, shared elements in `*.archify-registry` files, `ref:` components, `diagram:` links, C4-style folders), and tasks that validate, list, scaffold, resolve and render them. The Archify validator and renderer (MIT, by tt-a1i) are bundled under `scripts/vendor`, so nothing else needs to be installed.
|
|
|
|
Quick start:
|
|
|
|
```bash
|
|
cd scripts
|
|
task model:scaffold -- --dir="/path/to/online-shop" --id="online-shop" --name="Online Shop" --c4
|
|
task model:validate -- --dir="/path/to/online-shop"
|
|
task diagram:render -- --file="/path/to/online-shop/0200-containers/online-shop.archify" --out="/tmp/containers.html"
|
|
```
|
|
|
|
See [SKILL.md](SKILL.md) for the workflow, the task table and the gotchas. `examples/` holds three complete models that validate (C4 - Standard Web App, C4 - E-Shop, C4 - Event-Based Integration); `task model:scaffold -- --dir="…" --example="c4-e-shop"` copies one.
|
|
|
|
Requires Node.js 18+, bash and [go-task](https://taskfile.dev). The skill targets the Archify Diagram Viewer extension; a diagram that validates here opens the same way in VS Code.
|
|
|
|
## Support
|
|
|
|
If this saves you time, you can buy me a coffee: https://buymeacoffee.com/root.at.skic
|