template-instructions 1.1.1 → 1.1.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 +16 -15
- package/bin/cli.js +2 -2
- package/package.json +4 -1
- /package/{instructions → .gemini/instructions}/global.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/designer.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/dev.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/devops.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/pm.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/po.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/qa.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/reporter.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/sa.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/seca.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/stakeholder.md +0 -0
- /package/{instructions → .gemini/instructions}/roles/tester.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Backend-Design-Spec-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Design-Verification-Report-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/DevOps-Plan-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Development-Log-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Final-Approval-Report-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Phase-Report-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Product-Backlog-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Project-Plan-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Security-Review-Report-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/Test-Report-Template.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/definition-of-done.md +0 -0
- /package/{instructions → .gemini/instructions}/templates/incident-response.md +0 -0
- /package/{instructions → .gemini/instructions}/usage.md +0 -0
package/README.md
CHANGED
|
@@ -60,18 +60,18 @@ npm install -g template-instructions
|
|
|
60
60
|
create-instructions my-sdlc-project
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
This will create a new folder `my-sdlc-project` containing all the instruction files and templates.
|
|
63
|
+
This will create a new folder `my-sdlc-project` containing a `.gemini/instructions` folder with all the instruction files and templates.
|
|
64
64
|
|
|
65
65
|
### Manual Setup
|
|
66
|
-
Alternatively, clone this repository and copy the
|
|
66
|
+
Alternatively, clone this repository and copy the `.gemini/instructions/` folder to your desired location.
|
|
67
67
|
|
|
68
68
|
## 🔧 Setup with Gemini
|
|
69
69
|
|
|
70
70
|
1. Copy the instruction files to your Gemini workspace:
|
|
71
71
|
```bash
|
|
72
|
-
cp -r instructions/ ~/.gemini/instructions/
|
|
72
|
+
cp -r .gemini/instructions/ ~/.gemini/instructions/
|
|
73
73
|
```
|
|
74
|
-
(Or manually copy the
|
|
74
|
+
(Or manually copy the `.gemini/instructions/` folder to `.gemini/instructions/` in your project.)
|
|
75
75
|
|
|
76
76
|
2. Ensure your Gemini configuration points to this instructions directory.
|
|
77
77
|
|
|
@@ -81,15 +81,16 @@ Alternatively, clone this repository and copy the `instructions/` folder to your
|
|
|
81
81
|
.
|
|
82
82
|
├── bin/
|
|
83
83
|
│ └── cli.js # CLI tool for scaffolding new projects
|
|
84
|
-
├──
|
|
85
|
-
│
|
|
86
|
-
│
|
|
87
|
-
│
|
|
88
|
-
│
|
|
89
|
-
│
|
|
90
|
-
│
|
|
91
|
-
│
|
|
92
|
-
│
|
|
84
|
+
├── .gemini/
|
|
85
|
+
│ └── instructions/
|
|
86
|
+
│ ├── global.md # Mandatory global rules and SDLC workflows
|
|
87
|
+
│ ├── usage.md # Detailed usage guide and examples
|
|
88
|
+
│ ├── roles/ # Role-specific instruction definitions
|
|
89
|
+
│ │ ├── pm.md, po.md, sa.md... # (PM, PO, SA, UIUX, QA, etc.)
|
|
90
|
+
│ └── templates/ # Standardized document templates
|
|
91
|
+
│ ├── Project-Plan-Template.md
|
|
92
|
+
│ ├── Product-Backlog-Template.md
|
|
93
|
+
│ └── ...
|
|
93
94
|
├── package.json # Project metadata and scripts
|
|
94
95
|
└── README.md # This file
|
|
95
96
|
```
|
|
@@ -124,8 +125,8 @@ Alternatively, clone this repository and copy the `instructions/` folder to your
|
|
|
124
125
|
|
|
125
126
|
For detailed instructions, rules, and workflows, please refer to:
|
|
126
127
|
|
|
127
|
-
* **[Usage Guide](instructions/usage.md)**: How to use the system, examples, and commands.
|
|
128
|
-
* **[Global Rules](instructions/global.md)**: The strict SDLC protocols and rules every agent follows.
|
|
128
|
+
* **[Usage Guide](.gemini/instructions/usage.md)**: How to use the system, examples, and commands.
|
|
129
|
+
* **[Global Rules](.gemini/instructions/global.md)**: The strict SDLC protocols and rules every agent follows.
|
|
129
130
|
|
|
130
131
|
---
|
|
131
132
|
*Maintained by the TeamLifecycle Project Team.*
|
package/bin/cli.js
CHANGED
|
@@ -7,12 +7,12 @@ import { fileURLToPath } from 'url';
|
|
|
7
7
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
8
8
|
const projectName = process.argv[2] || 'my-new-project';
|
|
9
9
|
const targetPath = path.join(process.cwd(), projectName);
|
|
10
|
-
const templatePath = path.join(__dirname, '
|
|
10
|
+
const templatePath = path.join(__dirname, '../.gemini/instructions'); // Folder containing your template files
|
|
11
11
|
|
|
12
12
|
async function scaffold() {
|
|
13
13
|
try {
|
|
14
14
|
console.log(`🚀 Creating project in ${targetPath}...`);
|
|
15
|
-
await fs.copy(templatePath, targetPath);
|
|
15
|
+
await fs.copy(templatePath, path.join(targetPath, '.gemini'));
|
|
16
16
|
console.log('✅ Project created successfully!');
|
|
17
17
|
} catch (err) {
|
|
18
18
|
console.error('❌ Error:', err);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "template-instructions",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"description": "Simulating a complete Software Development Lifecycle (SDLC) with specialized AI Agents.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
@@ -9,5 +9,8 @@
|
|
|
9
9
|
"scripts": {
|
|
10
10
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
11
11
|
},
|
|
12
|
+
"dependencies": {
|
|
13
|
+
"fs-extra": "^11.2.0"
|
|
14
|
+
},
|
|
12
15
|
"type": "module"
|
|
13
16
|
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/{instructions → .gemini/instructions}/templates/Design-Verification-Report-Template.md
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|