openclew 0.2.1 → 0.4.0

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/LICENSE CHANGED
@@ -1,21 +1,190 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 R.AlphA
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 R.AlphA
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,7 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/openclew/openclew/main/assets/logo.png" alt="openclew" width="200">
3
+ </p>
4
+
1
5
  # openclew
2
6
 
3
7
  > Long Life Memory for LLMs
@@ -108,13 +112,38 @@ Next session, your agent reads the index, finds the doc, has the context. No re-
108
112
 
109
113
  The index auto-regenerates on every commit. Never edit it manually.
110
114
 
115
+ ### CLI commands
116
+
117
+ ```bash
118
+ openclew init # Set up openclew in your project
119
+ openclew add ref <title> # Create a refdoc (evolves with the project)
120
+ openclew add log <title> # Create a session log (frozen facts)
121
+ openclew search <query> # Search docs by keyword
122
+ openclew checkout # End-of-session summary
123
+ openclew status # Documentation health dashboard
124
+ openclew mcp # Start MCP server (stdio JSON-RPC)
125
+ ```
126
+
127
+ ### Claude Code slash commands
128
+
129
+ `openclew init` installs 4 slash commands into Claude Code:
130
+
131
+ | Command | What it does |
132
+ |---------|-------------|
133
+ | `/oc-checkout` | End-of-session summary — review actions, create log, commit |
134
+ | `/oc-search` | Search project docs by keyword |
135
+ | `/oc-init` | Set up openclew in the current project |
136
+ | `/oc-status` | Documentation health dashboard |
137
+
138
+ These work like any Claude Code slash command — type `/oc-` and pick one. No `npx` needed.
139
+
111
140
  <details>
112
141
  <summary><b>Manual setup</b> — if you prefer not to use the CLI</summary>
113
142
 
114
143
  1. Create `doc/` and `doc/log/`
115
144
  2. Copy templates from [`templates/`](templates/) (refdoc.md, log.md)
116
145
  3. Add the openclew block to your instruction file (see `doc/_USING_OPENCLEW.md` after init for the exact format)
117
- 4. Copy [`hooks/generate-index.py`](hooks/generate-index.py) and wire it as a pre-commit hook
146
+ 4. Run `openclew index` to generate `doc/_INDEX.md` (or wire it as a pre-commit hook)
118
147
 
119
148
  </details>
120
149
 
@@ -176,7 +205,15 @@ doc/
176
205
 
177
206
  **Workflow frameworks:** BMAD, Spec Kit, or any methodology — openclew handles knowledge, your framework handles process.
178
207
 
179
- **It's just Markdown.** No runtime, no dependencies, no lock-in. Git-versioned, diffable, reviewable in PRs. If you stop using it, the docs are still useful — to humans and agents alike.
208
+ **What the CLI does for you:**
209
+ - Detects your instruction file (CLAUDE.md, .cursorrules, AGENTS.md, copilot-instructions...)
210
+ - Injects a knowledge block that teaches your agent about the doc structure
211
+ - Generates and regenerates the index on every commit (pre-commit hook)
212
+ - Searches docs by keyword with weighted scoring (`openclew search`)
213
+ - Exposes docs via MCP server for tool-aware agents (`openclew mcp`)
214
+ - Produces a session summary at end of work (`openclew checkout`)
215
+
216
+ **What you get:** plain Markdown files. Git-versioned, diffable, reviewable in PRs. Zero npm dependencies — Node 16+ is all you need. No lock-in: if you stop using the CLI, the docs are still useful — to humans and agents alike.
180
217
 
181
218
  ---
182
219
 
@@ -198,4 +235,4 @@ doc/
198
235
 
199
236
  ## License
200
237
 
