prompt-guide-cli 1.0.0

package/dist/lib/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAMzE"}

package/dist/lib/config.js

@@ -0,0 +1,11 @@
+import fs from 'node:fs';
+import path from 'node:path';
+export function setPlatformInConfig(cwd, platform) {
+    const configPath = path.join(cwd, 'ai', 'ai.config.yml');
+    if (!fs.existsSync(configPath))
+        return;
+    let content = fs.readFileSync(configPath, 'utf8');
+    content = content.replace(/^platform:\s*(null|[\w-]+)/m, `platform: ${platform}`);
+    fs.writeFileSync(configPath, content);
+}
+//# sourceMappingURL=config.js.map

package/dist/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,MAAM,UAAU,mBAAmB,CAAC,GAAW,EAAE,QAAkB;IACjE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;IACzD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;QAAE,OAAO;IACvC,IAAI,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAClD,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,6BAA6B,EAAE,aAAa,QAAQ,EAAE,CAAC,CAAC;IAClF,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC"}

package/dist/lib/copy.d.ts

@@ -0,0 +1,2 @@
+export declare function copyRecursive(src: string, dest: string): void;
+//# sourceMappingURL=copy.d.ts.map

package/dist/lib/copy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy.d.ts","sourceRoot":"","sources":["../../src/lib/copy.ts"],"names":[],"mappings":"AAGA,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAW7D"}

package/dist/lib/copy.js

@@ -0,0 +1,17 @@
+import fs from 'node:fs';
+import path from 'node:path';
+export function copyRecursive(src, dest) {
+    const stat = fs.statSync(src);
+    if (stat.isDirectory()) {
+        if (!fs.existsSync(dest))
+            fs.mkdirSync(dest, { recursive: true });
+        for (const name of fs.readdirSync(src)) {
+            copyRecursive(path.join(src, name), path.join(dest, name));
+        }
+    }
+    else {
+        fs.mkdirSync(path.dirname(dest), { recursive: true });
+        fs.copyFileSync(src, dest);
+    }
+}
+//# sourceMappingURL=copy.js.map

package/dist/lib/copy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy.js","sourceRoot":"","sources":["../../src/lib/copy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,UAAU,aAAa,CAAC,GAAW,EAAE,IAAY;IACrD,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;SAAM,CAAC;QACN,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC"}

package/dist/lib/gitignore.d.ts

@@ -0,0 +1,6 @@
+import type { Platform } from '../schemas.js';
+export declare function getGitignoreForPlatform(platform: Platform): string;
+export declare function mergeGitignore(cwd: string, platform: Platform): {
+    updated: boolean;
+};
+//# sourceMappingURL=gitignore.d.ts.map

package/dist/lib/gitignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitignore.d.ts","sourceRoot":"","sources":["../../src/lib/gitignore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAwF9C,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAElE;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAUpF"}

package/dist/lib/gitignore.js

@@ -0,0 +1,101 @@
+import fs from 'node:fs';
+import path from 'node:path';
+const MARKER = '# prompt-guide (added by prompt-guide-cli)';
+const COMMON = `# prompt-guide common
+# OS
+.DS_Store
+Thumbs.db
+# Editor / IDE
+.idea/
+*.swp
+*.swo
+*~
+# Local env / secrets
+.env
+.env.*
+!.env.example
+# Local config overrides
+ai/ai.config.local.yml
+*.local.yml
+# Logs / temp
+*.log
+tmp/
+temp/
+.cache/
+# Dependencies
+node_modules/
+`;
+const BY_PLATFORM = {
+    ios: `# prompt-guide (iOS)
+# Xcode / CocoaPods
+Pods/
+build/
+DerivedData/
+*.xcworkspace/xcuserdata/
+*.xcodeproj/xcuserdata/
+*.xcodeproj/project.xcworkspace/xcuserdata/
+Carthage/Build/
+`,
+    android: `# prompt-guide (Android)
+# Gradle / Android
+build/
+.gradle/
+local.properties
+*.iml
+.cxx/
+capture/
+`,
+    flutter: `# prompt-guide (Flutter)
+# Dart / Flutter
+.dart_tool/
+.packages
+build/
+.flutter-plugins
+.flutter-plugins-dependencies
+*.iml
+`,
+    web: `# prompt-guide (Web)
+# Build output
+dist/
+.next/
+out/
+.nuxt/
+.output/
+.vuepress/dist
+.parcel-cache/
+.vite/
+*.local
+`,
+    server: `# prompt-guide (Server)
+# Python
+venv/
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+# Go
+vendor/
+# Rust
+target/
+# Terraform
+.terraform/
+*.tfstate*
+`,
+};
+export function getGitignoreForPlatform(platform) {
+    return `${MARKER}\n${COMMON}\n${BY_PLATFORM[platform]}`;
+}
+export function mergeGitignore(cwd, platform) {
+    const gitignorePath = path.join(cwd, '.gitignore');
+    let existing = '';
+    if (fs.existsSync(gitignorePath)) {
+        existing = fs.readFileSync(gitignorePath, 'utf8');
+        if (existing.includes(MARKER))
+            return { updated: false };
+        existing = existing.trimEnd() + '\n\n';
+    }
+    fs.writeFileSync(gitignorePath, existing + getGitignoreForPlatform(platform));
+    return { updated: true };
+}
+//# sourceMappingURL=gitignore.js.map

