@xelth/eck-snapshot 4.3.0 → 4.3.1
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.
Potentially problematic release.
This version of @xelth/eck-snapshot might be problematic. Click here for more details.
- package/README.md +37 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -50,11 +50,7 @@ The skeleton workflow is optimized for web-based LLMs (Gemini, ChatGPT) with lar
|
|
|
50
50
|
```
|
|
51
51
|
Copy-paste the output back to your AI chat.
|
|
52
52
|
|
|
53
|
-
3. **Incremental Updates:**
|
|
54
|
-
```bash
|
|
55
|
-
eck-snapshot update
|
|
56
|
-
```
|
|
57
|
-
This generates `.eck/snapshots/update_<timestamp>.md` containing only changed files and git diffs.
|
|
53
|
+
3. **Incremental Updates:** See the dedicated section below for details on the `update` command.
|
|
58
54
|
|
|
59
55
|
### Option 2: Full Snapshot Workflow
|
|
60
56
|
|
|
@@ -130,6 +126,42 @@ A faster, non-AI method to reduce snapshot size. This command keeps only the top
|
|
|
130
126
|
> eck-snapshot --max-lines-per-file 200
|
|
131
127
|
> ```
|
|
132
128
|
|
|
129
|
+
## Incremental Updates: The `update` Command
|
|
130
|
+
|
|
131
|
+
The `update` command is a powerful feature that creates **delta snapshots** containing only the files that changed since your last full snapshot. This is essential for maintaining AI context efficiently during active development.
|
|
132
|
+
|
|
133
|
+
### How It Works
|
|
134
|
+
|
|
135
|
+
1. **Anchor Point:** When you create a full snapshot (with `eck-snapshot` or `eck-snapshot --skeleton`), the current git commit hash is saved as an "anchor" in `.eck/.snapshot-anchor`.
|
|
136
|
+
|
|
137
|
+
2. **Change Detection:** The `update` command compares your current working directory against this anchor to identify all modified, added, or deleted files.
|
|
138
|
+
|
|
139
|
+
3. **Delta Generation:** It creates a new snapshot file containing:
|
|
140
|
+
- Only the changed files (with full content)
|
|
141
|
+
- A git diff showing all changes for context
|
|
142
|
+
- Clear instructions for the AI to merge these changes with the base snapshot
|
|
143
|
+
|
|
144
|
+
### Usage
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
eck-snapshot update
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
This generates `.eck/snapshots/update_<timestamp>.md`.
|
|
151
|
+
|
|
152
|
+
### When to Use
|
|
153
|
+
|
|
154
|
+
- **During active development:** After making changes based on AI suggestions, send an update instead of the entire codebase
|
|
155
|
+
- **Iterative workflows:** Keep the AI synchronized with your latest code without re-uploading everything
|
|
156
|
+
- **Large projects:** Especially valuable when the full snapshot is large - updates are typically much smaller
|
|
157
|
+
|
|
158
|
+
### Important Notes
|
|
159
|
+
|
|
160
|
+
- You must create a full snapshot first before using `update`
|
|
161
|
+
- Each update is self-contained - send only the latest update to the AI, not all previous updates
|
|
162
|
+
- The AI is instructed to "merge" the update over the base snapshot mentally
|
|
163
|
+
- Works with both regular and skeleton snapshots
|
|
164
|
+
|
|
133
165
|
## Auxiliary Commands
|
|
134
166
|
|
|
135
167
|
* `restore <snapshot_file>`: Recreates a project's file structure from a snapshot.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xelth/eck-snapshot",
|
|
3
|
-
"version": "4.3.
|
|
3
|
+
"version": "4.3.1",
|
|
4
4
|
"description": "A powerful CLI tool to create and restore single-file text snapshots of Git repositories and directories. Optimized for AI context and LLM workflows.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"type": "module",
|