Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ means a real defect.

Neither covers LikeC4's own language. When writing the playground model in
`playground/src/likec4/`, the DSL examples in `docs/wiki/`, or fixture `.c4`
files, also use the official LikeC4 DSL skill
(`npx skills add https://github.com/likec4/likec4 --skill likec4-dsl`): FQNs,
cross-file scoping and the allowed top-level statements are its subject, and
getting them wrong surfaces here as a build failure with a parser message.
files, also install LikeC4's skill — `npx skills add https://likec4.dev/`, which
serves `likec4-dsl` over the Agent Skills Discovery protocol. FQNs, cross-file
scoping and the allowed top-level statements are its subject, and getting them
wrong surfaces here as a build failure with a parser message.

## Verifying changes

Expand Down
13 changes: 6 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### Added

- **The skills and the guide point at the official LikeC4 DSL skill.** Astroc4
covers the integration — fences, components, highlighting — and not LikeC4's
language, so both `skills/` files now name
[`likec4/likec4@likec4-dsl`](https://skills.sh/likec4/likec4/likec4-dsl) as a
companion (`npx skills add https://github.com/likec4/likec4 --skill likec4-dsl`).
- **The skills and the guide point at LikeC4's own DSL skill.** Astroc4 covers the
integration — fences, components, highlighting — and not LikeC4's language, so
both `skills/` files name `likec4.dev@likec4-dsl` as a companion and
[Getting Started](docs/wiki/guide/Getting-Started.md#writing-the-model) explains
when to reach for it and lists the rules that fail a build: FQNs, cross-file
scoping, project discovery, Markdown properties.
when to reach for it. It installs from the project's site,
`npx skills add https://likec4.dev/` (Agent Skills Discovery protocol), and the
same page documents the MCP server for querying a model in natural language.

### Changed

Expand Down
29 changes: 18 additions & 11 deletions docs/wiki/guide/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,21 +84,28 @@ typo in the DSL fails `astro build` with the file name and the parser's message.

The DSL inside a fence, or in a `.c4` file under `src/likec4`, is LikeC4's
language rather than astroc4's: this package renders what you wrote, and fails the
build when it cannot. If an agent is writing the model, give it the official
LikeC4 DSL skill as well — it carries the rules that are easy to get wrong
without a model in your head:
build when it cannot. LikeC4 publishes an agent skill that teaches exactly that —
the complete DSL reference, plus the CLI — and it installs from the project's own
site:

```sh
npx skills add https://github.com/likec4/likec4 --skill likec4-dsl
npx skills add https://likec4.dev/
```

The ones that catch people out: FQNs must be unique per project and use dots
(`payment.api` is not an identifier, `payment-api` is); scoping does not cross
file boundaries, so a reference in another file needs the full path
(`cloud.backend.api`); a project is the directory of the nearest config file
(`likec4.config.json`, `.like4rc`); and `summary`/`description`/`notes` take
Markdown in triple quotes. It also covers the CLI, which is what
`bun run likec4:validate` wraps.
That uses the Agent Skills Discovery protocol, so it works with Claude Code,
Cursor, Windsurf and other agents that support it; see
[AI Tools](https://likec4.dev/tooling/ai-tools/), which also documents the
[LikeC4 MCP server](https://likec4.dev/tooling/ai-tools/#mcp-server) for querying
an existing model in natural language.

The rules that catch people out, and that fail `astro build` when you get them
wrong: FQNs must be unique per project and use dots (`payment.api` is not an
identifier, `payment-api` is); scoping does not cross file boundaries, so a
reference in another file needs the full path (`cloud.backend.api`); a project is
the directory of the nearest config file (`likec4.config.json`, `.like4rc`); and
`summary`/`description`/`notes` take Markdown in triple quotes.

## Check it worked

## Check it worked

Expand Down
8 changes: 4 additions & 4 deletions docs/wiki/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Everything you need to put diagrams on a page, then to shape them.
| [Configuration Reference](Configuration-Reference.md) | Every option, default and environment variable. |

The DSL itself is LikeC4's language, not this package's. When a model is being
written — by you or by an agent — pair these pages with the official
[LikeC4 DSL skill](https://skills.sh/likec4/likec4/likec4-dsl)
(`npx skills add https://github.com/likec4/likec4 --skill likec4-dsl`); see
[Writing the model](Getting-Started.md#writing-the-model).
written — by you or by an agent — install LikeC4's own skill with
`npx skills add https://likec4.dev/` and see
[Writing the model](Getting-Started.md#writing-the-model) and LikeC4's
[AI Tools](https://likec4.dev/tooling/ai-tools/) page.

Back to the [documentation index](../README.md).
2 changes: 1 addition & 1 deletion skills/purview-astroc4-grammar/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ license: MIT
metadata:
product: astroc4
repository: purview-dev/astroc4
companion-skills: likec4/likec4@likec4-dsl
companion-skills: likec4.dev@likec4-dsl
---

# astroc4: the syntax-highlighting grammar
Expand Down
15 changes: 11 additions & 4 deletions skills/purview-astroc4-plugin/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ license: MIT
metadata:
product: astroc4
repository: purview-dev/astroc4
companion-skills: likec4/likec4@likec4-dsl
companion-skills: likec4.dev@likec4-dsl
---

# astroc4: diagrams in a Starlight site
Expand Down Expand Up @@ -65,17 +65,24 @@ rules that bite are not visible from here — FQNs must be unique per project,
scoping does not cross file boundaries, a project is the directory of the nearest
`likec4.config.*` / `.like4rc`, Markdown properties need triple quotes.

For that, install the official DSL skill alongside this one:
LikeC4 publishes a skill that covers exactly that (`likec4-dsl`, the complete DSL
reference: specification, model, views, deployment, predicates, CLI). Install it
from the project's own site:

```sh
npx skills add https://github.com/likec4/likec4 --skill likec4-dsl
npx skills add https://likec4.dev/
```

That endpoint uses the Agent Skills Discovery protocol, so it works with Claude
Code, Cursor, Windsurf and any other agent that speaks it; the same skill also
sits in `skills/likec4-dsl/` of the `likec4/likec4` repository, if the discovery
endpoint is unreachable.

Pair them when a task writes a model rather than wires a page: authoring a `.c4`
project in `src/likec4`, writing inline DSL in a fence, or fixing a
`Could not resolve reference to …` error. Keep this skill for the integration
question — which form to use, why nothing is coloured, why a fence stayed a code
block. `npx skills find likec4` lists the alternatives if that one is unavailable.
block.

## Diagnosing

Expand Down
Loading