201
- MIT — use it however you want.
238
+ Apache 2.0 — use it however you want. Patent protection included.
package/UPGRADING.md ADDED
@@ -0,0 +1,167 @@
1
+ # Upgrading openclew
2
+
3
+ openclew evolves. When the format changes, your existing docs still work — parsers
4
+ are backward-compatible. But new features expect the current format.
5
+
6
+ `openclew migrate` bridges the gap.
7
+
8
+ ---
9
+
10
+ ## Quick version
11
+
12
+ ```bash
13
+ npm install -g openclew@latest # or: npx openclew@latest
14
+ openclew status # shows legacy doc count
15
+ openclew migrate # dry-run: what would change
16
+ openclew migrate --write # apply
17
+ git diff # review
18
+ git add doc/ && git commit -m "chore: migrate docs to openclew format"
19
+ ```
20
+
21
+ ---
22
+
23
+ ## When to upgrade
24
+
25
+ After updating openclew, run `openclew status`. If it reports legacy docs,
26
+ run `openclew migrate` to see what needs changing.
27
+
28
+ You can also check directly:
29
+
30
+ ```bash
31
+ openclew migrate
32
+ # → 12 to migrate, 45 already current, 0 errors (57 total)
33
+ ```
34
+
35
+ No output = nothing to do.
36
+
37
+ ---
38
+
39
+ ## How it works
40
+
41
+ `migrate` converts docs from older formats to the current openclew format.
42
+ It is **safe by default**:
43
+
44
+ - **Dry-run first** — shows what would change without touching files
45
+ - **`--write` to apply** — only modifies files when you explicitly ask
46
+ - **Git-friendly** — files are tracked, `git diff` shows exactly what changed
47
+ - **Idempotent** — running it twice produces the same result
48
+ - **Skips current docs** — only touches files that need updating
49
+
50
+ ### What it converts
51
+
52
+ | Before | After |
53
+ |--------|-------|
54
+ | `R.AlphA.Doc@7.0.0` (line 1) | `openclew@0.3.0 · created: ... · type: ... · ...` |
55
+ | `subject: Title` (plain L1) | `**subject:** Title` (bold L1) |
56
+ | `summary: ...` | `**doc_brief:** ...` |
57
+ | `# 📋 L1 · Métadonnées` | _(removed — metadata is on line 1)_ |
58
+ | `# 📝 L2 · Résumé` | `# L2 - Summary` |
59
+ | `# 🔧 L3 · Détails` | `# L3 - Details` |
60
+ | YAML frontmatter (`---`) | Replaced by line 1 + L1 block |
61
+ | `status: Vivant` | `status: Active` |
62
+ | `status: Terminé` | `status: Done` |
63
+
64
+ ### What it does NOT change
65
+
66
+ - **L2/L3 body content** — only headers are normalized, your content is untouched
67
+ - **Sub-headers** — `## Objective`, `## Key points` etc. are preserved as-is
68
+ - **`related_docs` paths** — kept on line 1 but not repointed if you move files
69
+ - **Files already in openclew format** — skipped entirely
70
+ - **`_INDEX.md`** — auto-generated, never touched
71
+
72
+ ---
73
+
74
+ ## Step by step
75
+
76
+ ### 1. Update openclew
77
+
78
+ ```bash
79
+ npm install -g openclew@latest
80
+ ```
81
+
82
+ ### 2. Check your docs
83
+
84
+ ```bash
85
+ openclew status
86
+ ```
87
+
88
+ Look for the "Legacy format" line. If it says 0, you're done.
89
+
90
+ ### 3. Preview changes
91
+
92
+ ```bash
93
+ openclew migrate
94
+ ```
95
+
96
+ This lists every file that would be converted. No files are modified.
97
+
98
+ ### 4. Apply
99
+
100
+ ```bash
101
+ openclew migrate --write
102
+ ```
103
+
104
+ Each converted file is printed with `✓`.
105
+
106
+ ### 5. Review and commit
107
+
108
+ ```bash
109
+ git diff # inspect the changes
110
+ openclew index # regenerate the index
111
+ git add doc/ && git commit -m "chore: migrate docs to openclew format"
112
+ ```
113
+
114
+ ### 6. Verify
115
+
116
+ ```bash
117
+ openclew status # should show 0 legacy docs
118
+ openclew migrate # should show "0 to migrate"
119
+ ```
120
+
121
+ ---
122
+
123
+ ## After migrating
124
+
125
+ - **New docs** you create with `openclew add ref` / `openclew add log` already
126
+ use the current format. No action needed.
127
+ - **Docs created by AI agents** will follow the format they see in your codebase.
128
+ Once your existing docs are migrated, agents will generate in the new format.
129
+ - **Empty `doc_brief`** — some old docs may have no brief after migration.
130
+ Run `openclew status` to find them and fill them in.
131
+
132
+ ---
133
+
134
+ ## Version-specific notes
135
+
136
+ ### → 0.4.0 (format migration)
137
+
138
+ First migration release. Converts from the legacy format (YAML frontmatter,
139
+ plain `key: value` L1, emoji headers) to the openclew format (condensed line 1,
140
+ bold L1 fields, clean headers).
141
+
142
+ **Scope**: line 1 + L1 block + L2/L3 main headers.
143
+
144
+ **Not in scope**: sub-header emojis, `related_docs` repointing, recursive
145
+ `doc/` subdirectory scanning (refdocs must be in `doc/_*.md`, not `doc/ref/`).
146
+
147
+ ---
148
+
149
+ ## Limitations
150
+
151
+ ### Flat `doc/` structure required
152
+
153
+ All openclew tools (search, index, status, migrate) scan `doc/_*.md` for refdocs
154
+ and `doc/log/*.md` for logs. Subdirectories like `doc/ref/` are not scanned yet.
155
+
156
+ If you plan to reorganize into subdirectories, wait for recursive scan support
157
+ (tracked in the openclew roadmap).
158
+
159
+ ### `related_docs` are not repointed
160
+
161
+ If a doc references `related_docs: [doc/_AUTH.md]` and you rename that file,
162
+ the reference breaks. `migrate` preserves paths as-is — manual update required.
163
+
164
+ ### Parsers are backward-compatible
165
+
166
+ Even without migrating, your docs are still readable by openclew tools.
167
+ Migration improves consistency and enables new features, but is not blocking.
package/bin/openclew.js CHANGED
@@ -9,39 +9,70 @@ const USAGE = `
9
9
  openclew — Long Life Memory for LLMs
10
10
 
11
11
  Usage:
12
- openclew init Set up openclew in the current project
13
- openclew new <title> Create a refdoc (evolves with the project)
14
- openclew log <title> Create a session log (frozen facts)
15
- openclew checkout End-of-session summary + log creation
16
- openclew index Regenerate doc/_INDEX.md
17
- openclew help Show this help
12
+ openclew init Set up openclew in your project
13
+ openclew add ref <title> Create a refdoc (evolves with the project)
14
+ openclew add log <title> Create a session log (frozen facts)
15
+ openclew search <query> Search docs by keyword
16
+ openclew peek List instruction file + all refdocs
17
+ openclew checkout End-of-session summary
18
18
 
19
- Options:
20
- --no-hook Skip pre-commit hook installation (init)
21
- --no-inject Skip instruction file injection (init)
19
+ Run 'openclew help --all' for advanced commands.
20
+ More at: https://github.com/openclew/openclew
21
+ `.trim();
22
22
 
