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