aiknowsys 0.0.1 → 0.0.2
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 -0
- package/lib/commands/init.js +12 -1
- package/lib/commands/migrate.js +14 -2
- package/lib/commands/scan.js +12 -2
- package/lib/utils.js +18 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -72,6 +72,8 @@ aiknowsys init
|
|
|
72
72
|
| `npx aiknowsys install-agents` | Install Developer + Architect agents |
|
|
73
73
|
| `npx aiknowsys install-skills` | Install universal skills |
|
|
74
74
|
|
|
75
|
+
**💡 AI-Assisted Completion:** After running any command, you'll receive a ready-to-copy prompt that you can paste to your AI assistant (Claude, GPT-4, etc.) to automatically complete the TODO sections based on your actual codebase. No more manual documentation work!
|
|
76
|
+
|
|
75
77
|
### Alternative: Manual Setup
|
|
76
78
|
|
|
77
79
|
<details>
|
package/lib/commands/init.js
CHANGED
|
@@ -4,7 +4,7 @@ import { execSync } from 'child_process';
|
|
|
4
4
|
import inquirer from 'inquirer';
|
|
5
5
|
import chalk from 'chalk';
|
|
6
6
|
import ora from 'ora';
|
|
7
|
-
import { getPackageDir, copyTemplate, hasExistingProject } from '../utils.js';
|
|
7
|
+
import { getPackageDir, copyTemplate, hasExistingProject, displayAIPrompt } from '../utils.js';
|
|
8
8
|
|
|
9
9
|
export async function init(options) {
|
|
10
10
|
const targetDir = path.resolve(options.dir);
|
|
@@ -165,6 +165,17 @@ export async function init(options) {
|
|
|
165
165
|
console.log(chalk.white(' 2. Customize validation matrix in AGENTS.md'));
|
|
166
166
|
console.log(chalk.white(' 3. Start using: @Developer <your request>'));
|
|
167
167
|
|
|
168
|
+
displayAIPrompt(chalk, [
|
|
169
|
+
'"I just initialized aiknowsys in my project. Please help me complete',
|
|
170
|
+
'the TODO sections in CODEBASE_ESSENTIALS.md and AGENTS.md based on my',
|
|
171
|
+
'codebase. Read those files, scan my project structure, and fill in:',
|
|
172
|
+
'1. Technology Snapshot - detect all frameworks/tools',
|
|
173
|
+
'2. Validation Matrix - add appropriate test/lint/build commands',
|
|
174
|
+
'3. Core Patterns - identify common patterns in my code',
|
|
175
|
+
'4. Architecture Decisions - document key choices',
|
|
176
|
+
'Make the documentation specific to MY project, not generic."'
|
|
177
|
+
]);
|
|
178
|
+
|
|
168
179
|
// OpenSpec installation
|
|
169
180
|
if (answers.useOpenSpec) {
|
|
170
181
|
console.log('');
|
package/lib/commands/migrate.js
CHANGED
|
@@ -6,7 +6,7 @@ import ora from 'ora';
|
|
|
6
6
|
import { scan } from './scan.js';
|
|
7
7
|
import { installAgents } from './install-agents.js';
|
|
8
8
|
import { installSkills } from './install-skills.js';
|
|
9
|
-
import { getPackageDir, copyTemplate } from '../utils.js';
|
|
9
|
+
import { getPackageDir, copyTemplate, displayAIPrompt } from '../utils.js';
|
|
10
10
|
|
|
11
11
|
export async function migrate(options) {
|
|
12
12
|
const targetDir = path.resolve(options.dir);
|
|
@@ -157,5 +157,17 @@ export async function migrate(options) {
|
|
|
157
157
|
console.log('');
|
|
158
158
|
console.log(chalk.cyan.bold('🚀 Start using:'));
|
|
159
159
|
console.log(chalk.white(' @Developer <your request>'));
|
|
160
|
-
|
|
160
|
+
|
|
161
|
+
displayAIPrompt(chalk, [
|
|
162
|
+
'If there are still TODO sections, copy this prompt:',
|
|
163
|
+
'',
|
|
164
|
+
'"I migrated my project to aiknowsys. Please review CODEBASE_ESSENTIALS.md',
|
|
165
|
+
'and complete any remaining TODO sections by:',
|
|
166
|
+
'1. Analyzing my actual codebase structure and patterns',
|
|
167
|
+
'2. Filling in specific validation commands (not generic examples)',
|
|
168
|
+
'3. Documenting the core patterns I actually use',
|
|
169
|
+
'4. Recording critical invariants and gotchas',
|
|
170
|
+
'5. Explaining architecture decisions',
|
|
171
|
+
'Make it project-specific, not a template!"'
|
|
172
|
+
]);
|
|
161
173
|
}
|
package/lib/commands/scan.js
CHANGED
|
@@ -2,7 +2,7 @@ import fs from 'fs';
|
|
|
2
2
|
import path from 'path';
|
|
3
3
|
import chalk from 'chalk';
|
|
4
4
|
import ora from 'ora';
|
|
5
|
-
import { getPackageDir } from '../utils.js';
|
|
5
|
+
import { getPackageDir, displayAIPrompt } from '../utils.js';
|
|
6
6
|
|
|
7
7
|
export async function scan(options) {
|
|
8
8
|
const targetDir = path.resolve(options.dir);
|
|
@@ -202,7 +202,17 @@ export async function scan(options) {
|
|
|
202
202
|
console.log(chalk.white(` 1. Review and complete TODO sections in ${outputFile}`));
|
|
203
203
|
console.log(chalk.white(` 2. Rename to CODEBASE_ESSENTIALS.md when ready`));
|
|
204
204
|
console.log(chalk.white(` 3. Run: ${chalk.cyan('npx aiknowsys install-agents')}`));
|
|
205
|
-
|
|
205
|
+
|
|
206
|
+
displayAIPrompt(chalk, [
|
|
207
|
+
'"I just ran aiknowsys scan on my project. Please help me complete',
|
|
208
|
+
`${outputFile} by:`,
|
|
209
|
+
'1. Filling in all TODO sections with accurate project details',
|
|
210
|
+
'2. Adding missing validation commands (tests, linting, type-checking)',
|
|
211
|
+
'3. Documenting core patterns you find in my codebase',
|
|
212
|
+
'4. Identifying architecture decisions and rationale',
|
|
213
|
+
'5. Once complete, rename it to CODEBASE_ESSENTIALS.md',
|
|
214
|
+
'Then run: npx aiknowsys install-agents"'
|
|
215
|
+
]);
|
|
206
216
|
|
|
207
217
|
return findings;
|
|
208
218
|
|
package/lib/utils.js
CHANGED
|
@@ -85,6 +85,24 @@ export function copyDirectory(source, dest) {
|
|
|
85
85
|
}
|
|
86
86
|
}
|
|
87
87
|
|
|
88
|
+
/**
|
|
89
|
+
* Display AI assistant completion prompt
|
|
90
|
+
* @param {Object} chalk - Chalk instance for styling
|
|
91
|
+
* @param {Array<string>} promptLines - Lines of the prompt message
|
|
92
|
+
*/
|
|
93
|
+
export function displayAIPrompt(chalk, promptLines) {
|
|
94
|
+
console.log('');
|
|
95
|
+
console.log(chalk.yellow.bold('🤖 AI Assistant Prompt:'));
|
|
96
|
+
console.log(chalk.gray(' Copy this prompt to your AI assistant to complete setup:'));
|
|
97
|
+
console.log('');
|
|
98
|
+
|
|
99
|
+
for (const line of promptLines) {
|
|
100
|
+
console.log(chalk.cyan(` ${line}`));
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
console.log('');
|
|
104
|
+
}
|
|
105
|
+
|
|
88
106
|
/**
|
|
89
107
|
* Escape special regex characters
|
|
90
108
|
*/
|