arreio 1.0.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 +4 -2
- package/package.json +5 -1
- package/scripts/postinstall.js +50 -0
- package/skills/arreio-init/SKILL.md +7 -5
- package/skills/arreio-init/modules/install.md +26 -11
package/README.md
CHANGED
|
@@ -17,7 +17,9 @@ Install Arreio as a dependency to enable all skills in your workspace:
|
|
|
17
17
|
npm install arreio
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
|
|
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:
|
|
21
23
|
|
|
22
24
|
```
|
|
23
25
|
/arreio-init
|
|
@@ -25,7 +27,7 @@ Then initialize your project to set up Arreio workflows:
|
|
|
25
27
|
|
|
26
28
|
Run this command in VS Code Copilot Chat to:
|
|
27
29
|
|
|
28
|
-
1.
|
|
30
|
+
1. Verify or manually install Arreio skills to `~/.agents/skills/` (if postinstall was skipped)
|
|
29
31
|
2. Create the project structure (`docs/plans/`, `docs/learn/`, etc.)
|
|
30
32
|
3. Set up architectural documentation and index files
|
|
31
33
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "arreio",
|
|
3
|
-
"version": "1.0.
|
|
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",
|
|
@@ -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
|
+
}
|
|
@@ -35,16 +35,18 @@ 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** —
|
|
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
39
|
2. **Phase 1: Initialize Project Structure** — Create folders, indexes, and architectural documentation
|
|
40
40
|
|
|
41
|
-
### Step 1: Install Skills
|
|
41
|
+
### Step 1: Install Skills (Optional Fallback)
|
|
42
42
|
|
|
43
|
-
|
|
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
44
|
|
|
45
|
-
**Why:** Skills must be
|
|
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
|
-
**
|
|
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.
|
|
48
50
|
|
|
49
51
|
### Step 2: Create Core Folder Structure
|
|
50
52
|
|
|
@@ -1,22 +1,37 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Install Skills
|
|
3
|
-
description:
|
|
3
|
+
description: Verify or manually install Arreio skills to the user'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"
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
# Phase 0 - Install Skills
|
|
9
|
+
# Phase 0 - Install Skills (Fallback)
|
|
10
10
|
|
|
11
|
-
**Purpose:**
|
|
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
12
|
|
|
13
13
|
## Workflow
|
|
14
14
|
|
|
15
|
-
This is the Phase 0 pipeline for the Arreio Init Skill. It
|
|
15
|
+
This is the Phase 0 pipeline for the Arreio Init Skill. It performs verification and optional installation before creating project structure.
|
|
16
16
|
|
|
17
|
-
### Step 1:
|
|
17
|
+
### Step 1: Check if Skills Already Installed
|
|
18
18
|
|
|
19
|
-
|
|
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:
|
|
20
35
|
|
|
21
36
|
1. Arreio is installed as an npm package in the current project (`node_modules/arreio/` exists).
|
|
22
37
|
2. The skills directory exists in the package: `node_modules/arreio/skills/` contains subdirectories for each skill.
|
|
@@ -28,7 +43,7 @@ If any verification fails:
|
|
|
28
43
|
- **Missing skills:** Report a package integrity error (the skills/ directory is missing from the installed package).
|
|
29
44
|
- **No home access:** Report an environment error (unable to determine home directory).
|
|
30
45
|
|
|
31
|
-
### Step
|
|
46
|
+
### Step 3: Create Target Directory
|
|
32
47
|
|
|
33
48
|
Create the destination directory hierarchy:
|
|
34
49
|
|
|
@@ -36,7 +51,7 @@ Create the destination directory hierarchy:
|
|
|
36
51
|
2. If `~/.agents/skills/` does not exist, create it.
|
|
37
52
|
3. Log: `✓ Created ~/.agents/skills/`
|
|
38
53
|
|
|
39
|
-
### Step
|
|
54
|
+
### Step 4: Copy Skills from Package
|
|
40
55
|
|
|
41
56
|
Copy each skill directory from `node_modules/arreio/skills/` to `~/.agents/skills/`:
|
|
42
57
|
|
|
@@ -64,7 +79,7 @@ If any copy operation fails:
|
|
|
64
79
|
- Ask the user to manually verify the source exists and the destination is writable.
|
|
65
80
|
- Do not proceed to the next phase.
|
|
66
81
|
|
|
67
|
-
### Step
|
|
82
|
+
### Step 5: Verify Installation Success
|
|
68
83
|
|
|
69
84
|
After all skills are copied, verify that the expected skill files are present:
|
|
70
85
|
|
|
@@ -89,14 +104,14 @@ Skills are now available in VS Code Copilot Chat.
|
|
|
89
104
|
|
|
90
105
|
If verification fails for any skill, report which skills failed and suggest manual verification.
|
|
91
106
|
|
|
92
|
-
### Step
|
|
107
|
+
### Step 6: Log Installation Summary
|
|
93
108
|
|
|
94
109
|
Provide the user with confirmation and next steps:
|
|
95
110
|
|
|
96
111
|
```
|
|
97
112
|
Installation complete. Arreio skills are now available:
|
|
98
113
|
|
|
99
|
-
Next step: Project structure will be initialized in
|
|
114
|
+
Next step: Project structure will be initialized in the next phase of arreio-init.
|
|
100
115
|
|
|
101
116
|
You can now use:
|
|
102
117
|
/plan — Create implementation plans
|