package/dist/lib/gitignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitignore.js","sourceRoot":"","sources":["../../src/lib/gitignore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,MAAM,MAAM,GAAG,4CAA4C,CAAC;AAE5D,MAAM,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuBd,CAAC;AAEF,MAAM,WAAW,GAA6B;IAC5C,GAAG,EAAE;;;;;;;;;CASN;IACC,OAAO,EAAE;;;;;;;;CAQV;IACC,OAAO,EAAE;;;;;;;;CAQV;IACC,GAAG,EAAE;;;;;;;;;;;CAWN;IACC,MAAM,EAAE;;;;;;;;;;;;;;;CAeT;CACA,CAAC;AAEF,MAAM,UAAU,uBAAuB,CAAC,QAAkB;IACxD,OAAO,GAAG,MAAM,KAAK,MAAM,KAAK,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,QAAkB;IAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IACnD,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QACjC,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAClD,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QACzD,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC;IACzC,CAAC;IACD,EAAE,CAAC,aAAa,CAAC,aAAa,EAAE,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC"}

package/dist/lib/paths.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Directory that contains ai/, prompts/, docs/.
+ * - In repo: repo root (./ai, ./docs, ./prompts).
+ * - When published: package root has ai/, docs/, prompts/ (copied by prepublishOnly).
+ */
+export declare function getTemplatesDir(): string;
+/** CLI version from package.json. */
+export declare function getVersion(): string;
+//# sourceMappingURL=paths.d.ts.map

package/dist/lib/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/lib/paths.ts"],"names":[],"mappings":"AAYA;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAGxC;AAED,qCAAqC;AACrC,wBAAgB,UAAU,IAAI,MAAM,CAQnC"}

package/dist/lib/paths.js

@@ -0,0 +1,30 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+/** CLI package root (cli/). */
+const pkgRoot = path.join(__dirname, '..', '..');
+/** Repo root (prompt-guide/). */
+const repoRoot = path.join(pkgRoot, '..');
+/**
+ * Directory that contains ai/, prompts/, docs/.
+ * - In repo: repo root (./ai, ./docs, ./prompts).
+ * - When published: package root has ai/, docs/, prompts/ (copied by prepublishOnly).
+ */
+export function getTemplatesDir() {
+    if (fs.existsSync(path.join(pkgRoot, 'ai')))
+        return pkgRoot;
+    return repoRoot;
+}
+/** CLI version from package.json. */
+export function getVersion() {
+    const pkgPath = path.join(pkgRoot, 'package.json');
+    try {
+        const json = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+        return typeof json.version === 'string' ? json.version : '1.0.0';
+    }
+    catch {
+        return '1.0.0';
+    }
+}
+//# sourceMappingURL=paths.js.map

package/dist/lib/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/lib/paths.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE/D,+BAA+B;AAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAEjD,iCAAiC;AACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAE1C;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAAE,OAAO,OAAO,CAAC;IAC5D,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,UAAU;IACxB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACnD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QAC1D,OAAO,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IACnE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC"}

package/dist/lib/prompt.d.ts

@@ -0,0 +1,3 @@
+import { type Platform } from '../schemas.js';
+export declare function askPlatform(): Promise<Platform>;
+//# sourceMappingURL=prompt.d.ts.map

package/dist/lib/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../src/lib/prompt.ts"],"names":[],"mappings":"AAEA,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAUzD,wBAAgB,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC,CAwB/C"}

package/dist/lib/prompt.js

