workspace-architect 1.5.14 → 1.5.15

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.
Files changed (3) hide show
  1. package/README.md +139 -113
  2. package/assets-manifest.json +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,44 +1,58 @@
1
1
  # Workspace Architect
2
2
 
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.
3
+ [![npm version](https://img.shields.io/npm/v/workspace-architect.svg)](https://www.npmjs.com/package/workspace-architect)
4
+ [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
4
5
 
5
- ## Overview
6
+ > 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.
6
7
 
7
- Workspace Architect is a CLI tool and library designed to enhance your experience with GitHub Copilot. It provides a curated collection of:
8
+ Workspace Architect is a zero-friction CLI tool that provides curated collections of specialized agents, instructions, and prompts to supercharge your GitHub Copilot experience.
8
9
 
9
- * **Instructions**: Detailed guidelines to set the context for Copilot.
10
- * **Prompts**: Reusable prompts for specific tasks like code review or refactoring.
11
- * **Agents**: Specialized personas (e.g., "Azure Architect", "React Expert") to guide the conversation.
12
- * **Collections**: Grouped assets for specific domains (e.g., "Web Development", "DevOps").
10
+ ## Features
13
11
 
14
- ## Why Workspace Architect?
12
+ - ðŸŽŊ **Specialized Agents**: Pre-built personas like "Azure Architect", "React Expert", and more
13
+ - ðŸ“Ķ **Curated Collections**: Download complete suites for domains like Web Development, DevOps, or AI Engineering
14
+ - ⚡ **Zero Installation**: Use directly with `npx` - no global installation needed
15
+ - ðŸŠķ **Lightweight**: Simple Markdown files, no heavy dependencies or complex servers
16
+ - 🔄 **Algorithmic Curation**: TF-IDF/Cosine Similarity engine ensures collections stay relevant
17
+ - 🌍 **Universal**: Works with any project structure
15
18
 
16
- * **Curated Collections**: Don't waste time hunting for individual prompts. Download a complete "Web Development" or "DevOps" suite in one command.
17
- * **Zero Friction**: No installation required. Just run `npx workspace-architect` in any folder.
18
- * **Universal Portability**: Works with any project structure. Assets are simple Markdown files that live in your repo.
19
- * **Lightweight**: No complex MCP servers or heavy dependencies. Just pure context for Copilot.
20
- * **Algorithmic Curation**: Our collections are continuously monitored by an intelligent TF-IDF/Cosine Similarity engine to ensure they always include the most relevant assets and exclude outdated ones with zero regression.
19
+ ## Installation
21
20
 
22
- ## For Consumers
21
+ No installation required! Use directly with `npx`:
23
22
 
24
- ### Usage
23
+ ```bash
24
+ npx workspace-architect list
25
+ ```
26
+
27
+ Or install globally if you prefer:
28
+
29
+ ```bash
30
+ npm install -g workspace-architect
31
+ ```
32
+
33
+ ## Quick Start
25
34
 
26
- You can use this tool directly with `npx` without installing it globally:
35
+ List all available assets:
27
36
 
28
37
  ```bash
29
38
  npx workspace-architect list
30
39
  ```
31
40
 
32
- ### Asset Types
41
+ Download a collection for web development:
33
42
 
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
- * **Prompts (`prompts`)**: Specific queries or templates to ask Copilot to perform a task.
36
- * **Agents (`agents`)**: Specialized agent definitions (`.agent.md` files) that define how Copilot should behave, reason, and respond. These are stored in `assets/agents/` in this repository and downloaded to `.github/agents/` in your project by default.
37
- * **Collections (`collections`)**: Bundles of the above assets tailored for specific roles or workflows.
43
+ ```bash
44
+ npx workspace-architect download collections:web-frontend-development
45
+ ```
46
+
47
+ Download a specific agent:
48
+
49
+ ```bash
50
+ npx workspace-architect download agents:azure-architect
51
+ ```
38
52
 
39
- ### CLI Reference
53
+ ## Usage
40
54
 
41
- #### List Available Assets
55
+ ### Listing Assets
42
56
 
43
57
  View all available assets or filter by type:
44
58
 
@@ -46,16 +60,16 @@ View all available assets or filter by type:
46
60
  # List all assets
47
61
  npx workspace-architect list
48
62
 
49
- # List only instructions
63
+ # List specific types
50
64
  npx workspace-architect list instructions
51
-
52
- # List only collections
65
+ npx workspace-architect list agents
66
+ npx workspace-architect list prompts
53
67
  npx workspace-architect list collections
54
68
  ```
55
69
 
56
- #### Download an Asset
70
+ ### Downloading Assets
57
71
 
58
- Download a specific asset to your project. By default, assets are downloaded to `.github/<type>/`.
72
+ Download assets to your project (default location: `.github/<type>/`):
59
73
 
60
74
  ```bash
61
75
  npx workspace-architect download <type>:<name>
@@ -64,98 +78,78 @@ npx workspace-architect download <type>:<name>
64
78
  **Examples:**
65
79
 
66
80
  ```bash
67
- # Download a specific instruction file
81
+ # Download an instruction
68
82
  npx workspace-architect download instructions:reactjs
69
83
 
70
- # Download a collection of assets
71
- npx workspace-architect download collections:web-frontend-development
84
+ # Download an agent
85
+ npx workspace-architect download agents:planner
86
+
87
+ # Download a complete collection
88
+ npx workspace-architect download collections:devops-essentials
72
89
  ```
73
90
 
74
- **Options:**
91
+ ### CLI Options
92
+
93
+ - `-d, --dry-run` - Preview what will be downloaded without writing files
94
+ - `-f, --force` - Overwrite existing files without confirmation
95
+ - `-o, --output <path>` - Specify custom output directory
75
96
 
76
- * `-d, --dry-run`: Simulate the download without writing files. Useful to see where files will be placed.
77
- * `-f, --force`: Overwrite existing files without asking for confirmation.
78
- * `-o, --output <path>`: Specify a custom output directory.
97
+ ## Asset Types
79
98
 
80
- ## For Contributors
99
+ Workspace Architect provides four types of assets:
81
100
 
82
- We welcome contributions! Whether you want to add a new persona, improve existing prompts, or curate a collection, here is how you can help.
101
+ | Type | Description | Location |
102
+ |------|-------------|----------|
103
+ | **Instructions** | System-level guidelines for Copilot context | `.github/copilot-instructions.md` |
104
+ | **Prompts** | Reusable templates for specific tasks | `.github/prompts/` |
105
+ | **Agents** | Specialized personas defining Copilot behavior | `.github/agents/` |
106
+ | **Collections** | Bundled assets for specific domains or workflows | Multiple locations |
83
107
 
84
- ### Project Structure
108
+ ## Roadmap
85
109
 
86
- * `assets/agents/`: Contains agent definitions (`.agent.md` files) - specialized personas.
87
- * `assets/`: Contains the source markdown and JSON files for other assets.
88
- * `collections/`: JSON files defining groups of assets.
89
- * `instructions/`: Contextual guidelines.
90
- * `prompts/`: Reusable prompt templates.
91
- * `bin/`: Contains the CLI entry point (`cli.js`).
92
- * `scripts/`: Utility scripts for maintenance and analysis.
110
+ See [ROADMAP.md](ROADMAP.md) for our development timeline, upcoming features, and current capabilities.
111
+
112
+ ## Contributing
113
+
114
+ We welcome contributions! Whether you want to add a new agent, improve existing prompts, or curate a collection, here's how you can help.
93
115
 
94
116
  ### Development Setup
95
117
 
96
- 1. **Clone the repository**:
97
- ```bash
98
- git clone https://github.com/archubbuck/workspace-architect.git
99
- cd workspace-architect
100
- ```
101
-
102
- 2. **Install dependencies**:
103
- ```bash
104
- npm install
105
- ```
106
-
107
- 3. **Run the CLI locally**:
108
- You can test your changes by running the CLI script directly:
109
- ```bash
110
- node bin/cli.js list
111
- ```
112
-
113
- 4. **Test with Local Registry (Verdaccio)**:
114
- For a more accurate simulation of the end-user experience, we use Verdaccio as a local npm registry.
115
-
116
- * **Start the registry**:
117
- ```bash
118
- npm run start:registry
119
- ```
120
- * **Publish to local registry**:
121
- In a new terminal:
122
- ```bash
123
- npm run publish:local
124
- ```
125
- * **Run with `npx`**:
126
- ```bash
127
- npx --registry http://localhost:4873 workspace-architect list
128
- ```
129
-
130
- 5. **Quick Local Link (Alternative)**:
131
- For rapid iteration without publishing, you can link the package:
132
- ```bash
133
- npm link
134
- npx workspace-architect list
135
- ```
118
+ 1. Clone the repository:
119
+ ```bash
120
+ git clone https://github.com/archubbuck/workspace-architect.git
121
+ cd workspace-architect
122
+ ```
123
+
124
+ 2. Install dependencies:
125
+ ```bash
126
+ npm install
127
+ ```
128
+
129
+ 3. Test your changes:
130
+ ```bash
131
+ node bin/cli.js list
132
+ ```
136
133
 
137
134
  ### Adding New Assets
138
135
 
139
- 1. Create a new markdown file in the appropriate folder (`assets/agents/`, `assets/instructions`, or `assets/prompts`).
140
- 2. **Naming Convention**: The filename becomes the ID.
141
- * Example: `assets/instructions/my-guide.md` becomes `instructions:my-guide`.
142
- * Example: `assets/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.
144
- 3. **Metadata**: You can optionally add YAML frontmatter to your markdown files to provide a description and title.
145
-
146
- ```markdown
147
- ---
148
- title: My Custom Guide
149
- description: A guide for setting up X.
150
- ---
151
- # Content starts here...
152
- ```
136
+ Create a markdown file in the appropriate directory with optional YAML frontmatter:
153
137
 
154
- ### Creating Collections
138
+ ```markdown
139
+ ---
140
+ title: My Custom Guide
141
+ description: A guide for setting up X.
142
+ ---
143
+ # Content starts here...
144
+ ```
145
+
146
+ **Naming Convention**: Filenames become IDs (extensions are stripped)
147
+ - `assets/instructions/my-guide.md` → `instructions:my-guide`
148
+ - `assets/agents/my-agent.agent.md` → `agents:my-agent`
155
149
 
156
- Collections are JSON files located in `assets/collections/`. They group multiple assets together.
150
+ ### Creating Collections
157
151
 
158
- **Format:**
152
+ Create a JSON file in `assets/collections/`:
159
153
 
160
154
  ```json
161
155
  {
@@ -169,25 +163,57 @@ Collections are JSON files located in `assets/collections/`. They group multiple
169
163
  }
170
164
  ```
171
165
 
172
- ### Scripts
166
+ ### Useful Scripts
173
167
 
174
- * **`npm run generate-manifest`**: Generates `assets-manifest.json`. This file is used by the CLI in production to know what assets are available without scanning the file system. **Run this before submitting a PR.**
175
- * **`npm run analyze`**: Runs `scripts/analyze-collections.js`. This is an intelligent analysis tool that uses TF-IDF and Cosine Similarity to continuously monitor and regenerate collection profiles. It ensures collections always point to the most relevant assets with zero regression.
176
- * Use `npm run analyze -- --add` to automatically add high-confidence matches.
177
- * Use `npm run analyze -- --remove` to remove low-confidence items.
178
- * **`npm run fetch-upstream`**: Syncs assets from the upstream `github/awesome-copilot` repository (requires configuration).
168
+ - `npm run generate-manifest` - Generate `assets-manifest.json` (required before PRs)
169
+ - `npm run analyze` - Analyze collections with TF-IDF/Cosine Similarity
170
+ - `npm run analyze -- --add` - Auto-add high-confidence matches
171
+ - `npm run analyze -- --remove` - Remove low-confidence items
172
+ - `npm run fetch-upstream` - Sync from upstream repository
179
173
 
180
- ### Migration from `.chatmode.md` to `.agent.md`
174
+ ### Local Testing
181
175
 
182
- This project has migrated from the legacy `.chatmode.md` extension to the new `.agent.md` convention, with agents now stored in `assets/agents/`.
176
+ Use Verdaccio for end-to-end testing:
183
177
 
184
- **For existing users:**
178
+ ```bash
179
+ # Terminal 1: Start local registry
180
+ npm run start:registry
185
181
 
186
- If you have existing `.chatmode.md` files in your projects, you can migrate them using this command:
182
+ # Terminal 2: Publish and test
183
+ npm run publish:local
184
+ npx --registry http://localhost:4873 workspace-architect list
185
+ ```
186
+
187
+ ## Project Structure
188
+
189
+ ```
190
+ workspace-architect/
191
+ ├── assets/
192
+ │ ├── agents/ # Agent definitions (.agent.md)
193
+ │ ├── collections/ # Collection definitions (.json)
194
+ │ ├── instructions/ # Copilot instructions (.md)
195
+ │ └── prompts/ # Reusable prompts (.md)
196
+ ├── bin/
197
+ │ └── cli.js # CLI entry point
198
+ └── scripts/ # Maintenance utilities
199
+ ```
200
+
201
+ ## Migration Guide
202
+
203
+ Migrating from `.chatmode.md` to `.agent.md`? Run:
187
204
 
188
205
  ```bash
189
206
  mkdir -p assets/agents
190
207
  find . -name '*.chatmode.md' -exec bash -c 'mv "$1" "assets/agents/$(basename \"$1\" .chatmode.md).agent.md"' -- {} \;
191
208
  ```
192
209
 
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. This repository stores agents in `assets/agents/` for distribution, and the CLI downloads them to `.github/agents/` in your project by default.
210
+ ## License
211
+
212
+ ISC
213
+
214
+ ## Links
215
+
216
+ - [npm Package](https://www.npmjs.com/package/workspace-architect)
217
+ - [GitHub Repository](https://github.com/archubbuck/workspace-architect)
218
+ - [Issue Tracker](https://github.com/archubbuck/workspace-architect/issues)
219
+ - [Roadmap](ROADMAP.md)
package/assets-manifest.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "version": "1.0.0",
3
- "generatedAt": "2025-12-13T23:02:09.741Z",
3
+ "generatedAt": "2025-12-14T17:45:13.723Z",
4
4
  "assets": {
5
5
  "agents:4.1-Beast": {
6
6
  "path": "assets/agents/4.1-Beast.agent.md",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "workspace-architect",
3
- "version": "1.5.14",
3
+ "version": "1.5.15",
4
4
  "description": "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.",
5
5
  "bin": {
6
6
  "workspace-architect": "./bin/cli.js"