arreio 1.0.0 → 1.0.1-dev.0
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 +1 -13
- package/package.json +5 -1
- package/scripts/postinstall.js +50 -0
- package/skills/arreio-init/SKILL.md +12 -32
- package/skills/arreio-init/modules/install.md +0 -136
package/README.md
CHANGED
|
@@ -17,19 +17,7 @@ Install Arreio as a dependency to enable all skills in your workspace:
|
|
|
17
17
|
npm install arreio
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
```
|
|
23
|
-
/arreio-init
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
Run this command in VS Code Copilot Chat to:
|
|
27
|
-
|
|
28
|
-
1. Copy all Arreio skills to your `~/.agents/skills/` directory
|
|
29
|
-
2. Create the project structure (`docs/plans/`, `docs/learn/`, etc.)
|
|
30
|
-
3. Set up architectural documentation and index files
|
|
31
|
-
|
|
32
|
-
This makes all five core skills available in your AI development environment:
|
|
20
|
+
The post-install script will automatically copy all Arreio skills to your `.agents/skills` directory. This makes all four core skills available in your AI development environment:
|
|
33
21
|
|
|
34
22
|
- **arreio-init** - Initialize projects to follow the Arreio workflow
|
|
35
23
|
- **plan** - Structure and decompose work into executable tasks
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "arreio",
|
|
3
|
-
"version": "1.0.0",
|
|
3
|
+
"version": "1.0.1-dev.0",
|
|
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",
|
|
@@ -27,8 +27,12 @@
|
|
|
27
27
|
"main": "README.md",
|
|
28
28
|
"files": [
|
|
29
29
|
"skills/",
|
|
30
|
+
"scripts/",
|
|
30
31
|
"README.md"
|
|
31
32
|
],
|
|
33
|
+
"scripts": {
|
|
34
|
+
"postinstall": "node scripts/postinstall.js"
|
|
35
|
+
},
|
|
32
36
|
"engines": {
|
|
33
37
|
"node": ">=14.0.0"
|
|
34
38
|
},
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Post-install script for arreio
|
|
5
|
+
* Copies skills from the package to the user's .agents/skills directory
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
const fs = require('fs');
|
|
9
|
+
const path = require('path');
|
|
10
|
+
const os = require('os');
|
|
11
|
+
|
|
12
|
+
// Determine the source and destination paths
|
|
13
|
+
const packageDir = path.dirname(__dirname);
|
|
14
|
+
const skillsSource = path.join(packageDir, 'skills');
|
|
15
|
+
const agentsDir = path.join(os.homedir(), '.agents');
|
|
16
|
+
const skillsDestination = path.join(agentsDir, 'skills');
|
|
17
|
+
|
|
18
|
+
// Function to recursively copy directories
|
|
19
|
+
function copyDirectory(src, dest) {
|
|
20
|
+
if (!fs.existsSync(dest)) {
|
|
21
|
+
fs.mkdirSync(dest, { recursive: true });
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const files = fs.readdirSync(src);
|
|
25
|
+
files.forEach(file => {
|
|
26
|
+
const srcFile = path.join(src, file);
|
|
27
|
+
const destFile = path.join(dest, file);
|
|
28
|
+
const stat = fs.statSync(srcFile);
|
|
29
|
+
|
|
30
|
+
if (stat.isDirectory()) {
|
|
31
|
+
copyDirectory(srcFile, destFile);
|
|
32
|
+
} else {
|
|
33
|
+
fs.copyFileSync(srcFile, destFile);
|
|
34
|
+
}
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
try {
|
|
39
|
+
// Create .agents directory if it doesn't exist
|
|
40
|
+
if (!fs.existsSync(agentsDir)) {
|
|
41
|
+
fs.mkdirSync(agentsDir, { recursive: true });
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// Copy skills to .agents/skills
|
|
45
|
+
copyDirectory(skillsSource, skillsDestination);
|
|
46
|
+
console.log(`✓ Arreio skills installed to ${skillsDestination}`);
|
|
47
|
+
} catch (error) {
|
|
48
|
+
console.error(`✗ Failed to install Arreio skills: ${error.message}`);
|
|
49
|
+
process.exit(1);
|
|
50
|
+
}
|
|
@@ -33,20 +33,7 @@ After initialization, the following modules can operate:
|
|
|
33
33
|
|
|
34
34
|
## Workflow
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
1. **Phase 0: Install Skills** — Copy Arreio skills to `~/.agents/skills/` for VS Code Copilot Chat discovery
|
|
39
|
-
2. **Phase 1: Initialize Project Structure** — Create folders, indexes, and architectural documentation
|
|
40
|
-
|
|
41
|
-
### Step 1: Install Skills
|
|
42
|
-
|
|
43
|
-
Install Arreio skills to the user's `.agents/skills` directory. See [modules/install.md](modules/install.md) for detailed instructions.
|
|
44
|
-
|
|
45
|
-
**Why:** Skills must be copied from the installed npm package to the user's home directory so they are discoverable by VS Code Copilot Chat. This step must run first, before project structure is created.
|
|
46
|
-
|
|
47
|
-
**Action:** Execute the [install.md](modules/install.md) phase to copy all skills from `node_modules/arreio/skills/` to `~/.agents/skills/`.
|
|
48
|
-
|
|
49
|
-
### Step 2: Create Core Folder Structure
|
|
36
|
+
### Step 1: Create Core Folder Structure
|
|
50
37
|
|
|
51
38
|
Creates the organizational spine for Arreio artifacts:
|
|
52
39
|
|
|
@@ -58,7 +45,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
58
45
|
|
|
59
46
|
**Why:** Downstream skills assume these folders exist and will create files within them.
|
|
60
47
|
|
|
61
|
-
### Step
|
|
48
|
+
### Step 2: Initialize Root Architecture Document
|
|
62
49
|
|
|
63
50
|
**File:** `ARCHITECTURE.md` (project root)
|
|
64
51
|
|
|
@@ -66,7 +53,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
66
53
|
|
|
67
54
|
**Action:** If `ARCHITECTURE.md` doesn't exist, create it using the [Architecture Template](references/architecture-template.md).
|
|
68
55
|
|
|
69
|
-
### Step
|
|
56
|
+
### Step 3: Initialize Plans Index
|
|
70
57
|
|
|
71
58
|
**File:** `docs/plans/index.md`
|
|
72
59
|
|
|
@@ -74,7 +61,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
74
61
|
|
|
75
62
|
**Action:** If `docs/plans/index.md` doesn't exist, create it using the [Plan Index Template](references/plan-index-template.md).
|
|
76
63
|
|
|
77
|
-
### Step
|
|
64
|
+
### Step 4: Create Tasks Folder
|
|
78
65
|
|
|
79
66
|
**Folder:** `docs/tasks/`
|
|
80
67
|
|
|
@@ -82,7 +69,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
82
69
|
|
|
83
70
|
**Action:** Create the `docs/tasks/` folder if it doesn't exist.
|
|
84
71
|
|
|
85
|
-
### Step
|
|
72
|
+
### Step 5: Initialize Learning Index
|
|
86
73
|
|
|
87
74
|
**File:** `docs/learn/index.md`
|
|
88
75
|
|
|
@@ -90,7 +77,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
90
77
|
|
|
91
78
|
**Action:** If `docs/learn/index.md` doesn't exist, create it using the [Learn Index Template](references/learn-index-template.md).
|
|
92
79
|
|
|
93
|
-
### Step
|
|
80
|
+
### Step 6: Create Reports Folder
|
|
94
81
|
|
|
95
82
|
**Folder:** `docs/reports/`
|
|
96
83
|
|
|
@@ -98,7 +85,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
98
85
|
|
|
99
86
|
**Action:** Create the `docs/reports/` folder if it doesn't exist.
|
|
100
87
|
|
|
101
|
-
### Step
|
|
88
|
+
### Step 7: Create Plan Skill Hidden Artifact Directories
|
|
102
89
|
|
|
103
90
|
**Folders:**
|
|
104
91
|
|
|
@@ -110,7 +97,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
110
97
|
|
|
111
98
|
**Action:** Create all three directories if they don't exist.
|
|
112
99
|
|
|
113
|
-
### Step
|
|
100
|
+
### Step 8: Create Work Skill Hidden Artifact Directories
|
|
114
101
|
|
|
115
102
|
**Folders:**
|
|
116
103
|
|
|
@@ -123,7 +110,7 @@ Creates the organizational spine for Arreio artifacts:
|
|
|
123
110
|
|
|
124
111
|
**Action:** Create all four directories if they don't exist.
|
|
125
112
|
|
|
126
|
-
### Step
|
|
113
|
+
### Step 9: Create Review Skill Hidden Artifact Directories and Registry
|
|
127
114
|
|
|
128
115
|
**Folders:**
|
|
129
116
|
|
|
@@ -159,7 +146,7 @@ This is the index of all review reports for the project. Reports are organized b
|
|
|
159
146
|
_No review reports yet._
|
|
160
147
|
```
|
|
161
148
|
|
|
162
|
-
### Step
|
|
149
|
+
### Step 10: Create Learn Skill Hidden Artifact Directories
|
|
163
150
|
|
|
164
151
|
**Folders:**
|
|
165
152
|
|
|
@@ -172,7 +159,7 @@ _No review reports yet._
|
|
|
172
159
|
|
|
173
160
|
**Action:** Create all four directories if they don't exist.
|
|
174
161
|
|
|
175
|
-
### Step
|
|
162
|
+
### Step 11: Create End-Session Skill Hidden Artifact Directory
|
|
176
163
|
|
|
177
164
|
**Folder:**
|
|
178
165
|
|
|
@@ -182,7 +169,7 @@ _No review reports yet._
|
|
|
182
169
|
|
|
183
170
|
**Action:** Create the directory if it doesn't exist.
|
|
184
171
|
|
|
185
|
-
### Step
|
|
172
|
+
### Step 12: Create Learn Category Folders
|
|
186
173
|
|
|
187
174
|
**Folders:**
|
|
188
175
|
|
|
@@ -199,13 +186,6 @@ _No review reports yet._
|
|
|
199
186
|
|
|
200
187
|
After initialization, verify:
|
|
201
188
|
|
|
202
|
-
- ✓ All Arreio skills are installed to `~/.agents/skills/`:
|
|
203
|
-
- `~/.agents/skills/plan/`
|
|
204
|
-
- `~/.agents/skills/work/`
|
|
205
|
-
- `~/.agents/skills/review/`
|
|
206
|
-
- `~/.agents/skills/learn/`
|
|
207
|
-
- `~/.agents/skills/end-session/`
|
|
208
|
-
- `~/.agents/skills/arreio-init/`
|
|
209
189
|
- ✓ All five core folders exist: `docs/plans/`, `docs/learn/`, `docs/reports/`, `docs/tasks/`, `docs/archives/`
|
|
210
190
|
- ✓ `ARCHITECTURE.md` exists at project root
|
|
211
191
|
- ✓ Root-level index files exist:
|
|
@@ -1,136 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Install Skills
|
|
3
|
-
description: Install Arreio skills to the user's .agents/skills directory, making them available in VS Code Copilot Chat.
|
|
4
|
-
type: module
|
|
5
|
-
version: 1.0
|
|
6
|
-
timestamp: "2026-09-01"
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Phase 0 - Install Skills
|
|
10
|
-
|
|
11
|
-
**Purpose:** Copy Arreio skills from the installed npm package to the user's `~/.agents/skills/` directory, making them available for discovery and invocation in VS Code Copilot Chat. This ensures all Arreio workflows (plan, work, review, learn, end-session) are accessible after initialization.
|
|
12
|
-
|
|
13
|
-
## Workflow
|
|
14
|
-
|
|
15
|
-
This is the Phase 0 pipeline for the Arreio Init Skill. It orchestrates the following steps before creating project structure.
|
|
16
|
-
|
|
17
|
-
### Step 1: Verify Installation Context
|
|
18
|
-
|
|
19
|
-
Verify that the prerequisites are met:
|
|
20
|
-
|
|
21
|
-
1. Arreio is installed as an npm package in the current project (`node_modules/arreio/` exists).
|
|
22
|
-
2. The skills directory exists in the package: `node_modules/arreio/skills/` contains subdirectories for each skill.
|
|
23
|
-
3. The user's home directory is accessible (required to create `~/.agents/skills/`).
|
|
24
|
-
|
|
25
|
-
If any verification fails:
|
|
26
|
-
|
|
27
|
-
- **Missing package:** Suggest running `npm install arreio` first.
|
|
28
|
-
- **Missing skills:** Report a package integrity error (the skills/ directory is missing from the installed package).
|
|
29
|
-
- **No home access:** Report an environment error (unable to determine home directory).
|
|
30
|
-
|
|
31
|
-
### Step 2: Create Target Directory
|
|
32
|
-
|
|
33
|
-
Create the destination directory hierarchy:
|
|
34
|
-
|
|
35
|
-
1. If `~/.agents/` does not exist, create it.
|
|
36
|
-
2. If `~/.agents/skills/` does not exist, create it.
|
|
37
|
-
3. Log: `✓ Created ~/.agents/skills/`
|
|
38
|
-
|
|
39
|
-
### Step 3: Copy Skills from Package
|
|
40
|
-
|
|
41
|
-
Copy each skill directory from `node_modules/arreio/skills/` to `~/.agents/skills/`:
|
|
42
|
-
|
|
43
|
-
**Skills to copy:**
|
|
44
|
-
|
|
45
|
-
- `plan` — Planning and decomposition
|
|
46
|
-
- `work` — Task execution with guardrails
|
|
47
|
-
- `review` — Code review and analysis
|
|
48
|
-
- `learn` — Knowledge capture and indexing
|
|
49
|
-
- `end-session` — Session documentation
|
|
50
|
-
- `arreio-init` — Workspace initialization (this skill itself, for re-runs)
|
|
51
|
-
|
|
52
|
-
**Copy algorithm:**
|
|
53
|
-
|
|
54
|
-
For each skill:
|
|
55
|
-
|
|
56
|
-
1. Read the source directory: `node_modules/arreio/skills/<skill-name>/`
|
|
57
|
-
2. Copy recursively to destination: `~/.agents/skills/<skill-name>/`
|
|
58
|
-
3. Verify the destination directory was created and contains the expected files (`SKILL.md`, `modules/`, `references/`).
|
|
59
|
-
4. Log: `✓ Copied <skill-name>`
|
|
60
|
-
|
|
61
|
-
If any copy operation fails:
|
|
62
|
-
|
|
63
|
-
- Log the error and the source/destination paths.
|
|
64
|
-
- Ask the user to manually verify the source exists and the destination is writable.
|
|
65
|
-
- Do not proceed to the next phase.
|
|
66
|
-
|
|
67
|
-
### Step 4: Verify Installation Success
|
|
68
|
-
|
|
69
|
-
After all skills are copied, verify that the expected skill files are present:
|
|
70
|
-
|
|
71
|
-
For each skill, check:
|
|
72
|
-
|
|
73
|
-
- `~/.agents/skills/<skill-name>/SKILL.md` exists
|
|
74
|
-
- Directory structure is intact (modules/, references/ subdirs if present)
|
|
75
|
-
|
|
76
|
-
If verification passes, log:
|
|
77
|
-
|
|
78
|
-
```
|
|
79
|
-
✓ Arreio skills installed successfully
|
|
80
|
-
- plan
|
|
81
|
-
- work
|
|
82
|
-
- review
|
|
83
|
-
- learn
|
|
84
|
-
- end-session
|
|
85
|
-
- arreio-init
|
|
86
|
-
|
|
87
|
-
Skills are now available in VS Code Copilot Chat.
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
If verification fails for any skill, report which skills failed and suggest manual verification.
|
|
91
|
-
|
|
92
|
-
### Step 5: Log Installation Summary
|
|
93
|
-
|
|
94
|
-
Provide the user with confirmation and next steps:
|
|
95
|
-
|
|
96
|
-
```
|
|
97
|
-
Installation complete. Arreio skills are now available:
|
|
98
|
-
|
|
99
|
-
Next step: Project structure will be initialized in Step 1 of arreio-init.
|
|
100
|
-
|
|
101
|
-
You can now use:
|
|
102
|
-
/plan — Create implementation plans
|
|
103
|
-
/work — Execute tasks with guardrails
|
|
104
|
-
/review — Conduct code reviews
|
|
105
|
-
/learn — Capture and organize knowledge
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
## Success Criteria
|
|
109
|
-
|
|
110
|
-
After this phase completes:
|
|
111
|
-
|
|
112
|
-
- ✓ `~/.agents/skills/` directory exists
|
|
113
|
-
- ✓ All six skills are copied to `~/.agents/skills/`:
|
|
114
|
-
- `~/.agents/skills/plan/`
|
|
115
|
-
- `~/.agents/skills/work/`
|
|
116
|
-
- `~/.agents/skills/review/`
|
|
117
|
-
- `~/.agents/skills/learn/`
|
|
118
|
-
- `~/.agents/skills/end-session/`
|
|
119
|
-
- `~/.agents/skills/arreio-init/`
|
|
120
|
-
- ✓ Each skill directory contains `SKILL.md` and expected subdirectories
|
|
121
|
-
- ✓ Skills are ready for discovery by VS Code Copilot Chat
|
|
122
|
-
|
|
123
|
-
## Error Handling
|
|
124
|
-
|
|
125
|
-
Refer to [error-handling.md](../references/error-handling.md) for category classification and resolution strategies. Common errors:
|
|
126
|
-
|
|
127
|
-
- **Category 1 (Missing context):** Arreio package not installed; suggest `npm install arreio`.
|
|
128
|
-
- **Category 2 (Routing error):** Skills directory missing from package; report package integrity issue.
|
|
129
|
-
- **Category 3 (Environment issue):** Cannot write to `~/.agents/`; insufficient permissions or home dir unavailable.
|
|
130
|
-
|
|
131
|
-
## Notes
|
|
132
|
-
|
|
133
|
-
- This phase runs **before** project structure initialization (Phase 1 → Create Core Folders).
|
|
134
|
-
- Skills are copied to the user's home directory (`~/.agents/`), not the project directory. This allows skills to be reused across all projects once installed.
|
|
135
|
-
- 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.
|
|
136
|
-
- This phase is idempotent; running it multiple times produces the same result.
|