@@ -0,0 +1,34 @@
+import readline from 'node:readline';
+import chalk from 'chalk';
+import { PLATFORMS } from '../schemas.js';
+const BY_NUM = {
+    '1': 'ios',
+    '2': 'android',
+    '3': 'flutter',
+    '4': 'web',
+    '5': 'server',
+};
+export function askPlatform() {
+    return new Promise((resolve) => {
+        const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+        console.log(chalk.dim('\n  Platform:') +
+            ' ' +
+            chalk.cyan('1') +
+            '=ios ' +
+            chalk.cyan('2') +
+            '=android ' +
+            chalk.cyan('3') +
+            '=flutter ' +
+            chalk.cyan('4') +
+            '=web ' +
+            chalk.cyan('5') +
+            '=server');
+        rl.question(chalk.dim('  Choose (1–5 or name) ') + chalk.yellow('[1]') + chalk.dim(': '), (answer) => {
+            rl.close();
+            const trimmed = (answer || '1').trim().toLowerCase();
+            const chosen = BY_NUM[trimmed] ?? (PLATFORMS.includes(trimmed) ? trimmed : 'ios');
+            resolve(chosen);
+        });
+    });
+}
+//# sourceMappingURL=prompt.js.map

package/dist/lib/prompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../src/lib/prompt.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAiB,MAAM,eAAe,CAAC;AAEzD,MAAM,MAAM,GAA6B;IACvC,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,QAAQ;CACd,CAAC;AAEF,MAAM,UAAU,WAAW;IACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACtF,OAAO,CAAC,GAAG,CACT,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC;YACxB,GAAG;YACH,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;YACf,OAAO;YACP,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;YACf,WAAW;YACX,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;YACf,WAAW;YACX,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;YACf,OAAO;YACP,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;YACf,SAAS,CACZ,CAAC;QACF,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE;YACnG,EAAE,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACrD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAmB,CAAC,CAAC,CAAC,CAAE,OAAoB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC5G,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/schemas.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const PLATFORMS: readonly ["ios", "android", "flutter", "web", "server"];
+export declare const platformSchema: z.ZodEnum<["ios", "android", "flutter", "web", "server"]>;
+export type Platform = z.infer<typeof platformSchema>;
+export declare const initOptionsSchema: z.ZodObject<{
+    platform: z.ZodOptional<z.ZodEnum<["ios", "android", "flutter", "web", "server"]>>;
+}, "strip", z.ZodTypeAny, {
+    platform?: "ios" | "android" | "flutter" | "web" | "server" | undefined;
+}, {
+    platform?: "ios" | "android" | "flutter" | "web" | "server" | undefined;
+}>;
+export type InitOptions = z.infer<typeof initOptionsSchema>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,SAAS,yDAA0D,CAAC;AAEjF,eAAO,MAAM,cAAc,2DAIzB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,eAAO,MAAM,iBAAiB;;;;;;EAE5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/schemas.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export const PLATFORMS = ['ios', 'android', 'flutter', 'web', 'server'];
+export const platformSchema = z.enum(PLATFORMS, {
+    errorMap: () => ({
+        message: `Platform must be one of: ${PLATFORMS.join(', ')}`,
+    }),
+});
+export const initOptionsSchema = z.object({
+    platform: platformSchema.optional(),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAU,CAAC;AAEjF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE;IAC9C,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;QACf,OAAO,EAAE,4BAA4B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;KAC5D,CAAC;CACH,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC"}

package/docs/CLI.md

@@ -0,0 +1,217 @@
+# CLI usage guide
+
+The Prompt Guide CLI installs `ai/`, `prompts/`, and `docs/` in your project and configures platform-specific `.gitignore`. It also provides a `doctor` command to check that setup.
+
+---
+
+## Table of contents
+
+- [How to run](#how-to-run)
+- [Global options](#global-options)
+- [init — Initialize project](#init--initialize-project)
+- [doctor — Check and fix setup](#doctor--check-and-fix-setup)
+- [Errors and exit codes](#errors-and-exit-codes)
+
+---
+
+## How to run
+
+### 1. Global install (recommended)
+
+Install once and run from any directory:
+
+```bash
+npm install -g prompt-guide-cli
+prompt-guide              # Help and banner
+prompt-guide init         # Interactive init
+prompt-guide init -p web  # Init with web platform
+prompt-guide doctor       # Check setup
+```
+
+You do not need to add the package to your project’s `package.json`.
+
+### 2. npx (one-off)
+
+Run the latest version without a global install:
+
+```bash
+npx prompt-guide-cli init
+npx prompt-guide-cli init --platform=ios
+npx prompt-guide-cli doctor --fix
+```
+
+### 3. From this repo (development)
+
+From the **repository root**:
+
+```bash
+npm install    # Install workspace deps
+npm run build  # Build CLI (cli/)
+npm run cli    # Print help (node cli/bin/cli.js)
+npm run init   # Run init interactively
+npm run cli -- init -p web         # Init with a specific platform
+npm run cli -- init --dry-run      # Show what would be done
+npm run cli -- doctor              # Check
+npm run cli -- doctor --fix        # Fix .gitignore
+npm run cli -- doctor -v           # Verbose
+```
+
+Arguments after `--` are passed through to the CLI.
+
+---
+
+## Global options
+
+Available for every command.
+
+| Option | Description |
+|--------|-------------|
+| `-v`, `--verbose` | Extra output. For init: template path; for doctor: always show hints for failed items. |
+| `-V`, `--version` | Print CLI version. |
+| `-h`, `--help` | Print help for the command. |
+
+Example:
+
+```bash
+prompt-guide init -p flutter -v
+prompt-guide doctor -v
+prompt-guide --help
+prompt-guide init --help
+```
+
+---
+
+## init — Initialize project
+
+Installs Prompt Guide in the current directory.
+
+### Usage
+
+```bash
+prompt-guide init [options]
+```
+
+### Options
+
+| Option | Short | Description |
+|--------|-------|-------------|
+| `--platform <platform>` | `-p` | Platform. If omitted, chosen interactively (1–5 or name). |
+| `--dry-run` | — | Do not write files; only print what would be done. |
+| `-y`, `--yes` | — | Non-interactive: use default platform (web) when `--platform` is omitted. |
+
+### Supported platforms
+
+`ios` | `android` | `flutter` | `web` | `server`
+
+- **ios**: iOS (Swift/SwiftUI). Adds `ios/**`, `*.xcodeproj/**`, etc. to context and Xcode-related patterns to `.gitignore`.
+- **android**: Android (Kotlin/Java). Adds `android/**`, `app/**`, etc. and Gradle/build dirs to ignore.
+- **flutter**: Flutter (Dart). Adds `lib/**`, `test/**`, `pubspec.yaml`, etc. and Dart/Flutter build and cache to ignore.
+- **web**: Web (JS/TS, React/Vue, etc.). Adds `src/**`, `public/**`, `*.config.js`, etc. and `dist/`, `.next/`, `.vite/`, etc. to ignore.
+- **server**: Server (Node/Go/Rust/Python, etc.). Adds `src/**`, `lib/**`, `cmd/**`, etc. and `venv/`, `node_modules/`, `target/`, etc. to ignore.
+
+### What init does
+
+1. **Choose platform** — If `-p`/`--platform` is not set, prompts in the terminal (1–5 or name). With `-y`, uses default (web).
+2. **Copy directories** — Copies `ai/`, `prompts/`, `docs/` from templates into the current directory.
+3. **Update config** — Sets `platform` in `ai/ai.config.yml` to the chosen platform.
+4. **.gitignore** — Appends a prompt-guide block (common + platform-specific) to `.gitignore`, or creates it if missing.
+
+If `ai/`, `prompts/`, or `docs/` already exist, init **overwrites** them and prints a warning.
+
+### Examples
+
+```bash
+# Interactive: choose platform in terminal
+prompt-guide init
+
+# Specify platform
+prompt-guide init --platform=ios
+prompt-guide init -p web
+prompt-guide init -p server
+
+# Non-interactive (default platform: web)
+prompt-guide init -y
+
+# Show planned actions only
+prompt-guide init -p flutter --dry-run
+
+# Verbose
+prompt-guide init -p android -v
+```
+
+### Notes
+
+- **Existing `ai/`, `prompts/`, `docs/`** — Init overwrites them. Back up or copy files manually if you have local changes.
+- **Templates not found** — Reinstall the CLI or, when running from this repo, run `npm run build` and ensure `ai/`, `prompts/`, `docs/` exist under `cli/`.
+
+---
+
+## doctor — Check and fix setup
+
+Checks that the Prompt Guide layout and config are valid.  
+The `--fix` option **creates or appends** the prompt-guide block in `.gitignore` when it’s missing.
+
+### Usage
+
+```bash
+prompt-guide doctor [options]
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `--fix` | Create or append the prompt-guide block in `.gitignore` when missing. Uses `platform` from `ai/ai.config.yml` (default `web`). |
+| `--json` | Output results as JSON (for scripting). |
+
+### Checks
+
+| Check | Pass condition | On failure |
+|-------|-----------------|------------|
+| **ai/** | `ai/` exists | Run `prompt-guide init` |
+| **ai/ai.config.yml** | File exists and contains `platform:` and `context:` | Run `prompt-guide init` or add those keys |
+| **prompts/** | `prompts/` exists | Run `prompt-guide init` |
+| **docs/** | `docs/` exists | Run `prompt-guide init` |
+| **.gitignore** | File exists and contains `# prompt-guide (added by prompt-guide-cli)` | Run `prompt-guide doctor --fix` or `prompt-guide init` |
+
+### Examples
+
+```bash
+# Check only
+prompt-guide doctor
+
+# Fix .gitignore if needed
+prompt-guide doctor --fix
+
+# Verbose
+prompt-guide doctor -v
+prompt-guide doctor --fix -v
+
+# JSON output
+prompt-guide doctor --json
+```
+
+### doctor --fix behavior
+
+- **No .gitignore** — Creates a new `.gitignore` with the prompt-guide block (common + platform from config).
+- **.gitignore exists but no block** — Appends the block. If the block is already present, nothing is done.
+
+Useful when you only need to fix `.gitignore` without re-running init.
+
+---
+
+## Errors and exit codes
+
+| Situation | Exit code | Example message |
+|-----------|-----------|-----------------|
+| Success | 0 | — |
+| init failure (templates missing, invalid platform, etc.) | 1 | `✗ Templates not found. ...` / `✗ Platform must be one of: ...` |
+| doctor failed (one or more checks failed) | 1 | `✗` items printed, then “Fix the items above, or run doctor --fix ...” |
+| doctor all passed | 0 | “All checks passed.” |
+
+---
+
+## Next steps
+
+- **After install**: Edit `ai/ai.config.yml` (e.g. `model.default`, `context.include`) for your project. See the main [README Configuration Reference](../README.md#configuration-reference) and [what-install.md](what-install.md).
+- **Rule summaries**: See `docs/system.core.md`, `docs/review.md`, and `docs/rules-by-platform.md` for human-readable rule summaries.

package/docs/README.md

@@ -0,0 +1,47 @@
+# Prompt Guide — Docs index
+
+This directory contains documentation for **setup, configuration, and rules**.  
+YAML config lives in `ai/ai.config.yml`; the actual rule text used for injection is in `prompts/*.yml`.  
+Here we provide **human-readable summaries** and **CLI/feature documentation**.
+
+---
+
+## Document list
+
+| Document | Audience | Content |
+|----------|----------|---------|
+| **[CLI.md](CLI.md)** | Users, developers | How to run the CLI, `init` / `doctor` commands and options, examples, errors and exit codes. |
+| **[what-install.md](what-install.md)** | Users, maintainers | What each part (CLI, config, presets, platforms) **adds** and **what to change later**. |
+| **[request-guide.md](request-guide.md)** | Developers | **How to write request lists**: per-preset tips, guide.template fields, spec/ticket writing, examples. |
+| **[system.core.md](system.core.md)** | Developers, reviewers | Core rules summary (role, code quality, security, errors, docs, collaboration). Source: `prompts/system.core.yml`. |
+| **[review.md](review.md)** | Reviewers | Code review scope, checklist, output format, conclusion rules. Source: `prompts/review.yml`. |
+| **[rules-by-platform.md](rules-by-platform.md)** | Platform developers | Per-platform rule summaries (iOS, Android, Flutter, Web, Server). Source: `prompts/rules.by-platform.yml`. |
+
+---
+
+## Suggested reading order
+
+1. **First-time setup**  
+   [CLI.md](CLI.md) → [what-install.md](what-install.md) (sections 1, 2, 6, 7)
+
+2. **When asking the AI to do work**  
+   [request-guide.md](request-guide.md) (request principles, per-preset tips, template/spec examples)
+
+3. **Day-to-day development and review**  
+   [system.core.md](system.core.md), [review.md](review.md), [rules-by-platform.md](rules-by-platform.md)
+
+4. **Changing config or adding presets/platforms**  
+   [what-install.md](what-install.md) (sections 2–6)
+
+---
+
+## YAML source mapping
+
+| Markdown doc | YAML source | Key used by tools |
+|--------------|-------------|-------------------|
+| system.core.md | prompts/system.core.yml | `prompt` |
+| review.md | prompts/review.yml | `prompt` |
+| rules-by-platform.md | prompts/rules.by-platform.yml | `platforms.<name>.prompt` |
+
+Tools read the corresponding key from the YAML and inject it as system role / prompt.  
+The Markdown docs are **human-friendly summaries** of the same content.