23
- Getting started:
24
- npx openclew init 1. Set up doc/ + guide + examples + git hook
25
- # Edit doc/_ARCHITECTURE.md 2. Replace the example with your project's architecture
26
- openclew new "API design" 3. Create your own refdocs
27
- git commit 4. Index auto-regenerates on commit
23
+ const USAGE_ALL = `
24
+ openclew Long Life Memory for LLMs
28
25
 
29
- Docs have 3 levels: L1 (metadata) → L2 (summary) → L3 (details).
30
- Agents read L1 to decide what's relevant, then L2 for context.
31
- More at: https://github.com/openclew/openclew
26
+ Usage:
27
+ openclew init Set up openclew in your project
28
+ openclew add ref <title> Create a refdoc (evolves with the project)
29
+ openclew add log <title> Create a session log (frozen facts)
30
+ openclew search <query> Search docs by keyword
31
+ openclew peek List instruction file + all refdocs
32
+ openclew checkout End-of-session summary
33
+
34
+ Advanced:
35
+ openclew status Documentation health dashboard
36
+ openclew index Regenerate doc/_INDEX.md
37
+ openclew mcp Start MCP server (stdio JSON-RPC)
38
+
39
+ Options (init):
40
+ --no-hook Skip pre-commit hook installation
41
+ --no-inject Skip instruction file injection
32
42
  `.trim();
