codewhale.history 2.8.2 → 2.8.4

package/README.md

@@ -44,6 +44,10 @@ Lists every tool available in the current session, grouped by category (File I/O
 Search, Git, Sub-agents, Shell, Planning, etc.), with a brief description of what
 each tool does. Read-only — no files touched.
 
+**`//tools help`** or **`//tools readme`** — displays this full README inside any
+CodeWhale session, so you can always reference the command docs without leaving
+the terminal.
+
 ### `//history`
 Lists all chat sessions for the current workspace. Each session row shows:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codewhale.history",
-  "version": "2.8.2",
+  "version": "2.8.4",
   "description": "CodeWhale utility commands: session history, tool listing, file snapshot, interactive code quiz — global install",
   "bin": {
     "codewhale-history": "./_list_sessions.js",
@@ -13,6 +13,9 @@
     "instructions.md",
     "skills"
   ],
+  "scripts": {
+    "postinstall": "codewhale-tools-install"
+  },
   "engines": {
     "node": ">=14"
   }

package/skills/tools/tools-skill/SKILL.md

@@ -13,6 +13,9 @@ When the user types `//tools`, enumerate every tool available to the model in th
 3. For each tool, provide the name and a one-line description of what it does
 4. Present as a readable terminal-friendly list
 
+### `//tools help` / `//tools readme`
+When the user types `//tools help` or `//tools readme`, read and display the full tools README from `~/.codewhale/tools-readme.md`. This file is copied during install and contains detailed docs for all four commands: `//tools`, `//history`, `//snapshot`, and `//teach-me`.
+
 ## Notes
 - Read-only — no files modified or state changed
 - The tool list is dynamic per-session — do not hardcode it

package/tools-install.js

@@ -70,6 +70,17 @@ if (fs.existsSync(instructionsSource)) {
   console.log('  WARNING: instructions.md not found.');
 }
 
+// ── 2b. Copy README for //tools help ───────────────────
+const readmeSource = path.join(sourceDir, 'README.md');
+const readmeDest = path.join(os.homedir(), '.codewhale', 'tools-readme.md');
+
+if (fs.existsSync(readmeSource)) {
+  fs.copyFileSync(readmeSource, readmeDest);
+  console.log('  Copied README.md for //tools help.');
+} else {
+  console.log('  WARNING: README.md not found.');
+}
+
 // ── 3. Verify ──────────────────────────────────────────
 console.log('[3/3] Verifying installation...');
 let errors = 0;
@@ -79,7 +90,8 @@ const checklist = {
   'tools skill': path.join(skillsDest, 'tools', 'tools-skill', 'SKILL.md'),
   'snapshot skill': path.join(skillsDest, 'snapshot', 'SKILL.md'),
   'teach-me skill': path.join(skillsDest, 'teach-me', 'SKILL.md'),
-  'workspace instructions': instructionsDest
+  'workspace instructions': instructionsDest,
+  'tools readme': readmeDest
 };
 
 for (const [name, filePath] of Object.entries(checklist)) {
@@ -94,8 +106,7 @@ for (const [name, filePath] of Object.entries(checklist)) {
 console.log('');
 if (errors === 0) {
   console.log('=== Installation complete! ===');
-  console.log('Make sure codewhale-history is installed globally: npm install -g <path-to-tools_for_codewhale>');
-  console.log('Then type //tools, //history, //snapshot, or //teach-me in any CodeWhale session.');
+  console.log('Type //tools, //history, //snapshot, or //teach-me in any CodeWhale session.');
 } else {
   console.log(`=== Installation finished with ${errors} error(s). ===`);
 }