codewhale.history 2.8.1 → 2.8.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.
Files changed (2) hide show
  1. package/README.md +68 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -38,10 +38,74 @@ codewhale-tools-install -p <target-path> # specific workspace
38
38
  ```
39
39
 
40
40
  ## After install
41
- - **`//tools`** — lists every tool available in the current session
42
- - **`//history`** — lists all chat sessions for the current workspace with cost totals
43
- - **`//snapshot`** toggle pre-edit file backups (`on`, `off`, `status`)
44
- - **`//teach-me`** interactive code quiz that tests your knowledge of the current codebase
41
+
42
+ ### `//tools`
43
+ Lists every tool available in the current session, grouped by category (File I/O,
44
+ Search, Git, Sub-agents, Shell, Planning, etc.), with a brief description of what
45
+ each tool does. Read-only — no files touched.
46
+
47
+ ### `//history`
48
+ Lists all chat sessions for the current workspace. Each session row shows:
49
+
50
+ - **Date/time** — when the session was created
51
+ - **Title** — session title
52
+ - **Messages** — message count for that session
53
+ - **Tokens** — tokens consumed (with thousands separators)
54
+ - **Cost** — session cost in USD (to 4 decimal places)
55
+ - **Model** — which model was used
56
+
57
+ A **TOTAL** row at the bottom summarizes the number of sessions, total messages,
58
+ total tokens, and total cost across all sessions.
59
+
60
+ ### `//snapshot`
61
+ Toggle pre-edit file backups: `//snapshot on`, `//snapshot off`,
62
+ `//snapshot status`.
63
+
64
+ **Why you'll want this:** Snapshot is designed for folders that are **not** Git
65
+ repos — especially folders full of Office documents (`.docx`, `.pptx`, `.xlsx`,
66
+ `.pdf`) that an AI agent is about to edit. Before every file modification,
67
+ snapshot saves a timestamped copy into `_snapshots/` so you can always get back
68
+ to the pre-AI version:
69
+
70
+ ```
71
+ report.docx → _snapshots/report.2026-06-21_14-30-00.docx
72
+ ```
73
+
74
+ If the workspace already has a `.git` directory, snapshot politely declines —
75
+ Git already has your back.
76
+
77
+ ### `//teach-me`
78
+ An interactive code-teaching quiz that randomly selects real snippets from your
79
+ current project and quizzes you on what they do and how they work. Great for
80
+ onboarding to a new codebase or sharpening your language skills.
81
+
82
+ **Triggers:** `teach me` · `quiz me` · `test my knowledge` · `code quiz` ·
83
+ `drill me`
84
+
85
+ **Modifiers (combine freely):**
86
+
87
+ | Modifier | Example | What it does |
88
+ |----------|---------|-------------|
89
+ | Language | `teach me python` | Restrict to Python, TypeScript, Rust, Go, Java… |
90
+ | Level | `teach me level 3` or `teach me l3` | Set difficulty 1–5 (default: 3) |
91
+ | Scope | `teach me services/` | Narrow to a specific file or folder |
92
+ | Concept | `teach me decorators` | Target: decorators, async, generators, context managers, comprehensions, error handling, type hints, threading |
93
+
94
+ **Difficulty levels:**
95
+
96
+ | Level | Line range | What you'll face |
97
+ |-------|-----------|------------------|
98
+ | 1 | 5–15 | Straight-line logic, `if`/`else`, basic function calls |
99
+ | 2 | 8–20 | Loops, list/dict operations, simple `try`/`except` |
100
+ | 3 | 12–30 | Comprehensions, decorators, `with` statements, multiple branches |
101
+ | 4 | 18–45 | Generators, `async`/`await`, descriptors, threading, closures |
102
+ | 5 | 25–55 | Metaclasses, complex async patterns, multi-threading, architectural glue |
103
+
104
+ **Mid-round commands:** `hint` (get a nudge) · `skip` (see the answer) ·
105
+ `next` (draw a new snippet) · `level N` · `easier` · `harder` · `stop`
106
+
107
+ **At the end** you get a session summary: rounds completed, files covered, what
108
+ you're strong on, what to review, and a suggested next level.
45
109
 
46
110
  ## Requirements
47
111
  - Node.js (for the `codewhale-history` command)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "codewhale.history",
3
- "version": "2.8.1",
3
+ "version": "2.8.2",
4
4
  "description": "CodeWhale utility commands: session history, tool listing, file snapshot, interactive code quiz — global install",
5
5
  "bin": {
6
6
  "codewhale-history": "./_list_sessions.js",