33
43
 
34
44
  if (!command || command === "help" || command === "--help" || command === "-h") {
35
- console.log(USAGE);
45
+ const showAll = args.includes("--all");
46
+ console.log(showAll ? USAGE_ALL : USAGE);
47
+ process.exit(0);
48
+ }
49
+
50
+ // Handle "add ref" / "add log" subcommands
51
+ if (command === "add") {
52
+ const sub = args[1];
53
+ if (sub === "ref") {
54
+ require("../lib/new-doc");
55
+ } else if (sub === "log") {
56
+ require("../lib/new-log");
57
+ } else {
58
+ console.error(`Unknown type: ${sub || "(none)"}`);
59
+ console.error('Usage: openclew add ref <title> or openclew add log <title>');
60
+ process.exit(1);
61
+ }
36
62
  process.exit(0);
37
63
  }
38
64
 
65
+ // Legacy aliases
39
66
  const commands = {
40
67
  init: () => require("../lib/init"),
41
68
  new: () => require("../lib/new-doc"),
42
69
  log: () => require("../lib/new-log"),
43
70
  checkout: () => require("../lib/checkout"),
71
+ search: () => require("../lib/search"),
72
+ peek: () => require("../lib/peek"),
73
+ status: () => require("../lib/status"),
44
74
  index: () => require("../lib/index-gen"),
75
+ mcp: () => require("../lib/mcp-server"),
45
76
  };
46
77
 
