@xelth/eck-snapshot 4.2.3 → 4.3.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/README.md +31 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -32,9 +32,33 @@ npm install -g @xelth/eck-snapshot
|
|
|
32
32
|
|
|
33
33
|
Once installed, you can run the tool using the `eck-snapshot` command from any directory.
|
|
34
34
|
|
|
35
|
-
##
|
|
35
|
+
## Workflow Options
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
### Option 1: Skeleton Workflow (Recommended for Large Projects)
|
|
38
|
+
|
|
39
|
+
The skeleton workflow is optimized for web-based LLMs (Gemini, ChatGPT) with large context windows. It uses a three-step approach:
|
|
40
|
+
|
|
41
|
+
1. **Initial Context (Maximum Compression):** Create a lightweight map of your entire project where function/method bodies are hidden, showing only signatures and structure.
|
|
42
|
+
```bash
|
|
43
|
+
eck-snapshot --skeleton
|
|
44
|
+
```
|
|
45
|
+
This generates `.eck/snapshots/<name>_sk.md` - a compressed overview that fits even large monoliths into the context window.
|
|
46
|
+
|
|
47
|
+
2. **Lazy Loading (On-Demand Details):** When the AI needs implementation details, use the `show` command to display specific files:
|
|
48
|
+
```bash
|
|
49
|
+
eck-snapshot show src/auth.js src/utils/hash.js
|
|
50
|
+
```
|
|
51
|
+
Copy-paste the output back to your AI chat.
|
|
52
|
+
|
|
53
|
+
3. **Incremental Updates:** As you make changes, send only what changed since the last snapshot instead of the entire repo:
|
|
54
|
+
```bash
|
|
55
|
+
eck-snapshot update
|
|
56
|
+
```
|
|
57
|
+
This generates `.eck/snapshots/update_<timestamp>.md` containing only changed files and git diffs.
|
|
58
|
+
|
|
59
|
+
### Option 2: Full Snapshot Workflow
|
|
60
|
+
|
|
61
|
+
Here's the traditional workflow for creating complete snapshots and focusing on specific features.
|
|
38
62
|
|
|
39
63
|
#### Step 1: Create a Full Project Snapshot
|
|
40
64
|
|
|
@@ -111,11 +135,15 @@ A faster, non-AI method to reduce snapshot size. This command keeps only the top
|
|
|
111
135
|
* `restore <snapshot_file>`: Recreates a project's file structure from a snapshot.
|
|
112
136
|
* `generate-profile-guide`: Creates a guide for manual profile creation. Use this if `profile-detect` fails on very large projects, as it allows you to use an LLM with a larger context window (e.g., a web UI).
|
|
113
137
|
* `detect`: Shows how `eckSnapshot` has identified your project type and what default file filters are being applied.
|
|
114
|
-
* `ask-
|
|
138
|
+
* `ask-claude`: Directly delegate a task to your configured Claude Code CLI agent from the command line.
|
|
115
139
|
* `setup-gemini`: A utility to automatically configure integration with the `gemini-cli`.
|
|
116
140
|
|
|
117
141
|
For a full list of commands and options, run `eck-snapshot --help`.
|
|
118
142
|
|
|
143
|
+
## Experimental Features
|
|
144
|
+
|
|
145
|
+
⚠️ **juniorArchitect**: This feature is currently under development and not yet functional. It's intended to provide automated architectural analysis and suggestions. Contributions to complete this feature are welcome!
|
|
146
|
+
|
|
119
147
|
## License
|
|
120
148
|
|
|
121
149
|
This project is licensed under the MIT License.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xelth/eck-snapshot",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.3.0",
|
|
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",
|