workspace-architect 1.5.12 → 1.5.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Workspace Architect
2
2
 
3
- A comprehensive library of specialized AI personas and chat modes for GitHub Copilot, ranging from architectural planning and specific tech stacks to advanced cognitive reasoning models.
3
+ A comprehensive library of specialized AI agents and personas for GitHub Copilot, ranging from architectural planning and specific tech stacks to advanced cognitive reasoning models.
4
4
 
5
5
  ## Overview
6
6
 
@@ -8,7 +8,7 @@ Workspace Architect is a CLI tool and library designed to enhance your experienc
8
8
 
9
9
  * **Instructions**: Detailed guidelines to set the context for Copilot.
10
10
  * **Prompts**: Reusable prompts for specific tasks like code review or refactoring.
11
- * **Chat Modes**: Specialized personas (e.g., "Azure Architect", "React Expert") to guide the conversation.
11
+ * **Agents**: Specialized personas (e.g., "Azure Architect", "React Expert") to guide the conversation.
12
12
  * **Collections**: Grouped assets for specific domains (e.g., "Web Development", "DevOps").
13
13
 
14
14
  ## Why Workspace Architect?
@@ -33,7 +33,7 @@ npx workspace-architect list
33
33
 
34
34
  * **Instructions (`instructions`)**: These are system-level instructions or "custom instructions" you can add to your `.github/copilot-instructions.md` or use to prime a session.
35
35
  * **Prompts (`prompts`)**: Specific queries or templates to ask Copilot to perform a task.
36
- * **Chat Modes (`chatmodes`)**: Specialized persona definitions that define how Copilot should behave, reason, and respond.
36
+ * **Agents (`agents`)**: Specialized agent definitions (`.agent.md` files) that define how Copilot should behave, reason, and respond. These are stored in `.github/agents/`.
37
37
  * **Collections (`collections`)**: Bundles of the above assets tailored for specific roles or workflows.
38
38
 
39
39
  ### CLI Reference
@@ -83,8 +83,8 @@ We welcome contributions! Whether you want to add a new persona, improve existin
83
83
 
84
84
  ### Project Structure
85
85
 
86
- * `assets/`: Contains the source markdown and JSON files for all assets.
87
- * `chatmodes/`: Persona definitions.
86
+ * `.github/agents/`: Contains agent definitions (`.agent.md` files) - specialized personas.
87
+ * `assets/`: Contains the source markdown and JSON files for other assets.
88
88
  * `collections/`: JSON files defining groups of assets.
89
89
  * `instructions/`: Contextual guidelines.
90
90
  * `prompts/`: Reusable prompt templates.
@@ -136,10 +136,11 @@ We welcome contributions! Whether you want to add a new persona, improve existin
136
136
 
137
137
  ### Adding New Assets
138
138
 
139
- 1. Create a new markdown file in the appropriate folder (`assets/instructions`, `assets/prompts`, or `assets/chatmodes`).
139
+ 1. Create a new markdown file in the appropriate folder (`.github/agents/`, `assets/instructions`, or `assets/prompts`).
140
140
  2. **Naming Convention**: The filename becomes the ID.
141
141
  * Example: `assets/instructions/my-guide.md` becomes `instructions:my-guide`.
142
- * Extensions like `.chatmode.md` or `.prompt.md` are stripped from the ID but help with organization.
142
+ * Example: `.github/agents/my-agent.agent.md` becomes `agents:my-agent`.
143
+ * Extensions like `.agent.md`, `.instructions.md`, or `.prompt.md` are stripped from the ID but help with organization.
143
144
  3. **Metadata**: You can optionally add YAML frontmatter to your markdown files to provide a description and title.
144
145
 
145
146
  ```markdown
@@ -163,7 +164,7 @@ Collections are JSON files located in `assets/collections/`. They group multiple
163
164
  "items": [
164
165
  "instructions:reactjs",
165
166
  "prompts:code-review",
166
- "chatmodes:expert-architect"
167
+ "agents:expert-architect"
167
168
  ]
168
169
  }
169
170
  ```
@@ -175,3 +176,18 @@ Collections are JSON files located in `assets/collections/`. They group multiple
175
176
  * Use `npm run analyze -- --add` to automatically add high-confidence matches.
176
177
  * Use `npm run analyze -- --remove` to remove low-confidence items.
177
178
  * **`npm run fetch-upstream`**: Syncs assets from the upstream `github/awesome-copilot` repository (requires configuration).
179
+
180
+ ### Migration from `.chatmode.md` to `.agent.md`
181
+
182
+ This project has migrated from the legacy `.chatmode.md` extension to the new `.agent.md` convention, with agents now stored in `.github/agents/` instead of `assets/agents/`.
183
+
184
+ **For existing users:**
185
+
186
+ If you have existing `.chatmode.md` files in your projects, you can migrate them using this command:
187
+
188
+ ```bash
189
+ mkdir -p .github/agents
190
+ find . -name '*.chatmode.md' -exec bash -c 'mv "$1" ".github/agents/$(basename \"$1\" .chatmode.md).agent.md"' -- {} \;
191
+ ```
192
+
193
+ **Note:** VS Code continues to recognize `.chatmode.md` files for backward compatibility, but `.agent.md` in `.github/agents/` is now the preferred convention for GitHub Copilot.