47
78
  if (!commands[command]) {
@@ -0,0 +1,134 @@
1
+ <!-- openclew-managed -->
2
+ # oc-checkout — End-of-session summary
3
+
4
+ Generates a structured summary of the session and persists it as a log.
5
+
6
+ **Usage:** `/oc-checkout` (no arguments, uses the current project)
7
+
8
+ ## Key principle
9
+
10
+ **Commits happen AFTER the checkout**, never during. This allows including logs created during checkout in the same commit.
11
+
12
+ ## Status emojis
13
+
14
+ | Emoji | Column | Meaning |
15
+ |-------|--------|---------|
16
+ | ✅ | Status | Done |
17
+ | 🚧 | Status | In progress / partial |
18
+ | ❌ | Status | Not done |
19
+ | 📗 | Doc | Documented (log, refdoc, or instruction file) |
20
+ | 📕 | Doc | Not documented |
21
+ | 🟢 | Commit | Already committed |
22
+ | 🟡 | Commit | To be committed |
23
+
24
+ ## Sequence
25
+
26
+ ### Phase 1: Collection (silent)
27
+
28
+ Execute silently — go straight to the Phase 2 table:
29
+ 1. Run `npx openclew checkout` to collect git activity and display the CLI summary
30
+ 2. List session actions (features, bugs, refactors...)
31
+ 3. Check which files are documented (`doc/log/*.md`, `doc/_*.md`)
32
+ 4. Check git status of each file (committed or not)
33
+
34
+ ### Phase 2: Summary table
35
+
36
+ Display the recap table for validation.
37
+
38
+ **Format:**
39
+ - Box-drawing (no Markdown pipes)
40
+ - **Isolated emojis** in dedicated mini-columns (never emoji + text in the same cell)
41
+ - Emoji columns: **5 chars wide** (`─────`) with **2 spaces after emoji** (`│ ✅ │`)
42
+ - Action column: **max 50 chars** (rephrase/abbreviate if needed, never truncate)
43
+ - No separator `├───┤` between data rows, only after the header
44
+
45
+ **Example:**
46
+ ```
47
+ ┌─────┬──────────────────────────────────────┬─────┬────────────────────────┬─────┐
48
+ │ Sta │ Action │ Doc │ File │Comm.│
49
+ ├─────┼──────────────────────────────────────┼─────┼────────────────────────┼─────┤
50
+ │ ✅ │ Feature: Auth middleware refactor │ 📗 │ 2026-01-15_auth.md │ 🟢 │
51
+ │ 🚧 │ Fix: Table alignment │ 📕 │ Not documented │ 🟡 │
52
+ └─────┴──────────────────────────────────────┴─────┴────────────────────────┴─────┘
53
+ ```
54
+
55
+ ### Phase 3: Refdocs to update?
56
+
57
+ 1. List refdocs: all `doc/_*.md` files (excluding `_INDEX.md`) + project instruction file (CLAUDE.md, AGENTS.md, etc.)
58
+ 2. Filter those related to session actions (by name only — don't read yet)
59
+ 3. For each related doc: read and assign status:
60
+ - ☑️ No update needed (verified, up to date)
61
+ - ✅ Already updated during session
62
+ - 📒 Needs update (proposed in Phase 4)
63
+ 4. **Instruction file**: always evaluated. Flag 📒 if:
64
+ - New refdoc created during session (needs reference)
65
+ - Useful info discovered (pitfall, convention, command)
66
+ - Stale context (abandoned topic, modified rule)
67
+ - File missing (needs creation)
68
+ 5. Display all related docs with status:
69
+
70
+ ```
71
+ 📚 Refdocs:
72
+ ✅ _AUTH_DESIGN.md — updated (session section)
73
+ ☑️ _ARCHITECTURE.md — verified, up to date
74
+ 📒 _INSTALL_GUIDE.md — new deploy step to document
75
+ 📒 CLAUDE.md — new pitfall discovered
76
+ ```
77
+
78
+ ### Phase 4: Proposed actions (grouped)
79
+
80
+ Display all actions together:
81
+
82
+ ```
83
+ ─── Proposed actions ───
84
+
85
+ 1. [ ] Create log for "Fix: Description" → `2026-01-15_topic.md`
86
+ 2. [ ] Update CLAUDE.md (modified context)
87
+
88
+ Approve actions? (yes/no/modify)
89
+ ```
90
+
91
+ - Wait for user validation
92
+ - If "modify": user indicates changes, adapt, re-validate
93
+ - Execute validated actions (create logs, updates)
94
+
95
+ ### Phase 5: Commits (AFTER everything else)
96
+
97
+ Execute directly after action validation:
98
+
99
+ 1. Check `git status` for all files to commit
100
+ 2. Execute commit(s)
101
+ 3. Logs created in Phase 4 are included
102
+ 4. Display result
103
+
104
+ ## Closing message
105
+
106
+ **Mandatory at the end of checkout.** Displayed after commits.
107
+
108
+ ```
109
+ ─── Summary ───
110
+ 1. Concrete fact #1 (short sentence)
111
+ 2. Concrete fact #2
112
+
113
+ ✅📗🟢 Feature: Description → file.md
114
+ 🚧📕🟡 Fix: Description → (not documented)
115
+
116
+ ─── How to test ───
117
+ • manual action or command → expected result
118
+
119
+ ─── Next steps ───
120
+ ⏭️📗 Test the new feature → CLAUDE.md TODO
121
+ ⏭️📕 Explore WebSocket option
122
+
123
+ ═══════════════════════════════════════
124
+ 🏁 Session complete
125
+ ```
126
+
127
+ **Compact format — 3 emojis concatenated:**
128
+ - Position 1: status (✅ done / 🚧 in progress / ❌ not done)
129
+ - Position 2: documentation (📗 yes / 📕 no)
130
+ - Position 3: commit (🟢 yes / 🟡 no)
131
+
132
+ **Closing rule:**
133
+ - `🏁 Session complete`: only if all actions are ✅📗🟢
134
+ - Otherwise: `⏸️ Session incomplete` and list what remains