arreio 1.0.2 → 1.0.3
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 +2 -2
- package/package.json +1 -1
- package/scripts/postinstall.js +2 -3
- package/skills/arreio-init/SKILL.md +11 -11
- package/skills/arreio-init/modules/install.md +26 -22
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ Install Arreio as a dependency to enable all skills in your workspace:
|
|
|
12
12
|
npm install arreio
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
The post-install script will automatically copy all Arreio skills to your
|
|
15
|
+
The post-install script will automatically copy all Arreio skills to your project's `.agents/skills/` directory, making them available in VS Code Copilot Chat. (Note: npm may show an advisory about unallowed install scripts—this is informational and won't block the installation.)
|
|
16
16
|
|
|
17
17
|
Then initialize your project to set up the Arreio folder structure and documentation:
|
|
18
18
|
|
|
@@ -22,7 +22,7 @@ Then initialize your project to set up the Arreio folder structure and documenta
|
|
|
22
22
|
|
|
23
23
|
Run this command in VS Code Copilot Chat to:
|
|
24
24
|
|
|
25
|
-
1. Verify or manually install Arreio skills to
|
|
25
|
+
1. Verify or manually install Arreio skills to `.agents/skills/` (if postinstall was skipped)
|
|
26
26
|
2. Create the project structure (`docs/plans/`, `docs/learn/`, etc.)
|
|
27
27
|
3. Set up architectural documentation and index files
|
|
28
28
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "arreio",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Arreio transforms agentic coding workflows into a predictable, safe, and high-quality software delivery pipeline. Master the four core phases—Plan, Work, Review, Learn—to orchestrate a highly reliable development cycle.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Wicttor",
|
package/scripts/postinstall.js
CHANGED
|
@@ -2,17 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Post-install script for arreio
|
|
5
|
-
* Copies skills from the package to the
|
|
5
|
+
* Copies skills from the package to the project's .agents/skills directory
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
const fs = require('fs');
|
|
9
9
|
const path = require('path');
|
|
10
|
-
const os = require('os');
|
|
11
10
|
|
|
12
11
|
// Determine the source and destination paths
|
|
13
12
|
const packageDir = path.dirname(__dirname);
|
|
14
13
|
const skillsSource = path.join(packageDir, 'skills');
|
|
15
|
-
const agentsDir = path.join(
|
|
14
|
+
const agentsDir = path.join(process.cwd(), '.agents');
|
|
16
15
|
const skillsDestination = path.join(agentsDir, 'skills');
|
|
17
16
|
|
|
18
17
|
// Function to recursively copy directories
|
|
@@ -35,16 +35,16 @@ After initialization, the following modules can operate:
|
|
|
35
35
|
|
|
36
36
|
The initialization workflow runs in two phases:
|
|
37
37
|
|
|
38
|
-
1. **Phase 0: Install Skills (Optional)** — Verify or manually copy Arreio skills to
|
|
38
|
+
1. **Phase 0: Install Skills (Optional)** — Verify or manually copy Arreio skills to `.agents/skills/` in the project (skills are normally installed via npm postinstall, but this phase can install them as a fallback)
|
|
39
39
|
2. **Phase 1: Initialize Project Structure** — Create folders, indexes, and architectural documentation
|
|
40
40
|
|
|
41
41
|
### Step 1: Install Skills (Optional Fallback)
|
|
42
42
|
|
|
43
|
-
Verify that Arreio skills are installed to the
|
|
43
|
+
Verify that Arreio skills are installed to the project's `.agents/skills/` directory. See [modules/install.md](modules/install.md) for detailed instructions.
|
|
44
44
|
|
|
45
|
-
**Why:** Skills must be available in
|
|
45
|
+
**Why:** Skills must be available in `.agents/skills/` for VS Code Copilot Chat discovery. Normally, the npm postinstall script handles this automatically when you run `npm install arreio`. This step provides a manual fallback if postinstall was skipped.
|
|
46
46
|
|
|
47
|
-
**When to run:** Skip this step if npm postinstall has already run. If skills are not yet installed, this phase will copy them from `node_modules/arreio/skills/` to
|
|
47
|
+
**When to run:** Skip this step if npm postinstall has already run. If skills are not yet installed, this phase will copy them from `node_modules/arreio/skills/` to `.agents/skills/`.
|
|
48
48
|
|
|
49
49
|
**Action:** See [install.md](modules/install.md) for verification and manual installation steps.
|
|
50
50
|
|
|
@@ -201,13 +201,13 @@ _No review reports yet._
|
|
|
201
201
|
|
|
202
202
|
After initialization, verify:
|
|
203
203
|
|
|
204
|
-
- ✓ All Arreio skills are installed to
|
|
205
|
-
-
|
|
206
|
-
-
|
|
207
|
-
-
|
|
208
|
-
-
|
|
209
|
-
-
|
|
210
|
-
-
|
|
204
|
+
- ✓ All Arreio skills are installed to `.agents/skills/`:
|
|
205
|
+
- `.agents/skills/plan/`
|
|
206
|
+
- `.agents/skills/work/`
|
|
207
|
+
- `.agents/skills/review/`
|
|
208
|
+
- `.agents/skills/learn/`
|
|
209
|
+
- `.agents/skills/end-session/`
|
|
210
|
+
- `.agents/skills/arreio-init/`
|
|
211
211
|
- ✓ All five core folders exist: `docs/plans/`, `docs/learn/`, `docs/reports/`, `docs/tasks/`, `docs/archives/`
|
|
212
212
|
- ✓ `ARCHITECTURE.md` exists at project root
|
|
213
213
|
- ✓ Root-level index files exist:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Install Skills
|
|
3
|
-
description: Verify or manually install Arreio skills to the
|
|
3
|
+
description: Verify or manually install Arreio skills to the project's .agents/skills directory, providing a fallback if npm postinstall was skipped.
|
|
4
4
|
type: module
|
|
5
5
|
version: 1.0
|
|
6
6
|
timestamp: "2026-09-01"
|
|
@@ -8,7 +8,7 @@ timestamp: "2026-09-01"
|
|
|
8
8
|
|
|
9
9
|
# Phase 0 - Install Skills (Fallback)
|
|
10
10
|
|
|
11
|
-
**Purpose:** Verify that Arreio skills are installed to the
|
|
11
|
+
**Purpose:** Verify that Arreio skills are installed to the project's `.agents/skills/` directory, making them available for discovery and invocation in VS Code Copilot Chat. This is normally handled by the npm postinstall script, but this phase provides a manual fallback if postinstall was skipped or if users need to reinstall skills.
|
|
12
12
|
|
|
13
13
|
## Workflow
|
|
14
14
|
|
|
@@ -18,7 +18,7 @@ This is the Phase 0 pipeline for the Arreio Init Skill. It performs verification
|
|
|
18
18
|
|
|
19
19
|
First, verify that Arreio skills are already available:
|
|
20
20
|
|
|
21
|
-
1. Check if
|
|
21
|
+
1. Check if `.agents/skills/` directory exists in the project and contains the expected skill folders (plan, work, review, learn, end-session, arreio-init).
|
|
22
22
|
2. If all skills are present and current, log success and skip to project structure initialization (Step 2).
|
|
23
23
|
3. If skills are missing or incomplete, proceed to Step 2.
|
|
24
24
|
|
|
@@ -35,25 +35,29 @@ Verify that the prerequisites are met if skills need to be installed:
|
|
|
35
35
|
|
|
36
36
|
1. Arreio is installed as an npm package in the current project (`node_modules/arreio/` exists).
|
|
37
37
|
2. The skills directory exists in the package: `node_modules/arreio/skills/` contains subdirectories for each skill.
|
|
38
|
-
3. The
|
|
38
|
+
3. The project directory is writable (required to create `.agents/skills/`).
|
|
39
39
|
|
|
40
40
|
If any verification fails:
|
|
41
41
|
|
|
42
42
|
- **Missing package:** Suggest running `npm install arreio` first.
|
|
43
43
|
- **Missing skills:** Report a package integrity error (the skills/ directory is missing from the installed package).
|
|
44
|
-
- **No
|
|
44
|
+
- **No write access:** Report an environment error (unable to write to project directory).
|
|
45
45
|
|
|
46
46
|
### Step 3: Create Target Directory
|
|
47
47
|
|
|
48
48
|
Create the destination directory hierarchy:
|
|
49
49
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
50
|
+
### Step 3: Create Target Directory
|
|
51
|
+
|
|
52
|
+
Create the destination directory hierarchy:
|
|
53
|
+
|
|
54
|
+
1. If `.agents/` does not exist, create it.
|
|
55
|
+
2. If `.agents/skills/` does not exist, create it.
|
|
56
|
+
3. Log: `✓ Created .agents/skills/`
|
|
53
57
|
|
|
54
58
|
### Step 4: Copy Skills from Package
|
|
55
59
|
|
|
56
|
-
Copy each skill directory from `node_modules/arreio/skills/` to
|
|
60
|
+
Copy each skill directory from `node_modules/arreio/skills/` to `.agents/skills/`:
|
|
57
61
|
|
|
58
62
|
**Skills to copy:**
|
|
59
63
|
|
|
@@ -69,7 +73,7 @@ Copy each skill directory from `node_modules/arreio/skills/` to `~/.agents/skill
|
|
|
69
73
|
For each skill:
|
|
70
74
|
|
|
71
75
|
1. Read the source directory: `node_modules/arreio/skills/<skill-name>/`
|
|
72
|
-
2. Copy recursively to destination:
|
|
76
|
+
2. Copy recursively to destination: `.agents/skills/<skill-name>/`
|
|
73
77
|
3. Verify the destination directory was created and contains the expected files (`SKILL.md`, `modules/`, `references/`).
|
|
74
78
|
4. Log: `✓ Copied <skill-name>`
|
|
75
79
|
|
|
@@ -85,7 +89,7 @@ After all skills are copied, verify that the expected skill files are present:
|
|
|
85
89
|
|
|
86
90
|
For each skill, check:
|
|
87
91
|
|
|
88
|
-
-
|
|
92
|
+
- `.agents/skills/<skill-name>/SKILL.md` exists
|
|
89
93
|
- Directory structure is intact (modules/, references/ subdirs if present)
|
|
90
94
|
|
|
91
95
|
If verification passes, log:
|
|
@@ -124,14 +128,14 @@ You can now use:
|
|
|
124
128
|
|
|
125
129
|
After this phase completes:
|
|
126
130
|
|
|
127
|
-
- ✓
|
|
128
|
-
- ✓ All six skills are copied to
|
|
129
|
-
-
|
|
130
|
-
-
|
|
131
|
-
-
|
|
132
|
-
-
|
|
133
|
-
-
|
|
134
|
-
-
|
|
131
|
+
- ✓ `.agents/skills/` directory exists in the project
|
|
132
|
+
- ✓ All six skills are copied to `.agents/skills/`:
|
|
133
|
+
- `.agents/skills/plan/`
|
|
134
|
+
- `.agents/skills/work/`
|
|
135
|
+
- `.agents/skills/review/`
|
|
136
|
+
- `.agents/skills/learn/`
|
|
137
|
+
- `.agents/skills/end-session/`
|
|
138
|
+
- `.agents/skills/arreio-init/`
|
|
135
139
|
- ✓ Each skill directory contains `SKILL.md` and expected subdirectories
|
|
136
140
|
- ✓ Skills are ready for discovery by VS Code Copilot Chat
|
|
137
141
|
|
|
@@ -141,11 +145,11 @@ Refer to [error-handling.md](../references/error-handling.md) for category class
|
|
|
141
145
|
|
|
142
146
|
- **Category 1 (Missing context):** Arreio package not installed; suggest `npm install arreio`.
|
|
143
147
|
- **Category 2 (Routing error):** Skills directory missing from package; report package integrity issue.
|
|
144
|
-
- **Category 3 (Environment issue):** Cannot write to
|
|
148
|
+
- **Category 3 (Environment issue):** Cannot write to project `.agents/` directory; insufficient permissions.
|
|
145
149
|
|
|
146
150
|
## Notes
|
|
147
151
|
|
|
148
152
|
- This phase runs **before** project structure initialization (Phase 1 → Create Core Folders).
|
|
149
|
-
- Skills are copied to the
|
|
150
|
-
- The copy is non-destructive; if skills already exist in
|
|
153
|
+
- Skills are copied to the project's `.agents/` directory, keeping them scoped to the project. Each project gets its own copy of skills.
|
|
154
|
+
- The copy is non-destructive; if skills already exist in `.agents/skills/`, they are overwritten with the latest version from the installed package. This supports package updates.
|
|
151
155
|
- This phase is idempotent; running it multiple times produces the same result.
|