Skip to content

Commit be167b0

Browse files
authored
Merge pull request #4 from editor-code-assistant/chore/improve-allium-docs
Improve Allium plugin docs and add plugin to render GH MD tables
2 parents 822df06 + 697b964 commit be167b0

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

plugins/allium/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,19 @@ Allium has no compiler or runtime — it is a specification artefact interpreted
1010

1111
## Install the CLI (recommended)
1212

13-
The plugin works without the CLI, but automatic validation and analysis require the `allium` command to be available in ECA's `PATH`. Install it with Homebrew:
13+
The plugin works without the CLI, but automatic validation and analysis require the `allium` command to be available in `PATH`. Installation instructions are at [juxt/allium-tools](https://github.com/juxt/allium-tools).
1414

15-
```bash
16-
brew tap juxt/allium && brew install allium
17-
```
15+
## First steps
1816

19-
or Cargo:
17+
Start with `/allium` if you are not sure which workflow you need. It gives ECA the Allium syntax summary and routes you toward the right skill.
2018

21-
```bash
22-
cargo install allium-cli
23-
```
19+
If you are designing a new feature, start with `/allium:elicit`. ECA will ask structured questions about the boundary, actors, lifecycle states, triggers, edge cases, and open questions, then help turn the answers into a `.allium` specification.
2420

25-
Then verify from the same environment that launches ECA:
21+
If you already have code and want to capture what it does, use `/allium:distill`. ECA will inspect the implementation, separate domain behaviour from implementation details, and draft a behavioural spec that can be reviewed and refined.
2622

27-
```bash
28-
command -v allium && allium --version
29-
```
23+
Once a spec exists, use `/allium:tend` for targeted changes, `/allium:weed` to compare the spec with the implementation, and `/allium:propagate` to turn the spec into test obligations or concrete tests.
24+
25+
What to expect: Allium does not replace implementation or tests. It gives ECA a durable behavioural model of what the system is meant to do, so future sessions can reason about intent, spot missing decisions, catch spec-code drift, and generate better tests from explicit behaviour.
3026

3127
## First steps
3228

0 commit comments

Comments
 (0)