You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ The fastest way to get started is to let your AI coding assistant build your fir
76
76
plugboard ai init
77
77
```
78
78
79
-
This copies a context file (`AGENTS.md`) and a `skills/`directory into your project so your AI tool has Plugboard-specific guidance for structuring models, keeping component arguments YAML-friendly, exporting configs, generating diagrams, running scenarios, and setting up tuning.
79
+
This copies a context file (`AGENTS.md`) and installs Agent Skills into `.agents/skills/`by default (or `.github/skills/` / `.claude/skills/` with `--style`) so your AI tool has Plugboard-specific guidance for structuring models, keeping component arguments YAML-friendly, exporting configs, generating diagrams, running scenarios, and setting up tuning.
80
80
81
81
Once initialised, simply open your AI tool of choice (GitHub Copilot, Cursor, Claude, etc.) and describe the model you want to build. For example:
Copy file name to clipboardExpand all lines: docs/usage/ai.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Plugboard ships with tooling to help AI coding agents understand how to build mo
4
4
5
5
## Initialising a project
6
6
7
-
The `plugboard ai init` command creates an `AGENTS.md` file and a `skills/` directory in your project directory. Together they give AI coding agents the context they need to help you build, export, visualise, run, and tune Plugboard models.
7
+
The `plugboard ai init` command creates an `AGENTS.md` file and installs Agent Skills in your project directory. Together they give AI coding agents the context they need to help you build, export, visualise, run, and tune Plugboard models.
8
8
9
9
`AGENTS.md` is a convention used by AI coding tools (such as [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview), [Codex](https://openai.com/index/codex/), and [Gemini CLI](https://github.com/google-gemini/gemini-cli)) to discover project-specific instructions automatically.
10
10
@@ -22,8 +22,14 @@ To create the file in a specific directory:
22
22
plugboard ai init /path/to/project
23
23
```
24
24
25
+
To choose where the skills are installed:
26
+
27
+
```bash
28
+
plugboard ai init --style github
29
+
```
30
+
25
31
!!! note
26
-
The command will not overwrite an existing `AGENTS.md` file or `skills/` directory. If either already exists in the target directory, the command exits with an error.
32
+
The command will not overwrite an existing `AGENTS.md` file or the selected skills directory. If either already exists in the target directory, the command exits with an error.
27
33
28
34
### What's installed?
29
35
@@ -37,7 +43,13 @@ The generated `AGENTS.md` covers:
Copy file name to clipboardExpand all lines: plugboard/cli/ai/AGENTS.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,12 +32,18 @@ Use this sequence when helping a user plan, implement, and run a Plugboard model
32
32
33
33
## Skill files
34
34
35
-
Additional task-specific instructions are available in `./skills/`. When a user asks for one of these tasks, read the matching `SKILLS.md` file and follow it:
35
+
Additional task-specific instructions are available in a style-specific skills directory. Depending on the setup, look under one of:
36
36
37
-
-`skills/create-yaml-config/SKILLS.md`
38
-
-`skills/process-diagram/SKILLS.md`
39
-
-`skills/run-process-scenario/SKILLS.md`
40
-
-`skills/configure-tune/SKILLS.md`
37
+
-`./.agents/skills/`
38
+
-`./.github/skills/`
39
+
-`./.claude/skills/`
40
+
41
+
When a user asks for one of these tasks, read the matching `SKILL.md` file and follow it:
Copy file name to clipboardExpand all lines: plugboard/cli/ai/skills/process-diagram/SKILL.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,9 @@
1
-
# Skill: Create a diagram from a Plugboard process
1
+
---
2
+
name: process-diagram
3
+
description: Generate a Mermaid diagram from a Plugboard YAML process configuration.
4
+
---
5
+
6
+
# Create a diagram from a Plugboard process
2
7
3
8
## Use this skill when
4
9
@@ -11,7 +16,7 @@ Create a diagram from a Plugboard process using the CLI.
11
16
12
17
## Instructions
13
18
14
-
1. Work from a YAML config whenever possible. If the process only exists in Python, first create a YAML config using the `skills/create-yaml-config/SKILLS.md` guidance.
19
+
1. Work from a YAML config whenever possible. If the process only exists in Python, first use the `create-yaml-config` skill at `../create-yaml-config/SKILL.md`.
15
20
2. Confirm which YAML config should be used. If the user wants the diagram saved to a file, plan to capture the CLI output.
Copy file name to clipboardExpand all lines: plugboard/cli/ai/skills/run-process-scenario/SKILL.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,9 @@
1
-
# Skill: Run a Plugboard process for a specific scenario
1
+
---
2
+
name: run-process-scenario
3
+
description: Update a Plugboard YAML config for a requested scenario and run it with the CLI.
4
+
---
5
+
6
+
# Run a Plugboard process for a specific scenario
2
7
3
8
## Use this skill when
4
9
@@ -11,7 +16,7 @@ Create or update a YAML config for the requested scenario, then run it with `plu
11
16
12
17
## Instructions
13
18
14
-
1. Make sure a YAML config exists for the model. If the model only exists in Python, create the YAML first using the `skills/create-yaml-config/SKILLS.md` guidance.
19
+
1. Make sure a YAML config exists for the model. If the model only exists in Python, create the YAML first by using the `create-yaml-config` skill at `../create-yaml-config/SKILL.md`.
15
20
2. Ask for any missing scenario inputs before running anything.
16
21
3. Update the YAML config with the exact parameter values the user requested.
17
22
4. Preserve a clear component structure that matches the real-world model. Do not collapse multiple entities into one component just to make the config shorter.
0 commit comments